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

The DtActiveSonarBeamRepository class provides the state repository for the ActiveSonarBeam object. More...

+ Inheritance diagram for DtActiveSonarBeamRepository:
+ Collaboration diagram for DtActiveSonarBeamRepository:

Public Member Functions

 DtActiveSonarBeamRepository ()
 Default constructor.
virtual ~DtActiveSonarBeamRepository ()
 Destructor.
 DtActiveSonarBeamRepository (const DtActiveSonarBeamRepository &orig)
 Copy constructor.
DtActiveSonarBeamRepositoryoperator= (const DtActiveSonarBeamRepository &orig)
 Assignment operator.
void printData () const
 Prints the state repository's data to DtInfo.
void printDataToStream (std::ostream &stream) const
 Prints the state repository's data to the specified stream.
virtual DtStateRepositoryclone (bool copy) const
 Returns a DtActiveSonarBeamRepository.
virtual void setActiveEmissionParameterIndex (DtUnderwaterAcousticActiveEmissionParmIndex index)
 Sets ActiveEmissionParameterIndex.
virtual
DtUnderwaterAcousticActiveEmissionParmIndex 
activeEmissionParameterIndex () const
 Returns ActiveEmissionParameterIndex.
virtual void setActiveSonarIdentifier (int id)
 Set/Get Emitting System Id.
virtual int activeSonarIdentifier () const
virtual void setAzimuthBeamwidth (DtFloat32 beamwidth)
 Sets AzimuthBeamwidth.
virtual DtFloat32 azimuthBeamwidth () const
 Returns AzimuthBeamwidth.
virtual void setAzimuthCenter (DtFloat32 azCenter)
 Sets AzimuthCenter.
virtual DtFloat32 azimuthCenter () const
 Returns AzimuthCenter.
virtual void setBeamIdentifier (DtU8 id)
 Sets BeamIdentifier.
virtual DtU8 beamIdentifier () const
 Returns BeamIdentifier.
virtual void setElevationBeamwidth (DtFloat32 beamwidth)
 Sets ElevationBeamwidth.
virtual DtFloat32 elevationBeamwidth () const
 Returns ElevationBeamwidth.
virtual void setElevationCenter (DtFloat32 elCenter)
 Sets ElevationCenter.
virtual DtFloat32 elevationCenter () const
 Returns ElevationCenter.
virtual void setEventIdentifier (const DtEventId &id)
 Sets EventIdentifier.
virtual const DtEventIdeventIdentifier () const
 Returns EventIdentifier.
virtual void setScanPattern (DtUnderwaterAcousticScanPattern pattern)
 Sets ScanPattern.
virtual
DtUnderwaterAcousticScanPattern 
scanPattern () const
 Returns ScanPattern.
- 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 DtGlobalObjectDesignator &id)
 Get/Set global identifier, or name.
virtual const
DtGlobalObjectDesignator
globalId () const
virtual unsigned int numberOfAttributeRecords () const
virtual void setAttributeRecords (const DtAttributeRecordSet &records)
 The following functions are related to the extendability part of DIS 7.
virtual void setAttributeRecords (const DtStandardVariableRecordPtrVector &records)
 Replace the attribute record set with the records in the given vector.
virtual const
DtAttributeRecordSet
attributeRecordSet () const
 Return the attribute record set.
virtual DtAttributeRecordSetattributeRecordSet ()
 Return the attribute record set.
virtual const
DtStandardVariableRecordPtrVector
attributeRecords () const
 Return the attribute records Any changes to the returned record(s) will modify the records in the recordSet.
virtual const
DtStandardVariableRecordPtrVector
attributeRecords (unsigned int recordType) const
 Return the attribute records of the given type (all records if type is 0) Any changes to the returned record(s) will modify the records in the recordSet.
virtual DtStandardVariableRecordattributeRecord (unsigned int recordType) const
 Return the (first) attribute record of the given type (first record if type is 0) Any changes to the returned record will modify the record in the recordSet.
virtual int removeAttributeRecord (unsigned int recordType, bool removeAll=true)
 Remove and discard the first record of the given record type (if there is one) or all them.
virtual
DtStandardVariableRecordPtrVector
getAttributeRecords (unsigned int recordType, DtStandardVariableRecordPtrVector &vec) const
 Get the attribute records of the given type (all if type is 0) Any changes to the returned record(s) will modify the records in the recordSet.
virtual
DtStandardVariableRecordPtrVector
getAttributeRecords (DtStandardVariableRecordPtrVector &vec) const
 Get the attribute records Any changes to the returned record(s) will modify the records in the recordSet.
virtual void addAttributeRecord (DtStandardVariableRecord *record)
 Add a clone of given record to the attribute record set.
virtual void addAttributeRecord (std::auto_ptr< DtStandardVariableRecord > record)
 Add the given record to the attribute record set.
virtual void clearAttributeRecords ()
 Clear all records.
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
DtActiveSonarBeamRepository
create ()
 Static method creates a new DtActiveSonarBeamRepository.
- Static Public Member Functions inherited from DtStateRepository
static bool addStateRepositoryExtension (DtString srExtName, DtSrExtCreatorFnc fnc)
 The following functions are for extending state repositories through State Repository Extension classes.

Protected Attributes

DtUnderwaterAcousticActiveEmissionParmIndex myActiveEmissionParameterIndex
DtU8 myActiveSonarIdentifier
DtFloat32 myAzimuthBeamwidth
DtFloat32 myAzimuthCenter
DtU8 myBeamIdentifier
DtFloat32 myElevationBeamwidth
DtFloat32 myElevationCenter
DtEventId myEventIdentifier
DtUnderwaterAcousticScanPattern myScanPattern

Additional Inherited Members

