Instances of DtUnderwaterAcousticsPublisher publish underwater acoustic objects to the network. More...

Inheritance diagram for DtUnderwaterAcousticsPublisher:

Collaboration diagram for DtUnderwaterAcousticsPublisher:

Public Types
typedef DtUnderwaterAcousticsStateRepository (	DtStateRepCreator )()
	Function prototype for functions that create DtUnderwaterAcousticsStateRepositories.

Public Member Functions
	DtUnderwaterAcousticsPublisher (DtExerciseConn conn, const char name=0, const DtDDMRegionSet *regionSetToUse=0)
	CTOR.
	DtUnderwaterAcousticsPublisher (DtUnderwaterAcousticsStateRepository stateRepToUse, DtExerciseConn conn, const char name=0, const DtDDMRegionSet regionSetToUse=0)
	CTOR.
virtual	~DtUnderwaterAcousticsPublisher ()
	Virtual DTOR.
virtual DtUnderwaterAcousticsStateRepository *	underwaterAcousticsStateRep ()
	Returns a pointer to the DtUnderwaterAcousticsStateRepository - through which you can set or inspect current state information.
virtual DtUnderwaterAcousticsStateRepository *	usr ()
	Synonym for underwaterAcousticsStateRep().
virtual void	tick ()
	syncBeamList and update beam objects as well as main system object.
virtual void	forceUpdate ()
	if called, at the next tick all attributes will be sent to the RTI This call differs from the base callback by also including a force update of all beam children.
virtual void	forceUpdate (const RTI::AttributeHandleSet &set)
	If the attribute set is specified, forceUpdate will call through to DtObjectPublisher::forceUpdate and the beams children will not be updated.
Public Member Functions inherited from DtObjectPublisher
	DtObjectPublisher (DtExerciseConn conn, DtStateRepository stateRep, DtStateRepository asSeenByRemote, bool okToDeleteStateRep=true, const DtDDMRegionSet regionSet=0)
	Constructor.
virtual	~DtObjectPublisher ()
	Destructor.
virtual void	setHlaObject (const char className, DtHlaStateEncoder encoder=0, DtHlaStateDecoder decoder=0, const char objectName=0, const DtDDMRegionSet *regionSet=0)
	A DtObjectPublisher is not capable of communicating data through the RTI until setHlaObject is called.
virtual void	setHlaObject (RTI::ObjectClassHandle hand, DtHlaStateEncoder encoder=0, DtHlaStateDecoder decoder=0, const char objectName=0, const DtDDMRegionSet regionSet=0)
	This version takes a classHandle and optional object name, and creates the DtHlaObject for you.
virtual void	setHlaObject (DtHlaObjectWithStateRep obj, DtHlaStateEncoder encoder=0, DtHlaStateDecoder *decoder=0)
	This version takes an existing DtHlaObject, and uses it.
virtual void	detachHlaObject ()
	Detach HLA object - bringing the DtObjectPublisher back to the state it was in before setHlaObject was called.
virtual DtStateRepository *	stateRep ()
	Returns a pointer to the DtStateRepository - through which you can set or inspect current state information.
virtual DtStateRepository *	sr ()
	Synonym for stateRep().
virtual DtStateRepository *	approximateRemoteStateRep ()
	Returns a pointer to the approximate remote DtStateRepository – This state repository contains the contents of the last sent message.
virtual DtHlaStateDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode state messages that we send back into the asSeenByRemote SR.
virtual DtHlaStateEncoder *	encoder ()
	Returns a pointer to the Encoder being used to encode current state into an outgoing message.
virtual DtHlaObjectWithStateRep *	hlaObject ()
	Get the object's hlaObject.
virtual DtExerciseConn *	exerciseConn ()
	Get our exercise connection.
virtual const DtObjectId &	id () const
	Get the object's local identifier.
virtual const DtObjectId &	objectId () const
	Get the object's local identifier.
virtual const DtObjectId &	localId () const
	Get the object's local identifier.
virtual const DtString &	name () const
	Get the object's name.
virtual const DtGlobalObjectDesignator &	globalId () const
	Get the HLA object's global object designator - the object name in RTI1.3.3, but the objectId in RTI1.0.3.
virtual void	parallelTick ()
	Tick (update) this object in parallel threads.
virtual void	setDeleteObjInDtorFlag (bool onOff)
	Set/Get a flag that determines whether to try to delete the HLA object that we represent, upon destruction of this DtObjectPublisher.
virtual bool	deleteObjInDtorFlag () const
virtual const DtDDMRegionSet &	publishingRegions () const
virtual void	addRegion (DtDDMRegionSP regionToAdd)
	Adds the specified region to the set of publishing regions, and calls associateRegionForUpdates on the RTI Ambassador.
