MonitorComponent.h

Go to the documentation of this file.

#ifndef CARMA_MONITOR_MONITORCOMPONENT_H
#define CARMA_MONITOR_MONITORCOMPONENT_H


#include <string>
#include <vector>

namespace carma {
    namespace monitor {

class MonitorComponent {
public:

    enum ARCHIVE_PRIORITY {
        VITAL,

        USEFUL,

        NORMAL,

        DEBUG,

        VERBOSE,

        DEFAULT,

        DONTARCHIVE
    };

    explicit MonitorComponent(const std::string& name);

    virtual ~MonitorComponent() ;
   
    virtual const std::string& getName() const ;

    void setName(const std::string& name);

    const std::string& getCanonicalName() const ;
    
    virtual void setCanonicalName( const std::string & parents );

    virtual const std::string& getShortName() const ;

     void setShortName(const std::string& name);

     void setShortName(const std::string& name, int index);

    virtual const std::string& getLongName() const ;

     void setLongName(const std::string& name);

    virtual const std::string& getDescription() const ;

    void setDescription(const std::string& text);
    
    virtual void setNoData() const = 0;

    virtual bool hasAllData() const = 0;
  
 
    virtual bool isSubsystem() const;

    virtual std::string transportStatisticsToString(bool canonical = false) const; 

    virtual ::std::string hierarchyToString(
        bool canonical = false,
        bool verbose = false,
        bool value = true,
        int  sampleIndex = 0,
        int  indent = 0,
        int  levels = -1 ) const = 0;

    virtual void hierarchyToVector(
        ::std::vector< ::std::string > & hierarchyList,
        bool                             canonical = false,
        bool                             verbose = false,
        int                              sampleIndex = 0 ) const = 0;

    virtual ::std::string hierarchyToStringAverage(
        bool canonical = false,
        bool verbose = false,
        bool value = true, 
        int  indent = 0,
        int  levels = -1 ) const = 0;

    virtual std::string leafToString( bool verbose = false,
                                      bool value = true,
                                      int sampleIndex = 0 ) const = 0;

    virtual std::string toString(bool canonicalName = false,  
        bool verbose = false, bool value = true, 
        int sampleIndex = 0, int indent = 0) const = 0;
        
    virtual std::string toStringAverage(bool canonicalName = false,  
        bool verbose = false, bool value = true, 
        int indent = 0) const = 0;
        
    virtual ::std::string monitorPointTags( bool untagged = false ) const = 0;
    
    virtual std::string getPhysicalDeviceName() const ;

    std::string getPhysicalDeviceString() const ;

    std::string getPhysicalName() const ;

    static std::string convertAllLower(std::string name) ;

    virtual void setPersistent(bool persistent) = 0;

    virtual bool isMonitorPoint() const;

    static std::string archivePriorityToString(
        MonitorComponent::ARCHIVE_PRIORITY priority);

    virtual bool operator==(const MonitorComponent& component) const = 0;

    bool operator!=(const MonitorComponent& component) const ;

private:
    // No copying
    MonitorComponent & operator=( const MonitorComponent & rhs );
    MonitorComponent( const MonitorComponent & rhs );
    
    MonitorComponent( );  // Default constructor is private!!
    
protected:    
    bool debug_;

private:
    std::string name_;
    std::string canonicalName_;
    std::string shortName_;
    std::string longName_;
    std::string description_;
};


std::ostream& operator<<(std::ostream &os, const MonitorComponent& component);


}  // namespace carma::monitor
}  // namespace carma


inline const ::std::string &
carma::monitor::MonitorComponent::getCanonicalName( ) const
{
    return canonicalName_ ;
}


#endif