- Public Types inherited from DtStateRepository
typedef std::map< DtString,
DtStateRepositoryExtension * > 
DtStateRepositoryExtensionMap
- Public Attributes inherited from DtStateRepository
DtGlobalObjectDesignator myGlobalId
DtAttributeRecordSet myAttributeRecords
DtStandardVariableRecordPtrVector myReturnedRecords
DtStateRepositoryExtensionMap myStateRepositoryExtensionMap
- Static Public Attributes inherited from DtStateRepository
static std::map< DtString,
DtSrExtCreatorFnc
theStateRepositoryExtensionCreatorMap

Detailed Description

The DtActiveSonarBeamRepository class provides the state repository for the ActiveSonarBeam object.

Constructor & Destructor Documentation

DtActiveSonarBeamRepository::DtActiveSonarBeamRepository ( )

Default constructor.

virtual DtActiveSonarBeamRepository::~DtActiveSonarBeamRepository ( )
virtual

Destructor.

DtActiveSonarBeamRepository::DtActiveSonarBeamRepository ( const DtActiveSonarBeamRepository orig)

Copy constructor.

Member Function Documentation

virtual DtUnderwaterAcousticActiveEmissionParmIndex DtActiveSonarBeamRepository::activeEmissionParameterIndex ( ) const
virtual

Returns ActiveEmissionParameterIndex.

virtual int DtActiveSonarBeamRepository::activeSonarIdentifier ( ) const
virtual
virtual DtFloat32 DtActiveSonarBeamRepository::azimuthBeamwidth ( ) const
virtual

Returns AzimuthBeamwidth.

virtual DtFloat32 DtActiveSonarBeamRepository::azimuthCenter ( ) const
virtual

Returns AzimuthCenter.

virtual DtU8 DtActiveSonarBeamRepository::beamIdentifier ( ) const
virtual

Returns BeamIdentifier.

virtual DtStateRepository* DtActiveSonarBeamRepository::clone ( bool  copy) const
virtual

Returns a DtActiveSonarBeamRepository.

Parameters
copyIf copy is set to true, a copy of the state repository will be returned

Reimplemented from DtStateRepository.

static DtActiveSonarBeamRepository* DtActiveSonarBeamRepository::create ( )
static

Static method creates a new DtActiveSonarBeamRepository.

virtual DtFloat32 DtActiveSonarBeamRepository::elevationBeamwidth ( ) const
virtual

Returns ElevationBeamwidth.

virtual DtFloat32 DtActiveSonarBeamRepository::elevationCenter ( ) const
virtual

Returns ElevationCenter.

virtual const DtEventId& DtActiveSonarBeamRepository::eventIdentifier ( ) const
virtual

Returns EventIdentifier.

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

Assignment operator.

void DtActiveSonarBeamRepository::printData ( ) const
virtual

Prints the state repository's data to DtInfo.

Reimplemented from DtStateRepository.

void DtActiveSonarBeamRepository::printDataToStream ( std::ostream &  stream) const
virtual

Prints the state repository's data to the specified stream.

Reimplemented from DtStateRepository.

virtual DtUnderwaterAcousticScanPattern DtActiveSonarBeamRepository::scanPattern ( ) const
virtual

Returns ScanPattern.

virtual void DtActiveSonarBeamRepository::setActiveEmissionParameterIndex ( DtUnderwaterAcousticActiveEmissionParmIndex  index)
virtual

Sets ActiveEmissionParameterIndex.

virtual void DtActiveSonarBeamRepository::setActiveSonarIdentifier ( int  id)
virtual

Set/Get Emitting System Id.

On DIS, the EmittingSystemID is the EmitterSystem Number. This is NOT stored in the PDU, But is filled in for reflected objects. For Outgoing PDUs VR_Link only publishes one EmittingSystem per PDU. Incoming may receive PDUs with multiple systems.

virtual void DtActiveSonarBeamRepository::setAzimuthBeamwidth ( DtFloat32  beamwidth)
virtual

Sets AzimuthBeamwidth.

virtual void DtActiveSonarBeamRepository::setAzimuthCenter ( DtFloat32  azCenter)
virtual

Sets AzimuthCenter.

virtual void DtActiveSonarBeamRepository::setBeamIdentifier ( DtU8  id)
virtual

Sets BeamIdentifier.

virtual void DtActiveSonarBeamRepository::setElevationBeamwidth ( DtFloat32  beamwidth)
virtual

Sets ElevationBeamwidth.

virtual void DtActiveSonarBeamRepository::setElevationCenter ( DtFloat32  elCenter)
virtual

Sets ElevationCenter.

virtual void DtActiveSonarBeamRepository::setEventIdentifier ( const DtEventId id)
virtual

Sets EventIdentifier.

virtual void DtActiveSonarBeamRepository::setScanPattern ( DtUnderwaterAcousticScanPattern  pattern)
virtual

Sets ScanPattern.

Member Data Documentation

DtUnderwaterAcousticActiveEmissionParmIndex DtActiveSonarBeamRepository::myActiveEmissionParameterIndex
protected
DtU8 DtActiveSonarBeamRepository::myActiveSonarIdentifier
protected
DtFloat32 DtActiveSonarBeamRepository::myAzimuthBeamwidth
protected
DtFloat32 DtActiveSonarBeamRepository::myAzimuthCenter
protected
DtU8 DtActiveSonarBeamRepository::myBeamIdentifier
protected
DtFloat32 DtActiveSonarBeamRepository::myElevationBeamwidth
protected
DtFloat32 DtActiveSonarBeamRepository::myElevationCenter
protected
DtEventId DtActiveSonarBeamRepository::myEventIdentifier
protected
DtUnderwaterAcousticScanPattern DtActiveSonarBeamRepository::myScanPattern
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)