VR-Link API Documentation for DIS
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:

List of all members.

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.

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 Attributes

DtEntityIdentifier myId
DtString myIdString
DtRadioReceiverRepositorymyStateRep
DtRadioReceiverDecodermyDecoder
DtStringHashKey myHashKey

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

Function prototype for functions that create DtRadioReceiverRepositories.


Constructor & Destructor Documentation

Constructor.

Destructor.

Copy constructor -- not implemented.


Member Function Documentation

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

Radio Receiver callback registration/deregistration.

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.

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().

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.

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 [inline, virtual]

Get the radio receiver's radio ID.

References myStateRep, and DtRadioReceiverRepository::radioId().

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

virtual void DtReflectedRadioReceiver::removePostUpdateCallback ( DtRadioReceiverCallbackFunction  cb,
void *  userData 
) [virtual]

Synonym for receiverRep().

Give us a function to be used for creating SRs.

Implementation for abstract base class. Calls rsr().

Implements DtReflectedObject.

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

Reimplemented from DtListedObj.

Reimplemented from DtListedObj.


Member Data Documentation

Referenced by radioId().


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)