DtWindCorridorPublisher Class Reference

Instances of DtWindCorridorPublisher publish METOC_Root.EnvironmentCondition.Weather.WindCorridor.WindCorridor objects to the network. More...

Inheritance diagram for DtWindCorridorPublisher:

Collaboration diagram for DtWindCorridorPublisher:

Public Types
typedef DtWindCorridorStateRepository *(*	DtStateRepCreator )()
	Function prototype for a function that creates a DtWindCorridorStateRepository. More...
Public Types inherited from DtObjectPublisher
typedef DtAttributePdu *(*	DtNonCoupledAttributePduCreator )(const DtPduWithAttributeRecordSets *, void *)
	Function prototype for functions that create DtAggregateStateRepositories. More...

Public Member Functions
	DtWindCorridorPublisher (DtWindCorridorStateRepository *stateRepToUse, DtExerciseConn *conn, const DtObjectId &id=DtObjectId::nullId())
	Constructor. More...
	DtWindCorridorPublisher (DtExerciseConn *conn, const DtObjectId &id=DtObjectId::nullId())
	Constructor. More...
virtual	~DtWindCorridorPublisher ()
	Destructor. More...
virtual DtWindCorridorStateRepository *	windCorridorLayerStateRep ()
	Returns a pointer to the DtWindCorridorStateRepository - through which you can set or inspect current state information. More...
virtual DtWindCorridorStateRepository *	wsr ()
	Synonym for windCorridorLayerStateRep(). More...
virtual bool	tick ()
	tick the publisher More...
virtual void	forceUpdate ()
	for the next tick call to send out a PDU even if it is not needed. More...
virtual const DtObjectId &	id () const
	Get the entity's identifier. More...
virtual const DtObjectId &	localId () const
	Get the entity's localId - same as id for DIS. More...
virtual const DtGlobalObjectDesignator &	globalId () const
	Get the global object designator - same as id for DIS. More...
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. More...
virtual	~DtObjectPublisher ()
	Destructor. More...
virtual DtStateRepository *	stateRep ()
	Returns a pointer to the DtStateRepository - through which you can set or inspect current state information. More...
virtual DtStateRepository *	sr ()
	Returns a pointer to the DtStateRepository - through which you can set or inspect current state information. More...
virtual DtExerciseConn *	exerciseConn ()
	Get our exercise connection. More...
virtual bool	parallelTick ()
	Tick (update) this object in parallel threads. More...
virtual void	setTimeThreshold (DtTime time)
	Set the heartbeat rate for this object. More...
virtual DtTime	timeThreshold () const
	The heartbeat rate for this object. More...
virtual void	setRelLocTimeThreshold (DtTime time)
	Set the heartbeat rate of relative location updates for this object. More...
virtual DtTime	relLocTimeThreshold () const
	The relative location heartbeat rate for this object. More...
virtual DtStateRepository *	approximateRemoteStateRep ()
	Returns a pointer to the approximate remote DtStateRepository – This state repository contains the contents of the last sent message. More...
virtual DtTime	lastTimeUpdated () const
	Returns the value of wallclock time at the time an update was last received for the entity. More...
virtual DtTime	lastTimeAttrUpdated () const
virtual DtTime	lastSimTimeUpdated () const
	Returns the value of sim time at the time an update was last received for the entity. More...
virtual void	setUseCustomThreshold (bool useCustom)
	Sets whether or not this object will use a custom threshold value, or the default. More...
virtual bool	useCustomThreshold ()
	Returns whether or not this object will use a custom threshold value, or the default. More...
virtual void	setAttributePduStrategy (DtAttributePduStrategy strat)
	Sets/Gets whether to couple the attribute PDU. More...
virtual DtAttributePduStrategy	attributePduStrategy () const
virtual void	encodeExtensions (DtStateRepository *stateRep, const DtStateRepository &asSeenByRemote)
	Encode State Repository Extensions. Extensions should be added to stateRep attributeRecords. More...
virtual void	decodeExtensions (DtPdu *pdu, const DtStateRepository &stateRep)
	Decode State Repository Extensions. More...
virtual void	setUpdateRateWarningThreshold (unsigned short updatesPerSecond)
	Overrides the default (static) updates per second for a specific instance Sets/Gets for private member. More...
virtual unsigned short	updateRateWarningThreshold () const
virtual void	checkForUpdateRateWarning () const
	Helper function that determines whether or not to trigger a spam warning. More...
DtNonCoupledAttributePduCreator	setNonCoupledAttributePduCreator (DtNonCoupledAttributePduCreator creator)
	Give us a function to be used for creating non-coupled Attribute PDUs. More...
DtNonCoupledAttributePduCreator	nonCoupledAttributePduCreator (void)

Static Public Member Functions
static DtStateRepCreator	setStateRepCreator (DtStateRepCreator creator)
	Give us a function to be used for creating SRs. More...
Static Public Member Functions inherited from DtObjectPublisher
static void	setDfltTimeThreshold (DtTime time)
	Set the default heartbeat rate. More...
static DtTime	dfltTimeThreshold ()
	The default heartbeat rate, see setDfltTimeThreshold(). More...
static void	setDfltUpdateRateWarningThreshold (unsigned short updatesPerSecond)
	Sets the default (static) updates per second for any instance. More...
static unsigned short	dfltUpdateRateWarningThreshold ()
	Return the value of theDfltUpdateRateWarningThreshold. More...
static void	setDfltRelLocTimeThreshold (DtTime time)
	Set the default heartbeat rate for relative location updates. More...
static DtTime	dfltRelLocTimeThreshold ()
	The default heartbeat rate for relative location updates, see setDfltRelLocTimeThreshold() More...
