DtReflectedObject Class Reference

class DtReflectedObject: More...

Inheritance diagram for DtReflectedObject:

Collaboration diagram for DtReflectedObject:

Public Types
typedef DtStateRepository *(*	DtBaseStateRepCreator )()
	Function prototype for functions that create DtStateRepositories. More...

Public Member Functions
	DtReflectedObject (DtExerciseConn *conn, DtStateRepository *stateRep)
	Primary constructor. More...
	DtReflectedObject (DtHlaObject *obj, DtExerciseConn *conn, DtBaseStateRepCreator creator)
	Older constructor. More...
	DtReflectedObject (const DtObjectId &id, const DtGlobalObjectDesignator &des, DtExerciseConn *conn, DtBaseStateRepCreator creator)
	Older constructor. More...
virtual	~DtReflectedObject ()
	destructor More...
virtual DtStateRepository *	stateRep () const
	Returns a pointer to the StateRepository - through which you can inspect current state information. More...
virtual DtStateRepository *	sr () const
	Synonym for stateRep(). More...
virtual DtHlaStateDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode state messages into our SR. More...
virtual DtHlaObjectWithStateRep *	hlaObject () const
	Get the entity's hlaObject (DtHlaObjectWithStateRep is derived from DtHlaObject). More...
virtual const DtObjectId &	objectId () const
	Get the HLA object's id. More...
virtual const DtObjectId &	id () const
	Get the HLA object's id (local ID). More...
virtual const DtObjectId &	localId () const
	Get the HLA object's id (local ID). More...
virtual const DtString &	name () const
	Get the HLA object name. More...
virtual const DtGlobalObjectDesignator &	globalId () const
	Get the HLA object's global object designator - the object name in HLA. More...
virtual const DtString &	lastProducingFederate () const
	Get the name of the last federate that produced a reflected update. More...
virtual DtTime	lastSimTimeUpdated () const
	Returns the value of simulation time at the time an update was last received for the entity. More...
virtual DtTime	lastReceivedTimeStamp () const
	Returns the value of the time send in the last Update received for this entity. More...
virtual void	baseAddPostUpdateCallback (DtReflectedObjectCallbackFunction cb, void *userData)
	Object state callback registration/deregistration. More...
virtual void	baseRemovePostUpdateCallback (DtReflectedObjectCallbackFunction cb, void *userData)
virtual DtReflectedObject *	nextObj () const
	Get the next remote object. More...
virtual DtReflectedObject *	prevObj () const
	Get the previous remote object. More...
virtual DtReflectedObject *	wrapNextObj () const
	Get the next remote object. More...
virtual DtReflectedObject *	wrapPrevObj () const
	Get the previous remote object. More...
void	setHlaObject (DtHlaObject *obj, DtHlaStateDecoder *decoder=NULL)
	Start reflecting this object, using this decoder. More...
virtual void	setNoHlaObject (const DtObjectId &id, const DtGlobalObjectDesignator &des)
	Used to set up a proxy DtReflectedEntity - one that is not actually managing a real reflected HLA object. More...
void	detachHlaObject ()
	Ends managing of current HLA object. More...
virtual void	requestUpdate ()
	Request that the owner of this entity send an attribute update. More...
virtual DtTime	keyTime () const
	Set/Get the time value used with ID to define a map key Key is used to store objects by time but still allow index by ID (using this keyTime) More...
virtual void	setKeyTime (DtTime timeValue)
	Set/Get the time value used with ID to define a map key Key is used to store objects by time but still allow index by ID (using this keyTime) More...

Protected Member Functions
	DtReflectedObject (const DtReflectedObject &orig)
	copy constructor – Not Implemented More...
DtReflectedObject &	operator= (const DtReflectedObject &orig)
	assignment operator – Not Implemented More...
virtual void	processPostUpdateCallbacks ()
	Process the post update callbacks. More...

