VR-Link API Documentation for HLA 1.3
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Attributes
DtReflectedEntity Class Reference

Instances of DtReflectedEntity are used to represent a simulation entity reflected across a network (i.e. More...

+ Inheritance diagram for DtReflectedEntity:
+ Collaboration diagram for DtReflectedEntity:

List of all members.

Public Types

typedef DtEntityStateRepository *(* DtStateRepCreator )()
 Function prototype for functions that create DtEntityStateRepositories.
typedef DtStateRepCreator DtEsrCreator

Public Member Functions

 DtReflectedEntity (DtHlaObject *obj, DtExerciseConn *conn)
 constructor
 DtReflectedEntity (DtExerciseConn *conn, DtEntityStateRepository *esrToUse)
 Constructor with state rep to use passed in Note that setHlaObject() should be called after a reflected entity is created with this method.
 DtReflectedEntity (DtHlaObject *obj, DtExerciseConn *conn, DtBaseStateRepCreator esrToUse)
 Constructor with entity state repository creator passed in.
virtual ~DtReflectedEntity ()
 destructor
virtual DtEntityStateRepositoryentityStateRep () const
 Returns a pointer to the EntityStateRepository - through which you can inspect current state information.
virtual DtEntityStateRepositoryesr () const
 Synonym for entityStateRep().
virtual DtReflectedEntitynext () const
 Get the next remote entity.
virtual DtReflectedEntityprev () const
 Get the previous remote entity.
virtual DtReflectedEntitywrapNext () const
 Get the next remote entity.
virtual DtReflectedEntitywrapPrev () const
 Get the previous remote entity.
virtual void addPostUpdateCallback (DtEntityCallbackFunction cb, void *userData)
 Entity state callback registration/deregistration.
virtual void removePostUpdateCallback (DtEntityCallbackFunction cb, void *userData)
virtual RTI::ObjectHandle entityObjectId () const
 For backwards compatibility. Use id() instead.

Static Public Member Functions

static DtStateRepCreator setStateRepCreator (DtStateRepCreator creator)
 Give us a function to be used for creating SRs.
static DtEsrCreator setEsrCreator (DtEsrCreator creator)
 For backwards compatibility.

Protected Member Functions

 DtReflectedEntity (const DtReflectedEntity &orig)
 copy constructor -- Not Implemented
DtReflectedEntityoperator= (const DtReflectedEntity &orig)
 assignment operator -- Not Implemented

Static Protected Attributes

static DtStateRepCreator theStateRepCreator

Detailed Description

Instances of DtReflectedEntity 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

Deprecated:
Use DtStateRepCreator instead.

Function prototype for functions that create DtEntityStateRepositories.


Constructor & Destructor Documentation

constructor

Constructor with state rep to use passed in Note that setHlaObject() should be called after a reflected entity is created with this method.

Constructor with entity state repository creator passed in.

destructor

copy constructor -- Not Implemented


Member Function Documentation

virtual void DtReflectedEntity::addPostUpdateCallback ( DtEntityCallbackFunction  cb,
void *  userData 
) [virtual]

Entity state callback registration/deregistration.

virtual RTI::ObjectHandle DtReflectedEntity::entityObjectId ( ) const [virtual]

For backwards compatibility. Use id() instead.

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

References DtReflectedObject::myStateRep.

DtEntityStateRepository * DtReflectedEntity::esr ( ) const [inline, virtual]
virtual DtReflectedEntity* DtReflectedEntity::next ( ) const [virtual]

Get the next remote entity.

Reimplemented from DtListedObj.

DtReflectedEntity& DtReflectedEntity::operator= ( const DtReflectedEntity orig) [protected]

assignment operator -- Not Implemented

virtual DtReflectedEntity* DtReflectedEntity::prev ( ) const [virtual]

Get the previous remote entity.

Reimplemented from DtListedObj.

virtual void DtReflectedEntity::removePostUpdateCallback ( DtEntityCallbackFunction  cb,
void *  userData 
) [virtual]

For backwards compatibility.

Use setStateRepCreator instead. method setEsrCreator is deprecated and will be removed in the future

Give us a function to be used for creating SRs.

virtual DtReflectedEntity* DtReflectedEntity::wrapNext ( ) const [virtual]

Get the next remote entity.

Will cycle back to the first remote entity.

Reimplemented from DtListedObj.

virtual DtReflectedEntity* DtReflectedEntity::wrapPrev ( ) const [virtual]

Get the previous remote entity.

Will cycle back to the last remote entity.

Reimplemented from DtListedObj.


Member Data Documentation


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

Document ID: Generated on Mon May 14 08:06:18 EDT 2012 from SVN revision 114750
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)