SystemFrameBuffer.h

Go to the documentation of this file.

#ifndef CARMA_MONITOR_SYSTEMFRAME_BUFFER_H
#define CARMA_MONITOR_SYSTEMFRAME_BUFFER_H

#include <memory>

#include "carma/monitor/SystemFrame.h"
// To get the default queueDepth...
#include "carma/monitor/SubsystemFrameBuffer.h"

namespace carma  {
namespace monitor  {


class MonitorPointSet;


class SystemFrameBuffer : public SystemFrame {
  public:
    void  write () ;  // update to shared memeory

    unsigned int read( );
    bool readNewest( );
    bool readNewestIfStale( );
    bool readNewestConditionalCopy();
    
    MonitorPointSet&        getMonitorPointSet (ushort subsystemID,
                                                int numMonitorPoints = 0,
                                                int numSamples = 0);

    static SystemFrameBuffer &
    getSystemFrameBuffer( 
            const ::std::string& name = "Carma",
            long        maxSubsystems = 0,
            long     maxMonitorPoints = 0,
            long           maxSamples = 0,
            int        queueDepth = SubsystemFrameBuffer::kDefaultQueueDepth);

    virtual ~SystemFrameBuffer ();

    void setNoneAvailable();

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

    SystemFrameBuffer( const ::std::string & fname,
                       long                  maxSubsystems,
                       long                  maxMonitorPoints,
                       long                  maxSamples,
                       bool                  isCreator,
                       int                   queueDepth );

    class InternalIpq;
    
    ::std::auto_ptr< InternalIpq > ipq_;
};


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


#endif