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 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 DtVector32 &position)
 Set the position of the object relative to the entity.
virtual const DtVector32relativePosition () const
 Get the position of the object relative to the entity.
- Public Member Functions inherited from DtStateRepository
 DtStateRepository ()
 default constructor
 DtStateRepository (const DtStateRepository &orig)
 copy constructor
virtual ~DtStateRepository ()
 destructor
DtStateRepositoryoperator= (const DtStateRepository &orig)
 assignment operator
virtual void setGlobalId (const DtString &id)
 Get/Set global identifier, or name.
virtual const DtStringglobalId () const
virtual void setLocalId (const DtObjectId &id)
 Get/Set local identifier, or handle.
virtual const DtObjectIdlocalId () const
virtual bool publishesAttribute (const RTI::AttributeHandle &val) const
 Returns true if the attribute is published.
virtual void setAttributeByHandle (const RTI::AttributeHandle &attrHdl, const char *attrValue, unsigned size)
 Set the attribute with the given handle.
virtual const char * getAttributeByHandle (const RTI::AttributeHandle &attrHdl, unsigned &size) const
 Get a pointer to attribute value for the attribute with the given handle.
virtual void setAttributeByName (const DtString &attrName, const char *attrValue, unsigned size, DtHlaObject *hlaObj)
 Set the attribute with the given name. Note that in order to do this you must provide a DtHlaObject.
virtual const char * getAttributeByName (const DtString &attrName, unsigned &size, DtHlaObject *hlaObj) const
 Get a pointer to attribute value for the attribute with the given name.
virtual const char * getAttributeByHandleIfUpdated (const RTI::AttributeHandle &attrHdl, unsigned &size) const
 Get a pointer to attribute value for the attribute with the given handle, but only if it's been updated since the last time we read it.
virtual
DtStateRepositoryExtension
stateRepositoryExtension (DtString srExtName) const
 Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found.
virtual std::vector< DtStringstateRepositoryExtensionNames () const
 Returns a set of the registered state repository extension names.
virtual void setStateRepositoryExtensions (std::map< DtString, DtStateRepositoryExtension * > extensions)
 Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found.
virtual const std::map
< DtString,
DtStateRepositoryExtension * > 
stateRepositoryExtensions () const
 Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found.

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
DtGlobalObjectDesignator myHostId
DtVector32 myRelativePosition

Additional Inherited Members

- Public Types inherited from DtStateRepository
typedef std::map< DtString,
DtStateRepositoryExtension * > 
DtStateRepositoryExtensionMap
- Public Attributes inherited from DtStateRepository
DtString myGlobalId
DtObjectId myLocalId
std::map< RTI::AttributeHandle,
DtGenericAttributeInfo * > 
myAttributesByHandle
 Attributes by handle.
DtStateRepositoryExtensionMap myStateRepositoryExtensionMap
- Static Public Attributes inherited from DtStateRepository
static std::map< DtString,
DtSrExtCreatorFnc
theStateRepositoryExtensionCreatorMap

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.

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 Mon Jun 22 21:18:40 EDT 2020 from SVN revision 213785
Copyright © 2005-2018 MAK Technologies. All Rights Reserved (www.mak.com)