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

Instances of DtReflectedDIGuyObject are used to represent a simulated HLAobjectRoot.DIGuyObject object reflected across a network. More...

+ Inheritance diagram for DtReflectedDIGuyObject:
+ Collaboration diagram for DtReflectedDIGuyObject:

Public Types

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

Public Member Functions

 DtReflectedDIGuyObject (DtHlaObject *obj, DtExerciseConn *exConn)
 Constructor.
virtual ~DtReflectedDIGuyObject ()
 Destructor.
virtual
DtDIGuyObjectStateRepository * 
dIGuyObjectStateRep () const
 Returns the DIGuyObject's state repository.
virtual
DtDIGuyObjectStateRepository * 
dsr () const
 Shorter version of lifeformRep.
virtual void setDsr (DtDIGuyObjectStateRepository *newDsr)
 Set beam state repository.
virtual DtReflectedDIGuyObject * next () const
 Returns the next reflected DIGuyObject in the DtReflectedDIGuyObjectList.
virtual DtReflectedDIGuyObject * prev () const
 Returns the previous reflected DIGuyObject in the DtReflectedDIGuyObjectList.
virtual DtReflectedDIGuyObject * wrapNext () const
 Returns the next reflected DIGuyObject.
virtual DtReflectedDIGuyObject * wrapPrev () const
 Returns the previous reflected DIGuyObject.
virtual void addPostUpdateCallback (DtDIGuyObjectCallbackFunction cb, void *userData)
 Add a callback that is called when the DtReflectedDIGuyObject is updated.
virtual void removePostUpdateCallback (DtDIGuyObjectCallbackFunction cb, void *userData)
 Remove the callback that is called when the DtReflectedDIGuyObject is updated.
- 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 DtStateRepository * stateRep () const
 Returns a pointer to the StateRepository - through which you can inspect current state information.
virtual DtStateRepository * sr () const
 Synonym for stateRep().
virtual DtHlaStateDecoder * decoder ()
 Returns a pointer to the Decoder being used to decode state messages into our SR.
virtual DtHlaObjectWithStateRep * hlaObject () const
 Get the entity's hlaObject (DtHlaObjectWithStateRep is derived from DtHlaObject).
virtual const DtObjectId & objectId () const
 Get the HLA object's id.
virtual const DtObjectId & id () const
 Get the HLA object's id (local ID).
virtual const DtObjectId & localId () const
 Get the HLA object's id (local ID).
virtual const DtString & name () 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 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 DtReflectedObject * nextObj () const
 Get the next remote object.
virtual DtReflectedObject * prevObj () const
 Get the previous remote object.
virtual DtReflectedObject * wrapNextObj () const
 Get the next remote object.
virtual DtReflectedObject * wrapPrevObj () 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)
 Set the function to be called for creating state repositories.

Protected Member Functions

 DtReflectedDIGuyObject (const DtReflectedDIGuyObject &orig)
 Copy Constructor not implemented.
DtReflectedDIGuyObject & operator= (const DtReflectedDIGuyObject &orig)
 Assignment operator not implemented.
- Protected Member Functions inherited from DtReflectedObject
 DtReflectedObject (const DtReflectedObject &orig)
 copy constructor – Not Implemented
DtReflectedObject & operator= (const DtReflectedObject &orig)
 assignment operator – Not Implemented
virtual void processPostUpdateCallbacks ()
 Process the post update callbacks.

Protected Attributes

DtDIGuyObjectStateRepository * myConstructedDsr
- Protected Attributes inherited from DtReflectedObject
DtExerciseConn * myExConn
DtHlaObjectWithStateRep * myHlaObj
DtStateRepository * myStateRep
DtHlaStateDecoder * myDecoder
bool myRequestCbRegistered
DtIntrusiveList myStateUpdateCallbacks
DtObjectId myId
DtString myName
- Protected Attributes inherited from DtListedObj
DtList * myList
DtListItem * myItem

Static Protected Attributes

static DtStateRepCreator theStateRepCreator
 The function called to create state repositories.

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.

Detailed Description

Instances of DtReflectedDIGuyObject are used to represent a simulated HLAobjectRoot.DIGuyObject object reflected across a network.

Member Typedef Documentation

typedef DtDIGuyObjectStateRepository*(* DtReflectedDIGuyObject::DtStateRepCreator)()

Function prototype for functions that create a DtDIGuyObjectStateRepository.

Constructor & Destructor Documentation

DtReflectedDIGuyObject::DtReflectedDIGuyObject ( DtHlaObject *  obj,
DtExerciseConn *  exConn 
)

Constructor.

virtual DtReflectedDIGuyObject::~DtReflectedDIGuyObject ( )
virtual

Destructor.

DtReflectedDIGuyObject::DtReflectedDIGuyObject ( const DtReflectedDIGuyObject &  orig)
protected

Copy Constructor not implemented.

Member Function Documentation

virtual void DtReflectedDIGuyObject::addPostUpdateCallback ( DtDIGuyObjectCallbackFunction  cb,
void *  userData 
)
virtual

Add a callback that is called when the DtReflectedDIGuyObject is updated.

DtDIGuyObjectStateRepository * DtReflectedDIGuyObject::dIGuyObjectStateRep ( ) const
inlinevirtual

Returns the DIGuyObject's state repository.

References DtReflectedObject::myStateRep.

DtDIGuyObjectStateRepository * DtReflectedDIGuyObject::dsr ( ) const
inlinevirtual

Shorter version of lifeformRep.

References DtReflectedObject::myStateRep.

virtual DtReflectedDIGuyObject* DtReflectedDIGuyObject::next ( ) const
virtual

Returns the next reflected DIGuyObject in the DtReflectedDIGuyObjectList.

Reimplemented from DtListedObj.

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

Assignment operator not implemented.

virtual DtReflectedDIGuyObject* DtReflectedDIGuyObject::prev ( ) const
virtual

Returns the previous reflected DIGuyObject in the DtReflectedDIGuyObjectList.

Reimplemented from DtListedObj.

virtual void DtReflectedDIGuyObject::removePostUpdateCallback ( DtDIGuyObjectCallbackFunction  cb,
void *  userData 
)
virtual

Remove the callback that is called when the DtReflectedDIGuyObject is updated.

virtual void DtReflectedDIGuyObject::setDsr ( DtDIGuyObjectStateRepository *  newDsr)
virtual

Set beam state repository.

Only necessary when you want to use something other than the default, which is created internally.

static DtStateRepCreator DtReflectedDIGuyObject::setStateRepCreator ( DtStateRepCreator  creator)
static

Set the function to be called for creating state repositories.

virtual DtReflectedDIGuyObject* DtReflectedDIGuyObject::wrapNext ( ) const
virtual

Returns the next reflected DIGuyObject.

Will cycle back to the first remote DIGuyObject in the DtReflectedDIGuyObjectList.

Reimplemented from DtListedObj.

virtual DtReflectedDIGuyObject* DtReflectedDIGuyObject::wrapPrev ( ) const
virtual

Returns the previous reflected DIGuyObject.

Will cycle back to the first remote DIGuyObject in the DtReflectedDIGuyObjectList.

Reimplemented from DtListedObj.

Member Data Documentation

DtDIGuyObjectStateRepository* DtReflectedDIGuyObject::myConstructedDsr
protected
DtStateRepCreator DtReflectedDIGuyObject::theStateRepCreator
staticprotected

The function called to create state repositories.


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)