virtual void	removeRegion (DtDDMRegionSP regionToRemove)
	Removes the specified region from the set of publishing regions, and calls unassociateRegionForUpdates on the RTI Ambassador.
	DtObjectPublisher (DtExerciseConn conn, const char name=0)
	These constructors and init functions are obsolete, but are here for backwards compatibility with pre-3.4 releases.
void	init (RTI::ObjectClassHandle hand, DtStateRepository stateRep, DtStateRepository asSeenByRemote, DtHlaStateEncoder encoder=0, DtHlaStateDecoder decoder=0)
void	init (const char className, DtStateRepository stateRep, DtStateRepository asSeenByRemote, DtHlaStateEncoder encoder=0, DtHlaStateDecoder *decoder=0)

Static Public Member Functions
static DtStateRepCreator	setStateRepCreator (DtStateRepCreator creator)
	Give us a function to be used for creating SRs.
Static Public Member Functions inherited from DtObjectPublisher
static void	removeObjectCb (DtHlaObject obj, void pub)
	Callback to be called when our underlying DtHlaObject goes away.

Protected Member Functions
	DtUnderwaterAcousticsPublisher (const char name=0, const DtDDMRegionSet regionSetToUse=0)
	Constructor which does not include the DtExerciseConn and does not register the HLA object.
	DtUnderwaterAcousticsPublisher (const DtUnderwaterAcousticsPublisher &orig)
	Copy Constructor – not implemented.
DtUnderwaterAcousticsPublisher &	operator= (const DtUnderwaterAcousticsPublisher &orig)
	Assignment operator – not implemented.
Propulsion Noise Management
virtual void	syncPropulsionNoisePublisher ()
Additional Passive Activities Management
virtual void	syncAdditionalPassiveActivitiesList ()
	Update myAdditionalPassiveActivityPubs so that it has a publisher for all active APAs in the overall underwater acoustic state rep.
virtual DtAdditionalPassiveActivitiesPublisher *	publisherForApaSr (DtAdditionalPassiveActivitiesRepository *asr)
	Returns the publisher responsible for publishing the indicated APA SR, NULL if there is none.
virtual int	numAdditionalPassiveActivities () const
	Return number of APA publishers.
Active Sonar Management
virtual void	syncActiveSonarList ()
	Update myActiveSonarPubs so that it has a publisher for all active sonars in the overall underwater acoustic state rep.
virtual DtActiveSonarPublisher *	publisherForSonarSr (DtActiveSonarStateRepository *asr)
	Returns the publisher responsible for publishing the indicated sonar SR, NULL if there is none.
virtual int	numActiveSonars () const
	Return number of sonar publishers.
Protected Member Functions inherited from DtObjectPublisher
	DtObjectPublisher (DtStateRepository stateRep, DtStateRepository asSeenByRemote, bool okToDeleteStateRep=true, const DtDDMRegionSet *regionSet=0)
	Constructor which does not include the DtExerciseConn.
virtual void	setExerciseConn (DtExerciseConn *conn)
	Allows the DtExerciseConn to be set after initial publisher creation.
virtual void	processRemoveObject (DtHlaObject *obj)
	Called by removeObjectCb to detachHlaObject when our underlying DtHlaObject goes away.

Protected Attributes
DtString	myName
unsigned int	myAdditionalPassiveActivityCounter
DtPropulsionNoisePublisher *	myPropulsionNoisePublisher
DtList	myAdditionalPassiveActivityPubs
DtList	myActiveSonarPubs
Protected Attributes inherited from DtObjectPublisher
DtExerciseConn *	myExConn
DtHlaObjectWithStateRep *	myHlaObj
DtStateRepository *	myStateRep
DtStateRepository *	myAsSeenByRemote
DtHlaStateEncoder *	myEncoder
DtHlaStateDecoder *	myDecoder
DtObjectId	myObjectId
bool	myOkToDeleteStateRepFlag
DtString	myName
bool	myDeleteObjInDtorFlag
DtDDMRegionSet	myPublishingRegions

Static Protected Attributes
static DtStateRepCreator	theStateRepCreator

Detailed Description

Instances of DtUnderwaterAcousticsPublisher publish underwater acoustic objects to the network.

Member Typedef Documentation

typedef DtUnderwaterAcousticsStateRepository*(* DtUnderwaterAcousticsPublisher::DtStateRepCreator)()

Function prototype for functions that create DtUnderwaterAcousticsStateRepositories.

Constructor & Destructor Documentation

DtUnderwaterAcousticsPublisher::DtUnderwaterAcousticsPublisher	(	DtExerciseConn *	conn,
		const char *	name = `0`,
		const DtDDMRegionSet *	regionSetToUse = `0`
	)

CTOR.

