VR-Link API Documentation for DIS
 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
DtReflectedRadioReceiver Class Reference

Instances of DtReflectedRadioReceiver represent radio receiver objects simulated by remote applications. More...

+ Inheritance diagram for DtReflectedRadioReceiver:
+ Collaboration diagram for DtReflectedRadioReceiver:

Public Types

typedef
DtRadioReceiverRepository *(* 
DtStateRepCreator )()
 Function prototype for functions that create DtRadioReceiverRepositories.

Public Member Functions

 DtReflectedRadioReceiver (DtExerciseConn *conn, const DtEntityIdentifier &id, int radioId)
 Constructor.
virtual ~DtReflectedRadioReceiver ()
 Destructor.
virtual DtRadioReceiverRepositoryreceiverRep () const
 Returns ptr to a DtRadioReceiverRepository – through which you can inspect current state info.
virtual DtRadioReceiverRepositoryrsr () const
 Synonym for receiverRep().
virtual DtStateRepositorystateRep () const
 Implementation for abstract base class. Calls rsr().
virtual DtRadioReceiverDecoderdecoder ()
 Returns a pointer to the decoder being used to decode state messages into our DtRadioReceiverRepository.
virtual const DtEntityIdentifierentityId () const
 Returns the entity identifier.
virtual const DtObjectIdid () const
 Get the radio receiver's id. (For DIS, DtObjectId is DtEntityIdentifier).
virtual const DtObjectIdlocalId () const
 Get the radio receiver's local id. For DIS - same as id().
virtual const
DtGlobalObjectDesignator
globalId () const
 Get the radio receiver's object's global object designator - for DIS, it's the same as its DtEntityIdentifier.
virtual int radioId () const
 Get the radio receiver's radio ID.
virtual void processStateMessage (const DtStateMsg &msg)
 Process a radio receiver PDU.
virtual DtReflectedRadioReceivernext () const
 Get the next and previous elements in the reflected radio receiver list.
virtual DtReflectedRadioReceiverprev () const
virtual DtReflectedRadioReceiverwrapNext () const
 Get the next and previous elements, wrap at the ends of the list.
virtual DtReflectedRadioReceiverwrapPrev () const
virtual void addPostUpdateCallback (DtRadioReceiverCallbackFunction cb, void *userData)
 Radio Receiver callback registration/deregistration.
virtual void removePostUpdateCallback (DtRadioReceiverCallbackFunction cb, void *userData)
virtual const DtBaseHashKeyhashKey () const
 Get a hash key for this object.
virtual DtString idString () const
 Get a string identification of this object.
virtual void processRadioReceiver (const DtReceiverPdu &pdu)
 Process a receiver PDU.
- Public Member Functions inherited from DtReflectedObject
 DtReflectedObject (DtExerciseConn *conn)
 constructor
virtual ~DtReflectedObject ()
 destructor
virtual DtStateRepositorysr () const
 Synonym for stateRep().
virtual DtTime lastTimeUpdated () const
 Returns the value of wallclock time at the time an update was last received for the entity.
virtual DtTime lastSimTimeUpdated () const
 Returns the value of sim time at the time an update was last received for the entity.
virtual DtTime lastReceivedTimeStamp () const
 Returns the value in seconds past the hour of the timeStamp from the last received PDU.
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.
- Public Member Functions inherited from DtListedObj
 DtListedObj ()
 Constructor.
virtual ~DtListedObj ()
 Destructor.

Static Public Member Functions

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

Protected Member Functions

 DtReflectedRadioReceiver (const DtReflectedRadioReceiver &orig)
 Copy constructor – not implemented.
