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.
DtActiveSonarBeamRepository &	operator= (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 DtStateRepository *	clone (bool copy) const
	Returns a DtActiveSonarBeamRepository.
virtual void	setActiveEmissionParameterIndex (DtUnderwaterAcousticActiveEmissionParmIndex index)
	Sets ActiveEmissionParameterIndex.
virtual DtUnderwaterAcousticActiveEmissionParmIndex	activeEmissionParameterIndex () const
	Returns ActiveEmissionParameterIndex.
virtual void	setActiveSonarIdentifier (const DtGlobalObjectDesignator &id)
	Set/Get Emitting System Id.
virtual const DtGlobalObjectDesignator &	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 DtEventId &	eventIdentifier () 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
DtStateRepository &	operator= (const DtStateRepository &orig)
	assignment operator
virtual void	setGlobalId (const DtString &id)
	Get/Set global identifier, or name.
virtual const DtString &	globalId () const
virtual void	setLocalId (const DtObjectId &id)
	Get/Set local identifier, or handle.
virtual const DtObjectId &	localId () 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< DtString >	stateRepositoryExtensionNames () 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
DtGlobalObjectDesignator	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
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

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 const DtGlobalObjectDesignator& 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

copy	If 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 ( const DtGlobalObjectDesignator &  id )

virtual

Set/Get Emitting System Id.

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

DtGlobalObjectDesignator 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:

• activeSonarBeamRepository.h