makVrf::DtFrameStateInterface Class Reference

This is a simple base class that will be used to return a pointer to current or next frame state. Each double buffered class will return two versions of this. The first version will be a const read only version that references only the currentFrameState. The second will return the nextFrameState which can be written to.

Inheritance diagram for makVrf::DtFrameStateInterface:

Public Member Functions
	DtFrameStateInterface (DtStateData *)
virtual	~DtFrameStateInterface ()
void	setIsWritable (bool b)
bool	isWritable () const
UInt64	stateId () const
UInt64	legionGlobalId () const
void	setLegionGlobalId (UInt64 d)
virtual bool	isModified () const
virtual void	clearModified ()
virtual void	markModified ()
virtual DtStateComponent::StateComponentType	type () const
virtual DtStateComponent::StateComponentType	componentType () const =0
virtual const char *	stringType () const =0
void	setId (UInt64 id)
virtual UInt64	id () const
virtual void	updateStateData (DtStateData *sd)
virtual Legion::ReadStateInstance	readStateInstance () const
virtual Legion::WriteStateInstance	writeStateInstance ()
void	emitComponentUpdated ()
bool	cleared () const
bool	advancedFrame () const
virtual void	frameAdvanced ()
virtual void	convertToRemote ()
virtual void	convertToLocal ()
virtual void	aboutToBeDeleted ()

Public Attributes
boost::signals2::signal< void(DtFrameStateInterface *)>	signal_stateComponentAboutToBeDeleted
boost::signals2::signal< void(const DtFrameStateInterface *)>	signal_componentModified

Protected Member Functions
virtual void	makeWritable ()
virtual void	makeReadOnly ()

Protected Attributes
bool	myIsModified
UInt64	myId
UInt64	myStateId
UInt64	myLegionId
bool	myIsWritable
bool	myCleared
bool	myAdvancedFrame
DtStateData *	myStateData

Private Member Functions
	DtFrameStateInterface (const DtFrameStateInterface &orig)
DtFrameStateInterface &	operator= (const DtFrameStateInterface &rhs)

Constructor & Destructor Documentation

makVrf::DtFrameStateInterface::DtFrameStateInterface ( const DtFrameStateInterface &  orig )

private

makVrf::DtFrameStateInterface::DtFrameStateInterface

(

DtStateData *

)

virtual makVrf::DtFrameStateInterface::~DtFrameStateInterface ( )

virtual

Member Function Documentation

DtFrameStateInterface& makVrf::DtFrameStateInterface::operator= ( const DtFrameStateInterface &  rhs )

private

void makVrf::DtFrameStateInterface::setIsWritable ( bool  b )

inline

bool makVrf::DtFrameStateInterface::isWritable ( ) const

inline

UInt64 makVrf::DtFrameStateInterface::stateId ( ) const

inline

UInt64 makVrf::DtFrameStateInterface::legionGlobalId ( ) const

inline

void makVrf::DtFrameStateInterface::setLegionGlobalId ( UInt64  d )

inline

virtual bool makVrf::DtFrameStateInterface::isModified ( ) const

inlinevirtual

Reimplemented in makVrf::DtStatePropertiesStateComponentNextFrame.

virtual void makVrf::DtFrameStateInterface::clearModified ( )

inlinevirtual

Reimplemented in makVrf::DtArticulatedPartStateComponentCurrentFrame, and makVrf::DtArticulatedPartStateComponentNextFrame.

Referenced by makVrf::DtDoubleBufferedStateComponent< DtStaticLocationStateComponent >::advanceFrame().

virtual void makVrf::DtFrameStateInterface::markModified ( )

virtual

Referenced by makVrf::DtDoubleBufferedStateComponent< DtStaticLocationStateComponent >::advanceFrame().

virtual DtStateComponent::StateComponentType makVrf::DtFrameStateInterface::type ( void  ) const

inlinevirtual

virtual DtStateComponent::StateComponentType makVrf::DtFrameStateInterface::componentType ( ) const

pure virtual

Implemented in makVrf::DtStateDataSimulatedObjectStateComponent.