Static Protected Member Functions
static void	processPostUpdateCallbacksCb (const DtStateMsg &stateMsg, DtHlaObject *obj, void *usr)
	Callback from HlaObject to process post update callbacks. More...

Protected Attributes
DtExerciseConn *	myExConn
DtHlaObjectWithStateRep *	myHlaObj
DtStateRepository *	myStateRep
DtHlaStateDecoder *	myDecoder
DtIntrusiveList	myStateUpdateCallbacks
DtObjectId	myId
DtString	myName
DtTime	myKeyTime
DtRefHlaObjectMap::iterator	myReflIterator
DtRefHlaObjectMap *	myReflMap

Friends
class	DtReflectedObjectList

Detailed Description

class DtReflectedObject:

Instances of DtReflectedObject are used to represent a simulation entity reflected across a network (i.e. this is not a full simulation running on this machine).

Member Typedef Documentation

typedef DtStateRepository*(* DtReflectedObject::DtBaseStateRepCreator)()

Function prototype for functions that create DtStateRepositories.

Constructor & Destructor Documentation

DtReflectedObject::DtReflectedObject	(	DtExerciseConn *	conn,
		DtStateRepository *	stateRep
	)

Primary constructor.

DtReflectedObject::DtReflectedObject	(	DtHlaObject *	obj,
		DtExerciseConn *	conn,
		DtBaseStateRepCreator	creator
	)

Older constructor.

Use the primary constructor followed by setHlaObject instead.

DtReflectedObject::DtReflectedObject	(	const DtObjectId &	id,
		const DtGlobalObjectDesignator &	des,
		DtExerciseConn *	conn,
		DtBaseStateRepCreator	creator
	)

Older constructor.

Use the primary constructor followed by setNoHlaObject instead.

virtual DtReflectedObject::~DtReflectedObject ( )

virtual

destructor

DtReflectedObject::DtReflectedObject ( const DtReflectedObject &  orig )

protected

copy constructor – Not Implemented

Member Function Documentation

virtual void DtReflectedObject::baseAddPostUpdateCallback ( DtReflectedObjectCallbackFunction  cb, void *  userData  )

virtual

Object state callback registration/deregistration.

virtual void DtReflectedObject::baseRemovePostUpdateCallback ( DtReflectedObjectCallbackFunction  cb, void *  userData  )

virtual

virtual DtHlaStateDecoder* DtReflectedObject::decoder ( )

virtual

Returns a pointer to the Decoder being used to decode state messages into our SR.

void DtReflectedObject::detachHlaObject

(

)

Ends managing of current HLA object.

NON Virtual – Called in DTOR

virtual const DtGlobalObjectDesignator& DtReflectedObject::globalId ( ) const

virtual

Get the HLA object's global object designator - the object name in HLA.

DtHlaObjectWithStateRep * DtReflectedObject::hlaObject ( ) const

inlinevirtual

Get the entity's hlaObject (DtHlaObjectWithStateRep is derived from DtHlaObject).

References myHlaObj.

virtual const DtObjectId& DtReflectedObject::id ( ) const

virtual

Get the HLA object's id (local ID).

Referenced by localId().

virtual DtTime DtReflectedObject::keyTime ( ) const

virtual

Set/Get the time value used with ID to define a map key Key is used to store objects by time but still allow index by ID (using this keyTime)

virtual const DtString& DtReflectedObject::lastProducingFederate ( ) const

virtual

Get the name of the last federate that produced a reflected update.

HLA Evolved only. May require additional RTI configuration to be populated.

virtual DtTime DtReflectedObject::lastReceivedTimeStamp ( ) const

virtual

Returns the value of the time send in the last Update received for this entity.

virtual DtTime DtReflectedObject::lastSimTimeUpdated ( ) const

virtual

Returns the value of simulation time at the time an update was last received for the entity.

const DtObjectId & DtReflectedObject::localId ( ) const

inlinevirtual

Get the HLA object's id (local ID).

References id().

virtual const DtString& DtReflectedObject::name ( ) const

virtual

Get the HLA object name.