static DtNonCoupledAttributePduCreator	setDefaultNonCoupledAttributePduCreator (DtNonCoupledAttributePduCreator creator)
	Give us a function to be used for creating non-coupled Attribute PDUs. More...
static DtNonCoupledAttributePduCreator	defaultNonCoupledAttributePduCreator (void)

Protected Member Functions
void	sendFinalPdu ()
	Not virtual since called from destructor. Sends a final PDU for this runway. More...
Protected Member Functions inherited from DtObjectPublisher
virtual void	send (DtPdu *pdu) const
	Puts the PDU on the network and updates timestamps. More...

Protected Attributes
DtObjectId	myId
DtWindCorridorDecoder *	myDecoder
DtWindCorridorEncoder *	myEncoder
Protected Attributes inherited from DtObjectPublisher
DtExerciseConn *	myExConn
DtStateRepository *	myStateRep
DtStateRepository *	myAsSeenByRemote
bool	myOkToDeleteStateRepFlag
bool	myUseCustomThreshold
DtTime	myTimeThreshold
	Time threshold for the heartbeat rate. More...
DtTime	myRelLocTimeThreshold
	Time threshold for heartbeat rate of relative location updates (only for embarked/attached entities) More...
DtTime	mySimTimeLastUpdate
	Set in const send() method. More...
DtTime	myRealTimeLastUpdate
	Set in const send() method. More...
DtTime	myRealTimeLastAttrUpdate
DtTime	myLastSpamCheckTime
	Set in constructor. More...
unsigned short	myNumberOfPdusPerSecond
	Set in constructor. More...
unsigned short	myUpdateRateWarningThreshold
	Set in constructor. More...
bool	myCanWarn
	Set in constructor. More...
DtNonCoupledAttributePduCreator	myNonCoupledAttributePduCreator
DtAttributePduStrategy	myAttributePduStrategy
std::vector < DtStateRepositoryExtensionEncoder * >	myStateRepositoryExtensionEncoderList
std::vector < DtStateRepositoryExtensionDecoder * >	myStateRepositoryExtensionDecoderList

Static Protected Attributes
static DtStateRepCreator	theStateRepCreator
Static Protected Attributes inherited from DtObjectPublisher
static DtNonCoupledAttributePduCreator	theDefaultNonCoupledAttributePduCreator
static DtTime	theDfltTimeThreshold
static DtTime	theDfltRelLocTimeThreshold
static unsigned short	theDfltUpdateRateWarningThreshold

Private Member Functions
	DtWindCorridorPublisher (const DtWindCorridorPublisher &orig)
	Copy Constructor – not implemented. More...
DtWindCorridorPublisher &	operator= (const DtWindCorridorPublisher &orig)
	Assignment operator – not implemented. More...

Detailed Description

Instances of DtWindCorridorPublisher publish METOC_Root.EnvironmentCondition.Weather.WindCorridor.WindCorridor objects to the network.

The WindCorridor object has a longer default timeout threshold (25s) and a heartbeat of 10 seconds.

Member Typedef Documentation

typedef DtWindCorridorStateRepository*(* DtWindCorridorPublisher::DtStateRepCreator)()

Function prototype for a function that creates a DtWindCorridorStateRepository.

Constructor & Destructor Documentation

DtWindCorridorPublisher::DtWindCorridorPublisher	(	DtWindCorridorStateRepository *	stateRepToUse,
		DtExerciseConn *	conn,
		const DtObjectId &	id = DtObjectId::nullId()
	)

Constructor.

DtWindCorridorPublisher::DtWindCorridorPublisher	(	DtExerciseConn *	conn,
		const DtObjectId &	id = DtObjectId::nullId()
	)

Constructor.

virtual DtWindCorridorPublisher::~DtWindCorridorPublisher ( )

virtual

Destructor.

DtWindCorridorPublisher::DtWindCorridorPublisher ( const DtWindCorridorPublisher &  orig )

private

Copy Constructor – not implemented.

Member Function Documentation

virtual void DtWindCorridorPublisher::forceUpdate ( )

virtual

for the next tick call to send out a PDU even if it is not needed.

Implements DtObjectPublisher.

virtual const DtGlobalObjectDesignator& DtWindCorridorPublisher::globalId ( ) const

virtual

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

Implements DtObjectPublisher.

virtual const DtObjectId& DtWindCorridorPublisher::id ( ) const

virtual

Get the entity's identifier.

Implements DtObjectPublisher.

virtual const DtObjectId& DtWindCorridorPublisher::localId ( ) const

virtual

Get the entity's localId - same as id for DIS.

Implements DtObjectPublisher.

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

private

Assignment operator – not implemented.

void DtWindCorridorPublisher::sendFinalPdu ( )

protected

Not virtual since called from destructor. Sends a final PDU for this runway.

static DtStateRepCreator DtWindCorridorPublisher::setStateRepCreator ( DtStateRepCreator  creator )

static

Give us a function to be used for creating SRs.

virtual bool DtWindCorridorPublisher::tick ( )

virtual

tick the publisher

Implements DtObjectPublisher.

DtWindCorridorStateRepository * DtWindCorridorPublisher::windCorridorLayerStateRep ( )

inlinevirtual

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

References DtObjectPublisher::myStateRep.

DtWindCorridorStateRepository * DtWindCorridorPublisher::wsr ( )

inlinevirtual

Synonym for windCorridorLayerStateRep().

References DtObjectPublisher::myStateRep.

Member Data Documentation

DtWindCorridorDecoder* DtWindCorridorPublisher::myDecoder

protected

DtWindCorridorEncoder* DtWindCorridorPublisher::myEncoder

protected

DtObjectId DtWindCorridorPublisher::myId

protected

DtStateRepCreator DtWindCorridorPublisher::theStateRepCreator

staticprotected

---

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

• windCorridorPublisherDIS.h