VR-Link API Documentation for HLA 1516
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Attributes
DtReflectedAggregate Class Reference

class DtReflectedAggregate: More...

+ Inheritance diagram for DtReflectedAggregate:
+ Collaboration diagram for DtReflectedAggregate:

Public Types

typedef
DtAggregateStateRepository *(* 
DtStateRepCreator )()
 Function prototype for functions that create DtAggregateStateRepositorys.
- Public Types inherited from DtReflectedObject
typedef DtStateRepository *(* DtBaseStateRepCreator )()
 Function prototype for functions that create DtStateRepositories.

Public Member Functions

 DtReflectedAggregate (DtHlaObject *obj, DtExerciseConn *conn)
 constructor
virtual ~DtReflectedAggregate ()
 destructor
virtual
DtAggregateStateRepository
aggregateStateRep () const
 Returns a pointer to the AggregateStateRepository - through which you can inspect current state information.
virtual
DtAggregateStateRepository
asr () const
 Synonym for aggregateStateRep().
virtual DtReflectedAggregatenext () const
 Get the next remote aggregate.
virtual DtReflectedAggregateprev () const
 Get the previous remote aggregate.
virtual DtReflectedAggregatewrapNext () const
 Get the next remote aggregate.
virtual DtReflectedAggregatewrapPrev () const
 Get the previous remote aggregate.
virtual void addPostUpdateCallback (DtAggregateCallbackFunction cb, void *userData)
 Aggregate state callback registration/deregistration.
virtual void removePostUpdateCallback (DtAggregateCallbackFunction cb, void *userData)
virtual RTI::ObjectInstanceHandle aggregateObjectId () const
 Get the aggregate HLA object's id.
- Public Member Functions inherited from DtReflectedObject
 DtReflectedObject (DtExerciseConn *conn, DtStateRepository *stateRep)
 Primary constructor.
 DtReflectedObject (DtHlaObject *obj, DtExerciseConn *conn, DtBaseStateRepCreator creator)
 Older constructor.
 DtReflectedObject (const DtObjectId &id, const DtGlobalObjectDesignator &des, DtExerciseConn *conn, DtBaseStateRepCreator creator)
 Older constructor.
virtual ~DtReflectedObject ()
 destructor
virtual DtStateRepositorystateRep () const
 Returns a pointer to the StateRepository - through which you can inspect current state information.
virtual DtStateRepositorysr () const
 Synonym for stateRep().
virtual DtHlaStateDecoderdecoder ()
 Returns a pointer to the Decoder being used to decode state messages into our SR.
virtual DtHlaObjectWithStateRephlaObject () const
 Get the entity's hlaObject (DtHlaObjectWithStateRep is derived from DtHlaObject).
virtual const DtObjectIdobjectId () const
 Get the HLA object's id.
virtual const DtObjectIdid () const
 Get the HLA object's id (local ID).
virtual const DtObjectIdlocalId () const
 Get the HLA object's id (local ID).
virtual const DtStringname () const
 Get the HLA object name.
virtual const
DtGlobalObjectDesignator
globalId () const
 Get the HLA object's global object designator - the object name in HLA.
virtual const std::set
< DtDDMRegion > & 
lastRegionInformation () const
 Get the region handle from the last update HLA 1516 only.
virtual DtTime lastSimTimeUpdated () const
 Returns the value of simulation time at the time an update was last received for the entity.
virtual DtTime lastReceivedTimeStamp () const
 Returns the value of the time send in the last Update received for this entity.
virtual void baseAddPostUpdateCallback (DtReflectedObjectCallbackFunction cb, void *userData)
 Object state callback registration/deregistration.
virtual void baseRemovePostUpdateCallback (DtReflectedObjectCallbackFunction cb, void *userData)
virtual DtReflectedObjectnextObj () const
 Get the next remote object.
virtual DtReflectedObjectprevObj () const
 Get the previous remote object.
virtual DtReflectedObjectwrapNextObj () const
 Get the next remote object.
virtual DtReflectedObjectwrapPrevObj () const
 Get the previous remote object.
void setHlaObject (DtHlaObject *obj, DtHlaStateDecoder *decoder=NULL)
 Start reflecting this object, using this decoder.
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.
void detachHlaObject ()
 Ends managing of current HLA object.
virtual void requestUpdate ()
 Request that the owner of this entity send an attribute update.
