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

Instances of DtRadioReceiverRepository are used to store state information for radio receiver objects in both HLA and DIS environments. More...

+ Inheritance diagram for DtRadioReceiverRepository:
+ Collaboration diagram for DtRadioReceiverRepository:

List of all members.

Public Member Functions

 DtRadioReceiverRepository ()
 Default constructor.
virtual ~DtRadioReceiverRepository ()
 Destructor.
 DtRadioReceiverRepository (const DtRadioReceiverRepository &orig)
 Copy constructor.
DtRadioReceiverRepositoryoperator= (const DtRadioReceiverRepository &orig)
 Assignment operator.
virtual DtStateRepositoryclone (bool copy=false) const
 Return a copy/empty object of the same type as this.
virtual void printData () const
 Print the state repository's data to the DtInfo stream.
virtual void printDataToStream (std::ostream &stream) const
 Print the state repository to the specified stream.
virtual void setRadioId (unsigned int number)
 Set/Get the Receiver radio number.
virtual unsigned int radioId () const
 Set/Get the Receiver radio number.
virtual void setReceivedPower (DtFloat32 power)
 Set/Get the received power.
virtual DtFloat32 receivedPower () const
 Set/Get the received power.
virtual void setTransmitRadioId (const DtGlobalObjectDesignator &id)
 Set/Get the received transmitter.
virtual const
DtGlobalObjectDesignator
transmitRadioId () const
 Set/Get the received transmitter.
virtual void setTransmitterId (const DtGlobalObjectDesignator &id)
 Set/Get the transmitter ID.
virtual const
DtGlobalObjectDesignator
transmitterId () const
 Set/Get the transmitter ID.
virtual void setTransmitterRadioId (unsigned int num)
 Set/Get the Transmitter Radio ID - this is only used in DIS.
virtual unsigned int transmitterRadioId () const
 Set/Get the Transmitter Radio ID - this is only used in DIS.
virtual void setReceiverState (DtRadioReceiverState state)
 Set/Get the receiver state.
virtual DtRadioReceiverState receiverState () const
 Set/Get the receiver state.

Static Public Member Functions

static DtRadioReceiverRepositorycreate ()
 Create a DtRadioReceiverRepository.

Protected Attributes

int myReceiverRadioNumber
unsigned int myTransmitterRadioNumber
DtFloat32 myReceivedPower
DtGlobalObjectDesignator myTransmitId
DtRadioReceiverState myReceiverState

Detailed Description

Instances of DtRadioReceiverRepository are used to store state information for radio receiver objects in both HLA and DIS environments.


Constructor & Destructor Documentation

Default constructor.

Destructor.

Copy constructor.


Member Function Documentation

virtual DtStateRepository* DtRadioReceiverRepository::clone ( bool  copy = false) const [virtual]

Return a copy/empty object of the same type as this.

Parameters:
copytells the methods whether to copy the state repository.

Reimplemented from DtEmbeddedSystemRepository.

DtRadioReceiverRepository& DtRadioReceiverRepository::operator= ( const DtRadioReceiverRepository orig)

Assignment operator.

virtual void DtRadioReceiverRepository::printData ( ) const [virtual]

Print the state repository's data to the DtInfo stream.

Reimplemented from DtEmbeddedSystemRepository.

virtual void DtRadioReceiverRepository::printDataToStream ( std::ostream &  stream) const [virtual]

Print the state repository to the specified stream.

Reimplemented from DtEmbeddedSystemRepository.

virtual unsigned int DtRadioReceiverRepository::radioId ( ) const [virtual]

Set/Get the Receiver radio number.

Set/Get the received power.

Set/Get the receiver state.

virtual void DtRadioReceiverRepository::setRadioId ( unsigned int  number) [virtual]

Set/Get the Receiver radio number.

virtual void DtRadioReceiverRepository::setReceivedPower ( DtFloat32  power) [virtual]

Set/Get the received power.

Set/Get the receiver state.

Set/Get the received transmitter.

This function is used for HLA, but DIS calls in the Transmitter Entity so in DIS the identification is the ENtity + the Radio Number.

Deprecated:
The methods, setTransmitterId() and transmitterId() should be used instead.

Set/Get the transmitter ID.

virtual void DtRadioReceiverRepository::setTransmitterRadioId ( unsigned int  num) [virtual]

Set/Get the Transmitter Radio ID - this is only used in DIS.

Set/Get the received transmitter.

This function is used for HLA, but DIS calls in the Transmitter Entity so in DIS the identification is the ENtity + the Radio Number.

Deprecated:
The methods, setTransmitterId() and transmitterId() should be used instead.

Set/Get the transmitter ID.

virtual unsigned int DtRadioReceiverRepository::transmitterRadioId ( ) const [virtual]

Set/Get the Transmitter Radio ID - this is only used in DIS.


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)