VR-Link API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
DtReflectedEmitterBeam Class Reference

class DtReflectedEmitterBeam: More...

+ Inheritance diagram for DtReflectedEmitterBeam:
+ Collaboration diagram for DtReflectedEmitterBeam:

Public Types

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

Public Member Functions

 DtReflectedEmitterBeam (DtHlaObject *obj, DtExerciseConn *conn)
 constructor
virtual ~DtReflectedEmitterBeam ()
 destructor
virtual DtEmitterBeamRepositorybeamRep () const
 Get the beam's state repository.
virtual DtEmitterBeamRepositorybsr () const
 Synonym for beamRep().
virtual void setBsr (DtEmitterBeamRepository *bsr)
 Set beam state repository.
virtual DtReflectedEmitterBeamnext () const
 Get the next remote beam.
virtual DtReflectedEmitterBeamprev () const
 Get the previous remote beam.
virtual DtReflectedEmitterBeamwrapNext () const
 Get the next remote beam.
virtual DtReflectedEmitterBeamwrapPrev () const
 Get the previous remote beam.
virtual void addPostUpdateCallback (DtEmitterBeamCallbackFunction cb, void *userData)
 beam state callback registration/deregistration.
virtual void removePostUpdateCallback (DtEmitterBeamCallbackFunction cb, void *userData)
- 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 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.

Static Public Member Functions

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

Protected Member Functions

 DtReflectedEmitterBeam (const DtReflectedEmitterBeam &orig)
 copy constructor – not implemented
DtReflectedEmitterBeamoperator= (const DtReflectedEmitterBeam &orig)
 assignment operator – not implemented
- 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.

Protected Attributes

DtEmitterBeamRepositorymyConstructedBsr
- Protected Attributes inherited from DtReflectedObject
DtExerciseConnmyExConn
DtHlaObjectWithStateRepmyHlaObj
DtStateRepositorymyStateRep
DtHlaStateDecodermyDecoder
bool myRequestCbRegistered
DtIntrusiveList myStateUpdateCallbacks
DtObjectId myId
DtString myName
DtRefHlaObjectMap::iterator myReflIterator
DtRefHlaObjectMapmyReflMap

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.

Detailed Description

class DtReflectedEmitterBeam:

Instances of DtReflectedEmitterBeam represent EmitterBeam object simulated by remote applications. State data can be viewed through its state repository.

Member Typedef Documentation

typedef DtEmitterBeamRepository*(* DtReflectedEmitterBeam::DtStateRepCreator)()

Function prototype for functions that create DtEmitterBeamRepositorys.

Constructor & Destructor Documentation

DtReflectedEmitterBeam::DtReflectedEmitterBeam ( DtHlaObject obj,
DtExerciseConn conn 
)

constructor

virtual DtReflectedEmitterBeam::~DtReflectedEmitterBeam ( )
virtual

destructor

DtReflectedEmitterBeam::DtReflectedEmitterBeam ( const DtReflectedEmitterBeam orig)
protected

copy constructor – not implemented

Member Function Documentation

virtual void DtReflectedEmitterBeam::addPostUpdateCallback ( DtEmitterBeamCallbackFunction  cb,
void *  userData 
)
virtual

beam state callback registration/deregistration.

DtEmitterBeamRepository * DtReflectedEmitterBeam::beamRep ( ) const
inlinevirtual

Get the beam's state repository.

References DtReflectedObject::myStateRep.

DtEmitterBeamRepository * DtReflectedEmitterBeam::bsr ( ) const
inlinevirtual

Synonym for beamRep().

References DtReflectedObject::myStateRep.

virtual DtReflectedEmitterBeam* DtReflectedEmitterBeam::next ( ) const
virtual

Get the next remote beam.

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

assignment operator – not implemented

virtual DtReflectedEmitterBeam* DtReflectedEmitterBeam::prev ( ) const
virtual

Get the previous remote beam.

virtual void DtReflectedEmitterBeam::removePostUpdateCallback ( DtEmitterBeamCallbackFunction  cb,
void *  userData 
)
virtual
virtual void DtReflectedEmitterBeam::setBsr ( DtEmitterBeamRepository bsr)
virtual

Set beam state repository.

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

static DtStateRepCreator DtReflectedEmitterBeam::setStateRepCreator ( DtStateRepCreator  creator)
static

Give us a function to be used for creating SRs.

virtual DtReflectedEmitterBeam* DtReflectedEmitterBeam::wrapNext ( ) const
virtual

Get the next remote beam.

Will cycle back to the first remote beam.

virtual DtReflectedEmitterBeam* DtReflectedEmitterBeam::wrapPrev ( ) const
virtual

Get the previous remote beam.

Will cycle back to the last remote beam.

Member Data Documentation

DtEmitterBeamRepository* DtReflectedEmitterBeam::myConstructedBsr
protected
DtStateRepCreator DtReflectedEmitterBeam::theStateRepCreator
staticprotected

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

Document ID: Generated on Mon Jun 22 21:18:40 EDT 2020 from SVN revision 213785
Copyright © 2005-2018 MAK Technologies. All Rights Reserved (www.mak.com)