DtUnderwaterAcousticsPublisher::DtUnderwaterAcousticsPublisher	(	DtUnderwaterAcousticsStateRepository *	stateRepToUse,
		DtExerciseConn *	conn,
		const char *	name = `0`,
		const DtDDMRegionSet *	regionSetToUse = `0`
	)

CTOR.

virtual DtUnderwaterAcousticsPublisher::~DtUnderwaterAcousticsPublisher ( )

virtual

Virtual DTOR.

DtUnderwaterAcousticsPublisher::DtUnderwaterAcousticsPublisher	(	const char *	name = `0`,
		const DtDDMRegionSet *	regionSetToUse = `0`
	)

protected

Constructor which does not include the DtExerciseConn and does not register the HLA object.

This is typically not desired, but may be useful in certain cases when a derived publisher wants to better control how the object is published.

DtUnderwaterAcousticsPublisher::DtUnderwaterAcousticsPublisher ( const DtUnderwaterAcousticsPublisher & orig )

protected

Copy Constructor – not implemented.

Member Function Documentation

virtual void DtUnderwaterAcousticsPublisher::forceUpdate ( )

virtual

if called, at the next tick all attributes will be sent to the RTI This call differs from the base callback by also including a force update of all beam children.

Reimplemented from DtObjectPublisher.

virtual void DtUnderwaterAcousticsPublisher::forceUpdate ( const RTI::AttributeHandleSet & set )

virtual

If the attribute set is specified, forceUpdate will call through to DtObjectPublisher::forceUpdate and the beams children will not be updated.

This function is added to prevent it from being hidden

Reimplemented from DtObjectPublisher.

virtual int DtUnderwaterAcousticsPublisher::numActiveSonars ( ) const

protectedvirtual

Return number of sonar publishers.

virtual int DtUnderwaterAcousticsPublisher::numAdditionalPassiveActivities ( ) const

protectedvirtual

Return number of APA publishers.

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

protected

Assignment operator – not implemented.

virtual DtAdditionalPassiveActivitiesPublisher* DtUnderwaterAcousticsPublisher::publisherForApaSr ( DtAdditionalPassiveActivitiesRepository * asr )

protectedvirtual

Returns the publisher responsible for publishing the indicated APA SR, NULL if there is none.

virtual DtActiveSonarPublisher* DtUnderwaterAcousticsPublisher::publisherForSonarSr ( DtActiveSonarStateRepository * asr )

protectedvirtual

Returns the publisher responsible for publishing the indicated sonar SR, NULL if there is none.

static DtStateRepCreator DtUnderwaterAcousticsPublisher::setStateRepCreator ( DtStateRepCreator creator )

static

Give us a function to be used for creating SRs.

virtual void DtUnderwaterAcousticsPublisher::syncActiveSonarList ( )

protectedvirtual

Update myActiveSonarPubs so that it has a publisher for all active sonars in the overall underwater acoustic state rep.

Called by tick() so that all active sonar publishers can be ticked after the underwater acoustic state rep has been updated.

virtual void DtUnderwaterAcousticsPublisher::syncAdditionalPassiveActivitiesList ( )

protectedvirtual

Update myAdditionalPassiveActivityPubs so that it has a publisher for all active APAs in the overall underwater acoustic state rep.

Called by tick() so that all APA publishers can be ticked after the underwater acoustic state rep has been updated.

virtual void DtUnderwaterAcousticsPublisher::syncPropulsionNoisePublisher ( )

protectedvirtual

virtual void DtUnderwaterAcousticsPublisher::tick ( )

virtual

syncBeamList and update beam objects as well as main system object.

Reimplemented from DtObjectPublisher.

DtUnderwaterAcousticsStateRepository * DtUnderwaterAcousticsPublisher::underwaterAcousticsStateRep ( )

inlinevirtual

Returns a pointer to the DtUnderwaterAcousticsStateRepository - through which you can set or inspect current state information.

References DtObjectPublisher::myStateRep.

DtUnderwaterAcousticsStateRepository * DtUnderwaterAcousticsPublisher::usr ( )

inlinevirtual

Synonym for underwaterAcousticsStateRep().

References DtObjectPublisher::myStateRep.

Member Data Documentation

DtList DtUnderwaterAcousticsPublisher::myActiveSonarPubs

protected

unsigned int DtUnderwaterAcousticsPublisher::myAdditionalPassiveActivityCounter

protected

DtList DtUnderwaterAcousticsPublisher::myAdditionalPassiveActivityPubs

protected

DtString DtUnderwaterAcousticsPublisher::myName

protected

DtPropulsionNoisePublisher* DtUnderwaterAcousticsPublisher::myPropulsionNoisePublisher

protected

DtStateRepCreator DtUnderwaterAcousticsPublisher::theStateRepCreator

staticprotected

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

underwaterAcousticsPublisherHLA.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation