CARMA C++
carma::monitor::MonitorPointUpdateServant Class Reference

class that represents the scriber part of the frameScriberPublisher. More...

#include <carma/monitor/MonitorPointUpdateServant.h>

Public Member Functions

virtual CORBA::Double monitorPointSampleUpdate (const MonitorSampleValues &values, CORBA::Long frameTime, CORBA::Double writeDelay)
 DO method to write modified monitor points. More...
 
 MonitorPointUpdateServant (SubsystemFrameBuffer &buffer, boost::mutex &bufferWriteMutex)
 Constructor. More...
 
virtual ~MonitorPointUpdateServant ()
 Destructor Stops thread and deactivates root POA. More...
 

Static Public Member Functions

static std::string makeName (ushort subsystemID)
 Static method that returns DO name based on associated subsystemID. More...
 

Detailed Description

class that represents the scriber part of the frameScriberPublisher.

Collects the data that the scriber will write to local IPQ.

Definition at line 21 of file MonitorPointUpdateServant.h.

Constructor & Destructor Documentation

carma::monitor::MonitorPointUpdateServant::MonitorPointUpdateServant ( SubsystemFrameBuffer buffer,
boost::mutex &  bufferWriteMutex 
)
explicit

Constructor.

Parameters
bufferSubsystemFrameBuffer& reference to a subsystem frame buffer (IPQ) associated with this monitor subsystem.
bufferWriteGuardMutex to synchronize thread writes to buffer.
virtual carma::monitor::MonitorPointUpdateServant::~MonitorPointUpdateServant ( )
virtual

Destructor Stops thread and deactivates root POA.

Member Function Documentation

static std::string carma::monitor::MonitorPointUpdateServant::makeName ( ushort  subsystemID)
static

Static method that returns DO name based on associated subsystemID.

Parameters
subsystemIDunsigned short, represents ID of associated monitor subsystem.
Returns
std::string name of DO associated with DO reference in CORBA NameService.
virtual CORBA::Double carma::monitor::MonitorPointUpdateServant::monitorPointSampleUpdate ( const MonitorSampleValues &  values,
CORBA::Long  frameTime,
CORBA::Double  writeDelay 
)
virtual

DO method to write modified monitor points.

Used by host programs in associated monitor subsystem.

Parameters
dataSeqMontitorSampleValueSeq& reference to sequence of transported monitor point samples containg modified values.
frameTimeCORBA::Long frameCount (timestamp) associated with sequence of modified values.
writeDelayCORBA::Double delay of auto writer thread writing to this DO represented in seconds as seconds after half-second tick.
Returns
CORBA::Double returns time that method received dataSeq as an MJD.

The documentation for this class was generated from the following file: