DtAdditionalPassiveActivitiesPublisher Class Reference

Instances of DtAdditionalPassiveActivitiesPublisher are used to take care of the details associated with publishing the state of an active sonar. More...

Inheritance diagram for DtAdditionalPassiveActivitiesPublisher:

Collaboration diagram for DtAdditionalPassiveActivitiesPublisher:

Public Types
typedef DtAdditionalPassiveActivitiesRepository *(*	DtStateRepCreator )()
	Function prototype for functions that create DtAdditionalPassiveActivitiesRepositories.

Public Member Functions
	DtAdditionalPassiveActivitiesPublisher (DtAdditionalPassiveActivitiesRepository *stateRepToUse, DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	CTOR.
	DtAdditionalPassiveActivitiesPublisher (DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	CTOR.
	DtAdditionalPassiveActivitiesPublisher (DtExerciseConn *conn, const char *name, const DtObjectId &id=DtObjectId::defaultId())
	CTOR.
virtual	~DtAdditionalPassiveActivitiesPublisher ()
	Virtual DTOR.
virtual DtAdditionalPassiveActivitiesRepository *	apaStateRep ()
	Get the active sonar state repository for this active sonar publisher.
virtual DtAdditionalPassiveActivitiesRepository *	asr ()
virtual void	tick ()
	Tick the publisher.
virtual void	forceUpdate ()
	force a pdu to be sent on the next tick call, even if it is not needed.
virtual const DtObjectId &	id () const
	Get the entity's identifier.
virtual const DtObjectId &	localId () const
	The localId is the same as the globalId, a DtEntityIdentifier unique to this object.
virtual const DtGlobalObjectDesignator &	globalId () const
	Get the global object designator - same as id for DIS.
Public Member Functions inherited from DtObjectPublisher
	DtObjectPublisher (DtExerciseConn *conn, DtStateRepository *stateRep, DtStateRepository *asSeenByRemote, bool okToDeleteStateRep=true)
	Constructor takes an DtExerciseConn which must have a lifetime greater than the ObjectPubliser.
virtual	~DtObjectPublisher ()
	Destructor.
virtual DtStateRepository *	stateRep ()
	Returns a pointer to the DtStateRepository - through which you can set or inspect current state information.
virtual DtStateRepository *	sr ()
	Returns a pointer to the DtStateRepository - through which you can set or inspect current state information.
virtual DtExerciseConn *	exerciseConn ()
	Get our exercise connection.
virtual void	setTimeThreshold (DtTime time)
	Set the heartbeat rate for this object.
virtual DtTime	timeThreshold () const
	The heartbeat rate for this object.
virtual DtStateRepository *	approximateRemoteStateRep ()
	Returns a pointer to the approximate remote DtStateRepository – This state repository contains the contents of the last sent message.
virtual DtTime	lastTimeUpdated () const
	Returns the value of wallclock time at the time an update was last received for the entity.
virtual DtTime	lastSimTimeUpdated () const
	Returns the value of sim time at the time an update was last received for the entity.

Static Public Member Functions
static void	setStateRepCreator (DtStateRepCreator creator)
	Give us a function to be used for creating SRs.
static DtStateRepCreator	stateRepCreator ()
static void	setClassDfltTimeThreshold (DtTime threshold)
Static Public Member Functions inherited from DtObjectPublisher
static void	setDfltTimeThreshold (DtTime time)
	Set the default heartbeat rate.
static DtTime	dfltTimeThreshold ()
	The default heartbeat rate, see setDfltTimeThreshold().

Protected Member Functions
void	init (const char *name, const DtEntityIdentifier &id)
	Not virtual since called from constructor.
	DtAdditionalPassiveActivitiesPublisher (const DtAdditionalPassiveActivitiesPublisher &orig)
	copy constructor – Not Implemented
DtAdditionalPassiveActivitiesPublisher &	operator= (const DtAdditionalPassiveActivitiesPublisher &orig)
	assignment operator – Not Implemented
Protected Member Functions inherited from DtObjectPublisher
void	send (DtPdu *pdu) const
	Puts the PDU on the network and updates timestamps.

Protected Attributes
DtObjectId	myId
DtAdditionalPassiveActivitiesDecoder *	myAdditionalPassiveActivitiesDecoder
DtAdditionalPassiveActivitiesEncoder *	myAdditionalPassiveActivitiesEncoder
char *	myName
Protected Attributes inherited from DtObjectPublisher
DtExerciseConn *	myExConn
DtStateRepository *	myStateRep
DtStateRepository *	myAsSeenByRemote
bool	myOkToDeleteStateRepFlag
DtTime	myTimeThreshold
DtTime	mySimTimeLastUpdate
	Set in const send() method.
DtTime	myRealTimeLastUpdate
	Set in const send() method.

Static Protected Attributes
static DtStateRepCreator	theStateRepCreator
static DtTime	theClassDfltTimeThreshold
static bool	theClassDfltIsSetFlag
Static Protected Attributes inherited from DtObjectPublisher
static DtTime	theDfltTimeThreshold

Detailed Description

Instances of DtAdditionalPassiveActivitiesPublisher are used to take care of the details associated with publishing the state of an active sonar.

Member Typedef Documentation

typedef DtAdditionalPassiveActivitiesRepository*(* DtAdditionalPassiveActivitiesPublisher::DtStateRepCreator)()

Function prototype for functions that create DtAdditionalPassiveActivitiesRepositories.

Constructor & Destructor Documentation

DtAdditionalPassiveActivitiesPublisher::DtAdditionalPassiveActivitiesPublisher	(	DtAdditionalPassiveActivitiesRepository *	stateRepToUse,
		DtExerciseConn *	conn,
		const DtObjectId &	id = DtObjectId::defaultId()
	)

CTOR.

DtAdditionalPassiveActivitiesPublisher::DtAdditionalPassiveActivitiesPublisher	(	DtExerciseConn *	conn,
		const DtObjectId &	id = DtObjectId::defaultId()
	)

CTOR.

DtAdditionalPassiveActivitiesPublisher::DtAdditionalPassiveActivitiesPublisher	(	DtExerciseConn *	conn,
		const char *	name,
		const DtObjectId &	id = DtObjectId::defaultId()
	)

CTOR.

virtual DtAdditionalPassiveActivitiesPublisher::~DtAdditionalPassiveActivitiesPublisher ( )

virtual

Virtual DTOR.

DtAdditionalPassiveActivitiesPublisher::DtAdditionalPassiveActivitiesPublisher ( const DtAdditionalPassiveActivitiesPublisher &  orig )

protected

copy constructor – Not Implemented

Member Function Documentation

virtual DtAdditionalPassiveActivitiesRepository* DtAdditionalPassiveActivitiesPublisher::apaStateRep ( )

virtual

Get the active sonar state repository for this active sonar publisher.

DtAdditionalPassiveActivitiesRepository * DtAdditionalPassiveActivitiesPublisher::asr ( )

inlinevirtual

References DtObjectPublisher::myStateRep.

virtual void DtAdditionalPassiveActivitiesPublisher::forceUpdate ( )

virtual

force a pdu to be sent on the next tick call, even if it is not needed.

Implements DtObjectPublisher.

virtual const DtGlobalObjectDesignator& DtAdditionalPassiveActivitiesPublisher::globalId ( ) const

virtual

Get the global object designator - same as id for DIS.

Implements DtObjectPublisher.

virtual const DtObjectId& DtAdditionalPassiveActivitiesPublisher::id ( ) const

virtual

Get the entity's identifier.

Implements DtObjectPublisher.

void DtAdditionalPassiveActivitiesPublisher::init ( const char *  name, const DtEntityIdentifier &  id  )

protected

Not virtual since called from constructor.

virtual const DtObjectId& DtAdditionalPassiveActivitiesPublisher::localId ( ) const

virtual

The localId is the same as the globalId, a DtEntityIdentifier unique to this object.

Implements DtObjectPublisher.

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

protected

assignment operator – Not Implemented

static void DtAdditionalPassiveActivitiesPublisher::setClassDfltTimeThreshold ( DtTime  threshold )

static

static void DtAdditionalPassiveActivitiesPublisher::setStateRepCreator ( DtStateRepCreator  creator )

static

Give us a function to be used for creating SRs.

static DtStateRepCreator DtAdditionalPassiveActivitiesPublisher::stateRepCreator ( )

static

virtual void DtAdditionalPassiveActivitiesPublisher::tick ( )

virtual

Tick the publisher.

Implements DtObjectPublisher.

Member Data Documentation

DtAdditionalPassiveActivitiesDecoder* DtAdditionalPassiveActivitiesPublisher::myAdditionalPassiveActivitiesDecoder

protected

DtAdditionalPassiveActivitiesEncoder* DtAdditionalPassiveActivitiesPublisher::myAdditionalPassiveActivitiesEncoder

protected

DtObjectId DtAdditionalPassiveActivitiesPublisher::myId

protected

char* DtAdditionalPassiveActivitiesPublisher::myName

protected

bool DtAdditionalPassiveActivitiesPublisher::theClassDfltIsSetFlag

staticprotected

DtTime DtAdditionalPassiveActivitiesPublisher::theClassDfltTimeThreshold

staticprotected

DtStateRepCreator DtAdditionalPassiveActivitiesPublisher::theStateRepCreator

staticprotected

---

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

• dAddPassActPub.h