VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
makVrf::DtSpotReportDataProcessor Class Reference
Inheritance diagram for makVrf::DtSpotReportDataProcessor:
Inheritance graph
[legend]

Public Member Functions

void forceObjectUpdate (makVrv::DtUniqueID uniqueId)
 Force an object to be updated the next cycle.
virtual void addSpotReportHandler (const std::string &s, DtSpotReportDataHandlerCreatorInterface *)
 Once added, this class will take ownership of the memory.
virtual void removeSpotReportHandler (const std::string &s)
virtual std::string addOrUpdateSpotReport (const std::string &type, void *data, const std::string &key="")
 Creates a spot report based on the supplied type.
virtual void removeSpotReport (makVrv::DtUniqueID id)
 Removes the spot report with the given id.
virtual void removeAllSpotReports ()
 Removes all spot reports.
- Public Member Functions inherited from makVrv::DtSimDataProcessorInterface
 DtSimDataProcessorInterface ()
virtual ~DtSimDataProcessorInterface ()
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 Do nothing constructor.
virtual ~DtVirtualBaseClass ()
 Virtual do nothing destructor.

Static Public Member Functions

static DtSpotReportDataProcessorinstance (makVrv::DtDe &de)
 Returns instance of the messager.

Protected Types

typedef std::vector
< makVrv::DtUniqueID
SpotReportIdList
typedef std::map< std::string,
DtSpotReportDataHandlerCreatorInterface * > 
SpotReportHandlerCreators
typedef std::map< std::string,
DtSpotReportDataHandler * > 
SpotReportHandlers
typedef std::map
< makVrv::DtUniqueID,
DtSpotReportDataHandler * > 
SpotReportHandlersById

Protected Member Functions

virtual DtSpotReportDataHandlercreateSpotReportHandler (const std::string &s, makVrv::DtUniqueID) const
virtual std::string createSpotReport (const std::string &type, void *data, const std::string &key="")
 Adds a new spot report into the system.
virtual void processForceUpdateList ()
 Called when objects have scheduled to be forced updated from the de post tick.
virtual void slot_simObjectEntryAboutToBeRemoved (makVrv::DtSimObjectEntry &entry)
 Called when data is about to be removed, checks to see if any of the handlers want to be removed because of the data being removed.
 DtSpotReportDataProcessor (makVrv::DtDe &sim)
 CTOR.
virtual ~DtSpotReportDataProcessor ()
 DTOR.

Protected Attributes

makVrv::DtDemyDe
makVrv::DtSimEntryObjectAgent * mySimEntryAgent
makVrv::DtSignalConnectionManager myConnections
SpotReportIdList myForceUpdateList
SpotReportHandlerCreators mySpotReportHandlerCreators
SpotReportHandlers mySpotReportHandlers
SpotReportHandlersById mySpotReportHandlersById
SpotReportHandlersById myNeedsUpdateOnAdd
 If item is added, force an update.

Additional Inherited Members

- Public Attributes inherited from makVrv::DtSimDataProcessorInterface
boost::signal< void(DtUniqueID,
const
DtVrlinkSimulatedBaseState &) > 
signal_stateAdded
boost::signal< void(DtUniqueID,
const
DtVrlinkSimulatedBaseState &) > 
signal_stateUpdated
boost::signal< void(DtUniqueID) > signal_stateRemoved

Member Typedef Documentation

Constructor & Destructor Documentation

makVrf::DtSpotReportDataProcessor::DtSpotReportDataProcessor ( makVrv::DtDe sim)
protected

CTOR.

virtual makVrf::DtSpotReportDataProcessor::~DtSpotReportDataProcessor ( )
protectedvirtual

DTOR.

Member Function Documentation

static DtSpotReportDataProcessor& makVrf::DtSpotReportDataProcessor::instance ( makVrv::DtDe de)
static

Returns instance of the messager.

void makVrf::DtSpotReportDataProcessor::forceObjectUpdate ( makVrv::DtUniqueID  uniqueId)
virtual

Force an object to be updated the next cycle.

Implements makVrv::DtSimDataProcessorInterface.

virtual void makVrf::DtSpotReportDataProcessor::addSpotReportHandler ( const std::string &  s,
DtSpotReportDataHandlerCreatorInterface  
)
virtual

Once added, this class will take ownership of the memory.

If an existing handler is there for the supplied string, it will be replaced

virtual void makVrf::DtSpotReportDataProcessor::removeSpotReportHandler ( const std::string &  s)
virtual
virtual std::string makVrf::DtSpotReportDataProcessor::addOrUpdateSpotReport ( const std::string &  type,
void *  data,
const std::string &  key = "" 
)
virtual

Creates a spot report based on the supplied type.

If there is no spot report handler for the type, then the spot report will not be added to the system. If it does and there is not a key supplied, a new key will be generated and returned from this method. If a spot report is found with the given key, it will be asked to update itself given the supplied data pointer, else a new data representation will be added

virtual void makVrf::DtSpotReportDataProcessor::removeSpotReport ( makVrv::DtUniqueID  id)
virtual

Removes the spot report with the given id.

virtual void makVrf::DtSpotReportDataProcessor::removeAllSpotReports ( )
virtual

Removes all spot reports.

virtual DtSpotReportDataHandler* makVrf::DtSpotReportDataProcessor::createSpotReportHandler ( const std::string &  s,
makVrv::DtUniqueID   
) const
protectedvirtual
virtual std::string makVrf::DtSpotReportDataProcessor::createSpotReport ( const std::string &  type,
void *  data,
const std::string &  key = "" 
)
protectedvirtual

Adds a new spot report into the system.

If key is NULL, will generate a new key based on the unique id

virtual void makVrf::DtSpotReportDataProcessor::processForceUpdateList ( )
protectedvirtual

Called when objects have scheduled to be forced updated from the de post tick.

virtual void makVrf::DtSpotReportDataProcessor::slot_simObjectEntryAboutToBeRemoved ( makVrv::DtSimObjectEntry entry)
protectedvirtual

Called when data is about to be removed, checks to see if any of the handlers want to be removed because of the data being removed.

Member Data Documentation

makVrv::DtDe& makVrf::DtSpotReportDataProcessor::myDe
protected
makVrv::DtSimEntryObjectAgent* makVrf::DtSpotReportDataProcessor::mySimEntryAgent
protected
makVrv::DtSignalConnectionManager makVrf::DtSpotReportDataProcessor::myConnections
protected
SpotReportIdList makVrf::DtSpotReportDataProcessor::myForceUpdateList
protected
SpotReportHandlerCreators makVrf::DtSpotReportDataProcessor::mySpotReportHandlerCreators
protected
SpotReportHandlers makVrf::DtSpotReportDataProcessor::mySpotReportHandlers
protected
SpotReportHandlersById makVrf::DtSpotReportDataProcessor::mySpotReportHandlersById
protected
SpotReportHandlersById makVrf::DtSpotReportDataProcessor::myNeedsUpdateOnAdd
protected

If item is added, force an update.


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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)