SubsystemFrameBuffer.h

Go to the documentation of this file.

#ifndef CARMA_MONITOR_SUBSYSTEMFRAME_BUFFER_H
#define CARMA_MONITOR_SUBSYSTEMFRAME_BUFFER_H

#include <memory>

#include "carma/monitor/SubsystemFrame.h"

namespace carma  {
namespace monitor  {

class MonitorPointSample;


typedef enum {  
    MONITOR_NOT_WRITTEN = -1, 
    MONITOR_WRITTEN_ONCE = 0, 
    MONITOR_WRITTEN_AGAIN = 1  
} WriteStatus;


class SubsystemFrameBuffer : public SubsystemFrame {
  public:

    static const int kDefaultQueueDepth;
    
    ~SubsystemFrameBuffer() ;

    void write (bool force = false) ;  // update to shared memeory

    unsigned int read( );
    bool readNewest( );
    bool readNewestConditionalCopy();

    static SubsystemFrameBuffer &
    getSubsystemFrameBuffer( long subsystemID,
                             long maxMonitorPoints,
                             long maxSamples );

    virtual WriteStatus writeSampleValue 
                (const tagIDType tagID, const MonitorPointSample& value);

    virtual WriteStatus writeSampleValue 
                (const int index, const MonitorPointSample& value);

    bool        isDirty () const  ;

    bool        isComplete () const  ;

  private:
    // No copying
    SubsystemFrameBuffer( const SubsystemFrameBuffer & rhs );
    SubsystemFrameBuffer & operator=( const SubsystemFrameBuffer & rhs );

    void clearFrame( );

    void decrementCleanSamples( );

    SubsystemFrameBuffer(
        ushort                subsystemID,
        const ::std::string & fname, 
        long                  maxMonitorPoints,
        long                  maxSamples,
        bool                  isCreator,
        int                   queueDepth );

    class InternalIpq;
    
    ::std::auto_ptr< InternalIpq > ipq_;
    bool                           isDirty_;
    int                            numCleanSamples_;
};


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


#endif