- Public Member Functions inherited from DtListedObj
 DtListedObj ()
 Constructor.
virtual ~DtListedObj ()
 Destructor.

Static Public Member Functions

static DtStateRepCreator setStateRepCreator (DtStateRepCreator creator)
 Give us a function to be used for creating SRs.

Protected Member Functions

 DtReflectedAggregate (const DtReflectedAggregate &orig)
 copy constructor
DtReflectedAggregateoperator= (const DtReflectedAggregate &orig)
 assignment operator
- Protected Member Functions inherited from DtReflectedObject
 DtReflectedObject (const DtReflectedObject &orig)
 copy constructor – Not Implemented
DtReflectedObjectoperator= (const DtReflectedObject &orig)
 assignment operator – Not Implemented
virtual void processPostUpdateCallbacks ()
 Process the post update callbacks.

Static Protected Attributes

static DtStateRepCreator theStateRepCreator

Additional Inherited Members

- Static Protected Member Functions inherited from DtReflectedObject
static void requestUpdatePostDrainCb (void *usr)
 Calls requestUpdate.
static void processPostUpdateCallbacksCb (const DtStateMsg &stateMsg, DtHlaObject *obj, void *usr)
 Callback from HlaObject to process post update callbacks.
- Protected Attributes inherited from DtReflectedObject
DtExerciseConnmyExConn
DtHlaObjectWithStateRepmyHlaObj
DtStateRepositorymyStateRep
DtHlaStateDecodermyDecoder
bool myRequestCbRegistered
DtIntrusiveList myStateUpdateCallbacks
DtObjectId myId
DtString myName

Detailed Description

class DtReflectedAggregate:

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

Member Typedef Documentation

typedef DtAggregateStateRepository*(* DtReflectedAggregate::DtStateRepCreator)()

Function prototype for functions that create DtAggregateStateRepositorys.

Constructor & Destructor Documentation

DtReflectedAggregate::DtReflectedAggregate ( DtHlaObject obj,
DtExerciseConn conn 
)

constructor

virtual DtReflectedAggregate::~DtReflectedAggregate ( )
virtual

destructor

DtReflectedAggregate::DtReflectedAggregate ( const DtReflectedAggregate orig)
protected

copy constructor

Member Function Documentation

virtual void DtReflectedAggregate::addPostUpdateCallback ( DtAggregateCallbackFunction  cb,
void *  userData 
)
virtual

Aggregate state callback registration/deregistration.

virtual RTI::ObjectInstanceHandle DtReflectedAggregate::aggregateObjectId ( ) const
virtual

Get the aggregate HLA object's id.

For backwards compatibility. Use id() instead.

DtAggregateStateRepository * DtReflectedAggregate::aggregateStateRep ( ) const
inlinevirtual

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

References DtReflectedObject::myStateRep.

DtAggregateStateRepository * DtReflectedAggregate::asr ( ) const
inlinevirtual
virtual DtReflectedAggregate* DtReflectedAggregate::next ( ) const
virtual

Get the next remote aggregate.

Reimplemented from DtListedObj.

DtReflectedAggregate& DtReflectedAggregate::operator= ( const DtReflectedAggregate orig)
protected

assignment operator

virtual DtReflectedAggregate* DtReflectedAggregate::prev ( ) const
virtual

Get the previous remote aggregate.

Reimplemented from DtListedObj.

virtual void DtReflectedAggregate::removePostUpdateCallback ( DtAggregateCallbackFunction  cb,
void *  userData 
)
virtual
static DtStateRepCreator DtReflectedAggregate::setStateRepCreator ( DtStateRepCreator  creator)
static

Give us a function to be used for creating SRs.

virtual DtReflectedAggregate* DtReflectedAggregate::wrapNext ( ) const
virtual

Get the next remote aggregate.

Will cycle back to the first remote aggregate.

Reimplemented from DtListedObj.

virtual DtReflectedAggregate* DtReflectedAggregate::wrapPrev ( ) const
virtual

Get the previous remote aggregate.

Will cycle back to the last remote aggregate.

Reimplemented from DtListedObj.

Member Data Documentation

DtStateRepCreator DtReflectedAggregate::theStateRepCreator
staticprotected

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

Document ID: Generated on Wed Aug 14 15:35:11 EDT 2013 from SVN revision 130445
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)