DtReflectedObject * DtReflectedObject::nextObj ( ) const

inlinevirtual

Get the next remote object.

References myReflIterator, and myReflMap.

Referenced by wrapNextObj().

virtual const DtObjectId& DtReflectedObject::objectId ( ) const

virtual

Get the HLA object's id.

DtReflectedObject& DtReflectedObject::operator= ( const DtReflectedObject &  orig )

protected

assignment operator – Not Implemented

DtReflectedObject * DtReflectedObject::prevObj ( ) const

inlinevirtual

Get the previous remote object.

References myReflIterator, and myReflMap.

Referenced by wrapPrevObj().

virtual void DtReflectedObject::processPostUpdateCallbacks ( )

protectedvirtual

Process the post update callbacks.

static void DtReflectedObject::processPostUpdateCallbacksCb ( const DtStateMsg &  stateMsg, DtHlaObject *  obj, void *  usr  )

staticprotected

Callback from HlaObject to process post update callbacks.

virtual void DtReflectedObject::requestUpdate ( )

virtual

Request that the owner of this entity send an attribute update.

void DtReflectedObject::setHlaObject	(	DtHlaObject *	obj,
		DtHlaStateDecoder *	decoder = NULL
	)

Start reflecting this object, using this decoder.

If decoder is NULL, we get one from the FOM Mapper. The decoder is deleted by the DtReflectedObject destructor. Usually called by derived class constructor.

virtual void DtReflectedObject::setKeyTime ( DtTime  timeValue )

virtual

Set/Get the time value used with ID to define a map key Key is used to store objects by time but still allow index by ID (using this keyTime)

virtual void DtReflectedObject::setNoHlaObject ( const DtObjectId &  id, const DtGlobalObjectDesignator &  des  )

virtual

Used to set up a proxy DtReflectedEntity - one that is not actually managing a real reflected HLA object.

DtStateRepository * DtReflectedObject::sr ( ) const

inlinevirtual

Synonym for stateRep().

References myStateRep.

DtStateRepository * DtReflectedObject::stateRep ( ) const

inlinevirtual

Returns a pointer to the StateRepository - through which you can inspect current state information.

References myStateRep.

DtReflectedObject * DtReflectedObject::wrapNextObj ( ) const

inlinevirtual

Get the next remote object.

Will cycle back to the first remote object.

References myReflMap, and nextObj().

DtReflectedObject * DtReflectedObject::wrapPrevObj ( ) const

inlinevirtual

Get the previous remote object.

Will cycle back to the last remote object.

References myReflMap, and prevObj().

Friends And Related Function Documentation

friend class DtReflectedObjectList

friend

Member Data Documentation

DtHlaStateDecoder* DtReflectedObject::myDecoder

protected

DtExerciseConn* DtReflectedObject::myExConn

protected

DtHlaObjectWithStateRep* DtReflectedObject::myHlaObj

protected

Referenced by hlaObject().

DtObjectId DtReflectedObject::myId

protected

DtTime DtReflectedObject::myKeyTime

protected

DtString DtReflectedObject::myName

protected

DtRefHlaObjectMap::iterator DtReflectedObject::myReflIterator

protected

Referenced by nextObj(), and prevObj().

DtRefHlaObjectMap* DtReflectedObject::myReflMap

protected

Referenced by nextObj(), prevObj(), wrapNextObj(), and wrapPrevObj().

DtStateRepository* DtReflectedObject::myStateRep

protected