virtual const char* makVrf::DtFrameStateInterface::stringType ( ) const

pure virtual

Implemented in makVrf::DtStateDataSimulatedObjectStateComponent.

void makVrf::DtFrameStateInterface::setId ( UInt64  id )

inline

Referenced by makVrf::DtDoubleBufferedStateComponent< DtStaticLocationStateComponent >::setId().

virtual UInt64 makVrf::DtFrameStateInterface::id ( ) const

inlinevirtual

virtual void makVrf::DtFrameStateInterface::updateStateData ( DtStateData *  sd )

virtual

Reimplemented in makVrf::DtRadioTransmitterStateComponentCurrentFrame, makVrf::DtRadioTransmitterStateComponentNextFrame, makVrf::DtRadioReceiverStateComponentCurrentFrame, makVrf::DtRadioReceiverStateComponentNextFrame, makVrf::DtNavAidRadioTransmitterStateComponentCurrentFrame, and makVrf::DtNavAidRadioTransmitterStateComponentNextFrame.

virtual Legion::ReadStateInstance makVrf::DtFrameStateInterface::readStateInstance ( ) const

inlinevirtual

If supported, the read or write state legion instance of this component.

Reimplemented in makVrf::DtRadioTransmitterStateComponentCurrentFrame.

virtual Legion::WriteStateInstance makVrf::DtFrameStateInterface::writeStateInstance ( )

inlinevirtual

Reimplemented in makVrf::DtRadioTransmitterStateComponentNextFrame, makVrf::DtRadioReceiverStateComponentNextFrame, and makVrf::DtSensorFieldOfViewStateComponentNextFrame.

void makVrf::DtFrameStateInterface::emitComponentUpdated ( )

inline

bool makVrf::DtFrameStateInterface::cleared ( ) const

inline

bool makVrf::DtFrameStateInterface::advancedFrame ( ) const

inline

virtual void makVrf::DtFrameStateInterface::frameAdvanced ( )

inlinevirtual

Referenced by makVrf::DtDoubleBufferedStateComponent< DtStaticLocationStateComponent >::advanceFrame().

virtual void makVrf::DtFrameStateInterface::convertToRemote ( )

virtual

Change the object from remote (not-writable)

virtual void makVrf::DtFrameStateInterface::convertToLocal ( )

virtual

Change to local.

virtual void makVrf::DtFrameStateInterface::aboutToBeDeleted ( )

virtual

virtual void makVrf::DtFrameStateInterface::makeWritable ( )

inlineprotectedvirtual

Override to make component writable.

Reimplemented in makVrf::DtEmitterSystemStateComponentNextFrame, makVrf::DtTaskVisualizationStateComponentNextFrame, makVrf::DtActiveSonarStateComponentNextFrame, makVrf::DtSpotReportStateComponentNextFrame, makVrf::DtWeatherStateComponentNextFrame, makVrf::DtRadioTransmitterStateComponentNextFrame, makVrf::DtEntityLocationStateComponentNextFrame, makVrf::DtAircraftLightingStateComponentNextFrame, makVrf::DtEnvironmentalStateComponentNextFrame, makVrf::DtVrfGeometryStateComponentNextFrame, makVrf::DtEntityStateComponentNextFrameTemplate< DtEntityStateComponent >, makVrf::DtEntityStateComponentNextFrameTemplate< DtAggregateStateComponent >, makVrf::DtVrfStateComponentNextFrame, makVrf::DtTimeAndDateStateComponentNextFrame, makVrf::DtSubordinateManagerStateComponentNextFrame, makVrf::DtUnderwaterAcousticsStateComponentNextFrame, makVrf::DtOrbatStateComponentNextFrame, makVrf::DtLaserDesignatorStateComponentNextFrame, makVrf::DtStatePropertiesStateComponentNextFrame, makVrf::DtIffStateComponentNextFrame, makVrf::DtEnvironmentalLocationStateComponentNextFrame, makVrf::DtArticulatedPartStateComponentNextFrame, makVrf::DtAisDataStateComponentNextFrame, makVrf::DtSensorFieldOfViewStateComponentNextFrame, makVrf::DtRadioReceiverStateComponentNextFrame, makVrf::DtWindCorridorStateComponentNextFrame, makVrf::DtHumanStateComponentNextFrame, makVrf::DtTacticalSmokeStateComponentNextFrame, makVrf::DtRangeItemsStateComponentNextFrame, makVrf::DtDynamicTerrainStateComponentNextFrame, makVrf::DtStaticLocationStateComponentNextFrame, makVrf::DtGroundVehicleLightingStateComponentNextFrame, makVrf::DtInternalTemperatureStateComponentNextFrame, makVrf::DtAirTurbulenceStateComponentNextFrame, and makVrf::DtNavAidRadioTransmitterStateComponentNextFrame.