DtReflectedRadioReceiveroperator= (const DtReflectedRadioReceiver &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

DtEntityIdentifier myId
DtString myIdString
DtRadioReceiverRepositorymyStateRep
DtRadioReceiverDecodermyDecoder
DtStringHashKey myHashKey
- Protected Attributes inherited from DtReflectedObject
DtExerciseConnmyExConn
DtIntrusiveList myStateUpdateCallbacks
DtTime myLastTimeUpdated
DtTime myLastSimTimeUpdated
DtTime myLastReceivedTimeStamp
- Protected Attributes inherited from DtListedObj
DtListmyList
DtListItemmyItem

Static Protected Attributes

static DtStateRepCreator theStateRepCreator

Detailed Description

Instances of DtReflectedRadioReceiver represent radio receiver objects simulated by remote applications.

State data can be viewed through its state repository.

Member Typedef Documentation

typedef DtRadioReceiverRepository*(* DtReflectedRadioReceiver::DtStateRepCreator)()

Function prototype for functions that create DtRadioReceiverRepositories.

Constructor & Destructor Documentation

DtReflectedRadioReceiver::DtReflectedRadioReceiver ( DtExerciseConn conn,
const DtEntityIdentifier id,
int  radioId 
)

Constructor.

virtual DtReflectedRadioReceiver::~DtReflectedRadioReceiver ( )
virtual

Destructor.

DtReflectedRadioReceiver::DtReflectedRadioReceiver ( const DtReflectedRadioReceiver orig)
protected

Copy constructor – not implemented.

Member Function Documentation

virtual void DtReflectedRadioReceiver::addPostUpdateCallback ( DtRadioReceiverCallbackFunction  cb,
void *  userData 
)
virtual

Radio Receiver callback registration/deregistration.

virtual DtRadioReceiverDecoder* DtReflectedRadioReceiver::decoder ( )
virtual

Returns a pointer to the decoder being used to decode state messages into our DtRadioReceiverRepository.

virtual const DtEntityIdentifier& DtReflectedRadioReceiver::entityId ( ) const
virtual

Returns the entity identifier.

virtual const DtGlobalObjectDesignator& DtReflectedRadioReceiver::globalId ( ) const
virtual

Get the radio receiver's object's global object designator - for DIS, it's the same as its DtEntityIdentifier.

Implements DtReflectedObject.

virtual const DtBaseHashKey& DtReflectedRadioReceiver::hashKey ( ) const
virtual

Get a hash key for this object.

Implements DtReflectedObject.

virtual const DtObjectId& DtReflectedRadioReceiver::id ( ) const
virtual

Get the radio receiver's id. (For DIS, DtObjectId is DtEntityIdentifier).

virtual DtString DtReflectedRadioReceiver::idString ( ) const
virtual

Get a string identification of this object.

Implements DtReflectedObject.

virtual const DtObjectId& DtReflectedRadioReceiver::localId ( ) const
virtual

Get the radio receiver's local id. For DIS - same as id().

virtual DtReflectedRadioReceiver* DtReflectedRadioReceiver::next ( ) const
virtual

Get the next and previous elements in the reflected radio receiver list.

Reimplemented from DtListedObj.

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

Assignment operator – not implemented.

virtual DtReflectedRadioReceiver* DtReflectedRadioReceiver::prev ( ) const
virtual

Reimplemented from DtListedObj.

virtual void DtReflectedRadioReceiver::processRadioReceiver ( const DtReceiverPdu pdu)
virtual

Process a receiver PDU.

Also calls down to base class processStateMessage().

virtual void DtReflectedRadioReceiver::processStateMessage ( const DtStateMsg msg)
virtual

Process a radio receiver PDU.

Calls processRadioReceiver().

Reimplemented from DtReflectedObject.

int DtReflectedRadioReceiver::radioId ( ) const
inlinevirtual

Get the radio receiver's radio ID.

References myStateRep, and DtRadioReceiverRepository::radioId().

virtual DtRadioReceiverRepository* DtReflectedRadioReceiver::receiverRep ( ) const
virtual

Returns ptr to a DtRadioReceiverRepository – through which you can inspect current state info.

virtual void DtReflectedRadioReceiver::removePostUpdateCallback ( DtRadioReceiverCallbackFunction  cb,
void *  userData 
)
virtual
virtual DtRadioReceiverRepository* DtReflectedRadioReceiver::rsr ( ) const
virtual

Synonym for receiverRep().

static void DtReflectedRadioReceiver::setStateRepCreator ( DtStateRepCreator  creator)
static

Give us a function to be used for creating SRs.

virtual DtStateRepository* DtReflectedRadioReceiver::stateRep ( ) const
virtual

Implementation for abstract base class. Calls rsr().

Implements DtReflectedObject.

static DtStateRepCreator DtReflectedRadioReceiver::stateRepCreator ( void  )
static
virtual DtReflectedRadioReceiver* DtReflectedRadioReceiver::wrapNext ( ) const
virtual

Get the next and previous elements, wrap at the ends of the list.

Reimplemented from DtListedObj.

virtual DtReflectedRadioReceiver* DtReflectedRadioReceiver::wrapPrev ( ) const
virtual

Reimplemented from DtListedObj.

Member Data Documentation

DtRadioReceiverDecoder* DtReflectedRadioReceiver::myDecoder
protected
DtStringHashKey DtReflectedRadioReceiver::myHashKey
protected
DtEntityIdentifier DtReflectedRadioReceiver::myId
protected
DtString DtReflectedRadioReceiver::myIdString
protected
DtRadioReceiverRepository* DtReflectedRadioReceiver::myStateRep
protected

Referenced by radioId().

DtStateRepCreator DtReflectedRadioReceiver::theStateRepCreator
staticprotected

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

Document ID: Generated on Thu Feb 22 04:26:36 EST 2018 from SVN revision 186468
Copyright © 2005-2016 VT MÄK. All Rights Reserved (www.mak.com)