VR-Link API Documentation for DIS
List of all members | 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:

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.
- Public Member Functions inherited from DtEmbeddedSystemRepository
 DtEmbeddedSystemRepository ()
 default constructor
 DtEmbeddedSystemRepository (const DtEmbeddedSystemRepository &orig)
 copy constructor
virtual ~DtEmbeddedSystemRepository ()
 destructor
DtEmbeddedSystemRepositoryoperator= (const DtEmbeddedSystemRepository &orig)
 assignment operator
virtual void setEntityId (const DtEntityIdentifier &id)
 Set the entity identifier.
virtual const DtEntityIdentifierentityId () const
 Get the entity identifier.
virtual void setHostId (const DtGlobalObjectDesignator &id)
 Set the host identifier.
virtual const
DtGlobalObjectDesignator
hostId () const
 Get the host identifier.
virtual void setRelativePosition (const DtVector &position)
 Set the position of the object relative to the entity.
virtual const DtVectorrelativePosition () const
 Get the position of the object relative to the entity.
- Public Member Functions inherited from DtStateRepository
virtual ~DtStateRepository ()
 destructor
DtStateRepositoryoperator= (const DtStateRepository &orig)
 assignment operator
virtual void setGlobalId (const DtGlobalObjectDesignator &id)
 Get/Set global identifier, or name.
virtual const
DtGlobalObjectDesignator
globalId () const
virtual void setAttributeRecords (const std::vector< DtStandardVariableRecord * > &records)
 Get/Set records.
virtual const std::vector
< DtStandardVariableRecord * > 
attributeRecords (unsigned int recordType=0) const
virtual void getAttributeRecords (std::vector< DtStandardVariableRecord * > &vec, unsigned int recordType=0) const
virtual void addAttributeRecord (DtStandardVariableRecord *record)
virtual void clearAttributeRecords ()
virtual void setAttributeRecords (const std::vector< DtStandardVariableRecord * > &records, const DtSimulationAddress &address)
virtual void setSimAddr (const DtSimulationAddress &id)
 Get/Set default simulation address. Set by VR-Link for publishers (based on exercise connection)
virtual const DtSimulationAddresssimAddr () const

Static Public Member Functions

static DtRadioReceiverRepositorycreate ()
 Create a DtRadioReceiverRepository.

Protected Attributes

int myReceiverRadioNumber
unsigned int myTransmitterRadioNumber
DtFloat32 myReceivedPower
DtGlobalObjectDesignator myTransmitId
DtRadioReceiverState myReceiverState
- Protected Attributes inherited from DtEmbeddedSystemRepository
DtEntityIdentifier myEntityId
DtVector myRelativePosition
- Protected Attributes inherited from DtStateRepository
DtGlobalObjectDesignator myGlobalId
DtSimulationAddress myDefaultSimulationAddress
std::map< DtSimulationAddress,
std::vector
< DtStandardVariableRecord * > > 
myRecordsMap

Additional Inherited Members

- Protected Member Functions inherited from DtStateRepository
 DtStateRepository ()
 Constructors are protected since this is an abstract base class.
 DtStateRepository (const DtStateRepository &orig)
 copy constructor
virtual unsigned int numberOfAttributeRecords () const

Detailed Description

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

Constructor & Destructor Documentation

DtRadioReceiverRepository::DtRadioReceiverRepository ( )

Default constructor.

virtual DtRadioReceiverRepository::~DtRadioReceiverRepository ( )
virtual

Destructor.

DtRadioReceiverRepository::DtRadioReceiverRepository ( const DtRadioReceiverRepository orig)

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.

static DtRadioReceiverRepository* DtRadioReceiverRepository::create ( )
static
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.

Referenced by DtReflectedRadioReceiver::radioId().

virtual DtFloat32 DtRadioReceiverRepository::receivedPower ( ) const
virtual

Set/Get the received power.

virtual DtRadioReceiverState DtRadioReceiverRepository::receiverState ( ) const
virtual

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.

virtual void DtRadioReceiverRepository::setReceiverState ( DtRadioReceiverState  state)
virtual

Set/Get the receiver state.

virtual void DtRadioReceiverRepository::setTransmitRadioId ( const DtGlobalObjectDesignator id)
virtual

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.
virtual void DtRadioReceiverRepository::setTransmitterId ( const DtGlobalObjectDesignator id)
virtual

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.

virtual const DtGlobalObjectDesignator& DtRadioReceiverRepository::transmitRadioId ( ) const
virtual

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.
virtual const DtGlobalObjectDesignator& DtRadioReceiverRepository::transmitterId ( ) const
virtual

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

DtFloat32 DtRadioReceiverRepository::myReceivedPower
protected
int DtRadioReceiverRepository::myReceiverRadioNumber
protected
DtRadioReceiverState DtRadioReceiverRepository::myReceiverState
protected
DtGlobalObjectDesignator DtRadioReceiverRepository::myTransmitId
protected
unsigned int DtRadioReceiverRepository::myTransmitterRadioNumber
protected

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

Document ID: Generated on Wed Oct 23 22:25:48 EDT 2013 from SVN revision 132765
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)