virtual void makVrf::DtFrameStateInterface::makeReadOnly ( )

inlineprotectedvirtual

Override to make component read-only.

Reimplemented in makVrf::DtEmitterSystemStateComponentNextFrame, makVrf::DtTaskVisualizationStateComponentNextFrame, makVrf::DtActiveSonarStateComponentNextFrame, makVrf::DtSpotReportStateComponentNextFrame, makVrf::DtWeatherStateComponentNextFrame, makVrf::DtRadioTransmitterStateComponentNextFrame, makVrf::DtEntityLocationStateComponentNextFrame, makVrf::DtAircraftLightingStateComponentNextFrame, makVrf::DtEnvironmentalStateComponentNextFrame, makVrf::DtVrfGeometryStateComponentNextFrame, makVrf::DtEntityStateComponentNextFrameTemplate< DtEntityStateComponent >, makVrf::DtEntityStateComponentNextFrameTemplate< DtAggregateStateComponent >, makVrf::DtVrfStateComponentNextFrame, makVrf::DtTimeAndDateStateComponentNextFrame, makVrf::DtSubordinateManagerStateComponentNextFrame, makVrf::DtUnderwaterAcousticsStateComponentNextFrame, makVrf::DtOrbatStateComponentNextFrame, makVrf::DtLaserDesignatorStateComponentNextFrame, makVrf::DtStatePropertiesStateComponentNextFrame, makVrf::DtIffStateComponentNextFrame, makVrf::DtEnvironmentalLocationStateComponentNextFrame, makVrf::DtArticulatedPartStateComponentNextFrame, makVrf::DtSensorFieldOfViewStateComponentNextFrame, makVrf::DtAisDataStateComponentNextFrame, makVrf::DtRadioReceiverStateComponentNextFrame, makVrf::DtWindCorridorStateComponentNextFrame, makVrf::DtHumanStateComponentNextFrame, makVrf::DtTacticalSmokeStateComponentNextFrame, makVrf::DtRangeItemsStateComponentNextFrame, makVrf::DtDynamicTerrainStateComponentNextFrame, makVrf::DtStaticLocationStateComponentNextFrame, makVrf::DtGroundVehicleLightingStateComponentNextFrame, makVrf::DtInternalTemperatureStateComponentNextFrame, makVrf::DtAirTurbulenceStateComponentNextFrame, and makVrf::DtNavAidRadioTransmitterStateComponentNextFrame.

Member Data Documentation

boost::signals2::signal<void (DtFrameStateInterface*)> makVrf::DtFrameStateInterface::signal_stateComponentAboutToBeDeleted

mutable

boost::signals2::signal<void (const DtFrameStateInterface*)> makVrf::DtFrameStateInterface::signal_componentModified

mutable

bool makVrf::DtFrameStateInterface::myIsModified

protected

UInt64 makVrf::DtFrameStateInterface::myId

protected

UInt64 makVrf::DtFrameStateInterface::myStateId

protected

UInt64 makVrf::DtFrameStateInterface::myLegionId

protected

bool makVrf::DtFrameStateInterface::myIsWritable

protected

bool makVrf::DtFrameStateInterface::myCleared

protected

bool makVrf::DtFrameStateInterface::myAdvancedFrame

protected

DtStateData* makVrf::DtFrameStateInterface::myStateData

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfStateData/stateComponent.h