MonitorSubsystem.h

Go to the documentation of this file.

#ifndef CARMA_MONITOR_MONITORSUBSYSTEM_H 
#define CARMA_MONITOR_MONITORSUBSYSTEM_H

#include <string>

#include "carma/monitor/MonitorSystemContainer.h"

namespace carma {

namespace dbms {
    class TagIDAuthority;
}

namespace monitor {


class MonitorPointSet;
class SystemFrameBuffer;


class MonitorSubsystem : public MonitorSystemContainer {
public:

    MonitorSubsystem( const std::string & subsystemName, 
                      SystemFrameBuffer * buffer = 0,
                      int                 maxMonitorPoints = 600,
                      int                 maxSamples = 1800,
                      ARCHIVE_PRIORITY    archivePriority = NORMAL,
                      bool                onlyDEFAULT = true );

    virtual ~MonitorSubsystem( );
        
    bool configure();

    virtual void createHierarchy() = 0;
    
    MonitorPointSet & getMonitorPointSet();



    void resetValidity();

    void updateFrameAverage();

    double getFrameTime() const;
    
    double getPublishTime() const;

    double getReceiveTime() const;

    double getStartWriteTime() const ;
 
    double getEndWriteTime() const ;
 
    double getStartScriberWriteTime() const ;
 
    
    double getLastWriterDelay () const ;
 
    double getLastWriteTime () const ;
 
    double getScriberWriteDelay() const;
 
    double getScriberWriteTime() const;
 
    void   resetTimes () ;
    
    void startAutoWriter (double delay) const;

    void stopAutoWriter() const ;

    bool autoWriterIsAlive() const ;

    
    static std::string makeName(const std::string& name, int number);

    int maxMonitorPoints() const ;
    
    int maxSamples() const ;
    
    // virtual, so docs have already been done...
    bool isSubsystem() const;
    
    MonitorPointSet & monitorPointSet();

    static std::string transportHeaderToString () ;

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

    bool isCurrent () const;

           
    bool isCurrent (long frameCount) const;

    /*
     * Overridden methods of abstract MonitorSystemContainer methods.
     * Documentation supplied by base class.
     */
    unsigned int read();
    bool readNewest();
    bool readNewestConditionalCopy();
    void write( );
    void writeWithoutResettingValidities();
    int getFrameCount() const;

           
private:
    void setIdentity();
    
    void setMpTagIds( carma::dbms::TagIDAuthority & authority );

    void allocateAllMonitorPoints( );
    
    MonitorPointSet & monitorPointSet_;
    const int         maxMonitorPoints_;
    const int         maxSamples_;
    ARCHIVE_PRIORITY  archivePriority_;
    bool              onlyDEFAULT_;
};


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


#endif