Referenced by DtReflectedActiveSonarBeam::activeSonarBeamRep(), DtReflectedActiveSonar::activeSonarRep(), DtReflectedAdditionalPassiveActivities::additionalPassiveActivitiesRep(), DtReflectedAerodrome::aerodromeStateRep(), DtReflectedAggregate::aggregateStateRep(), DtReflectedArealObject::aosr(), DtReflectedArealObject::arealObjectRep(), DtReflectedAerodrome::asr(), DtReflectedAdditionalPassiveActivities::asr(), DtReflectedAggregate::asr(), DtReflectedActiveSonar::asr(), DtReflectedEmitterBeam::beamRep(), DtReflectedActiveSonarBeam::bsr(), DtReflectedEmitterBeam::bsr(), DtReflectedDesignator::designatorRep(), DtReflectedDIGuyObject::dIGuyObjectStateRep(), DtReflectedDIGuyObject::dsr(), DtReflectedDesignator::dsr(), DtReflectedEmitterSystem::emitterSysRep(), DtReflectedEntity::entityStateRep(), DtReflectedEnvironmentProcess::environmentProcessStateRep(), DtReflectedEnvironmentProcess::epsr(), DtReflectedEntity::esr(), DtReflectedEmitterSystem::esr(), DtReflectedFederate::federateRep(), DtReflectedFederate::fsr(), DtReflectedGriddedData::gdsr(), DtReflectedGriddedData::gridDataRep(), DtReflectedIFFData::IFFDataStateRep(), DtReflectedIff::iffRep(), DtReflectedIff::iffStateRep(), DtReflectedIff::isr(), DtReflectedIFFData::Isr(), DtReflectedLandSurface::landSurfaceStateRep(), DtReflectedLinearObject::linearObjectRep(), DtReflectedLinearObject::losr(), DtReflectedLandSurface::lsr(), DtReflectedMode1::mode1StateRep(), DtReflectedMode2::mode2StateRep(), DtReflectedMode3A::mode3AStateRep(), DtReflectedMode3C::Mode3CStateRep(), DtReflectedMode4::mode4StateRep(), DtReflectedMode5::mode5StateRep(), DtReflectedModeS::modeSStateRep(), DtReflectedMode1::msr(), DtReflectedMode2::msr(), DtReflectedMode3A::msr(), DtReflectedMode3C::msr(), DtReflectedMode4::msr(), DtReflectedMode5::msr(), DtReflectedModeS::msr(), DtReflectedSoviet::msr(), DtReflectedRRB::msr(), DtReflectedPointObject::pointObjectRep(), DtReflectedPointObject::posr(), DtReflectedPropulsionNoise::propulsionNoiseRep(), DtReflectedPropulsionNoise::psr(), DtReflectedRadioReceiver::receiverRep(), DtReflectedRRB::rrbStateRep(), DtReflectedRunway::rsr(), DtReflectedRadioReceiver::rsr(), DtReflectedRunway::runwayStateRep(), DtReflectedService::serviceStateRep(), DtReflectedSoviet::sovietStateRep(), sr(), DtReflectedSubsurfaceLayer::ssr(), DtReflectedService::ssr(), stateRep(), DtReflectedSubsurfaceLayer::subsurfaceLayerStateRep(), DtReflectedTCASData::TCASDataStateRep(), DtReflectedTimeAndDate::timeAndDateStateRep(), DtReflectedRadioTransmitter::transmitterRep(), DtReflectedTroposphereLayer::troposphereLayerStateRep(), DtReflectedTimeAndDate::tsr(), DtReflectedTurbulenceLayer::tsr(), DtReflectedTroposphereLayer::tsr(), DtReflectedRadioTransmitter::tsr(), DtReflectedTCASData::Tsr(), DtReflectedTurbulenceLayer::turbulenceLayerStateRep(), DtReflectedUnderwaterAcoustics::underwaterAcousticsStateRep(), DtReflectedUnderwaterAcoustics::usr(), DtReflectedVRLinkState::vrlinkStateStateRep(), DtReflectedVRLinkState::vsr(), DtReflectedWaterSurface::waterSurfaceStateRep(), DtReflectedWeather::weatherStateRep(), DtReflectedWindCorridor::windCorridorStateRep(), DtReflectedWindCorridor::wsr(), DtReflectedWaterSurface::wsr(), and DtReflectedWeather::wsr().

DtIntrusiveList DtReflectedObject::myStateUpdateCallbacks

protected

---

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

• reflectedObjectHLA.h