Instances of DtNavAidPublisher are used for publishing simulation data of NavAids such as TACAN.

class DtNavAidPublisher:

Instances of DtNavAidPublisher are used for local or source simulations of radio transmitters, (i.e. these entities are not dependent on data being produced elsewhere on the network for their existence). These radio transmitters send data to the network.

Inheritance diagram for DtNavAidPublisher:

[legend]

Public Types
typedef DtNavAidStateRepository (	DtStateRepCreator )()

typedef DtNavAidEncoder (	DtEncoderCreator )()

typedef DtNavAidDecoder (	DtDecoderCreator )(DtExerciseConn *conn)

typedef DtNavAidStateRepository (	DtStateRepCreator )()

typedef DtNavAidDecoder (	DtDecoderCreator )(DtExerciseConn exConn, DtObjClassDesc classDesc)

typedef DtNavAidEncoder (	DtEncoderCreator )(DtExerciseConn exConn, DtObjClassDesc classDesc)

Public Member Functions
	DtNavAidPublisher (DtNavAidStateRepository stateRepToUse, DtExerciseConn conn, const DtObjectId &entityId=DtObjectId::defaultId())

	DtNavAidPublisher (DtExerciseConn *conn, const DtObjectId &entityId=DtObjectId::defaultId(), int radioId=1)

virtual	~DtNavAidPublisher () override

virtual bool	tick () override

virtual DtNavAidStateRepository *	navAidStateRep ()

virtual DtNavAidStateRepository *	nasr ()

virtual DtNavAidDecoder *	decoder ()

virtual DtNavAidEncoder *	encoder ()

virtual const DtObjectId &	id () const override

virtual const DtObjectId &	localId () const override

virtual const DtGlobalObjectDesignator &	globalId () const override

virtual int	radioId () const

virtual void	sendFinalPduOnDestruction (bool onOff)

virtual void	forceUpdate () override

virtual void	setHeartbeatMoveTimer (DtTime time)

virtual DtTime	heartbeatMoveTimer () const

virtual DtTime	transmitterTimeThreshold () const

virtual void	setAntennaLocationThreshold (double threshold)

virtual double	antennaLocationThreshold () const

virtual void	setAntennaOrientationThreshold (double threshold)

virtual double	antennaOrientationThreshold () const

	DtNavAidPublisher (DtNavAidStateRepository stateRepToUse, DtExerciseConn conn, const char name=0, const DtDDMRegionSet regionSetToUse=0)

	DtNavAidPublisher (RTI::ObjectClassHandle h, DtExerciseConn conn, const char name=0, const DtDDMRegionSet *regionSetToUse=0)

	DtNavAidPublisher (DtExerciseConn conn, const char name=0, const DtDDMRegionSet *regionSetToUse=0)

	DtNavAidPublisher (DtHlaObjectWithStateRep obj, DtExerciseConn conn)

virtual	~DtNavAidPublisher () override

virtual DtNavAidStateRepository *	navAidStateRep ()

virtual DtNavAidStateRepository *	nasr ()

virtual const char *	classToUse () const

Static Public Member Functions
static void	setStateRepCreator (DtStateRepCreator creator)

static DtStateRepCreator	stateRepCreator (void)

static void	setEncoderCreator (DtEncoderCreator creator)

static void	setDecoderCreator (DtDecoderCreator creator)

static void	setUseMovingThresholdFlag (bool flag)

static bool	useMovingThresholdFlag ()

static void	setClassDfltTimeThreshold (DtTime threshold)

static DtStateRepCreator	setStateRepCreator (DtStateRepCreator creator)

static DtEncoderCreator	setEncoderCreator (DtEncoderCreator creator)

static DtDecoderCreator	setDecoderCreator (DtDecoderCreator creator)

Protected Member Functions
void	sendFinalPdu ()

void	init (const DtEntityIdentifier &vehId)

	DtNavAidPublisher (const DtNavAidPublisher &orig)

DtNavAidPublisher &	operator= (const DtNavAidPublisher &orig)

	DtNavAidPublisher (const char name=0, const DtDDMRegionSet regionSetToUse=0)

	DtNavAidPublisher (const DtNavAidPublisher &orig)

DtNavAidPublisher &	operator= (const DtNavAidPublisher &orig)

Protected Attributes
DtObjectId	myId

DtNavAidDecoder *	myDecoder

DtNavAidEncoder *	myEncoder

bool	mySendFinalInDtor

DtTime	myHeartbeatMoveTimer

Static Protected Attributes
static DtStateRepCreator	theStateRepCreator

static DtEncoderCreator	theEncoderCreator

static DtDecoderCreator	theDecoderCreator

static bool	theUseMovingThresholdFlag

static DtTime	theClassDfltTimeThreshold

static bool	theClassDfltIsSetFlag

Member Typedef Documentation

typedef DtNavAidStateRepository*(* DtNavAidPublisher::DtStateRepCreator)()

Function prototype for a function that creates a DtNavAidStateRepository.

typedef DtNavAidEncoder*(* DtNavAidPublisher::DtEncoderCreator)()

Function prototype for a function that creates a DtNavAidEncoder.

typedef DtNavAidDecoder*(* DtNavAidPublisher::DtDecoderCreator)(DtExerciseConn *conn)

Function prototype for a function that creates a DtNavAidDecoder.

typedef DtNavAidStateRepository*(* DtNavAidPublisher::DtStateRepCreator)()

Function prototype for functions that create DtNavAidStateRepositorys.

typedef DtNavAidDecoder*(* DtNavAidPublisher::DtDecoderCreator)(DtExerciseConn *exConn, DtObjClassDesc *classDesc)

Function prototype for functions that create DtNavAidDecoders.

typedef DtNavAidEncoder*(* DtNavAidPublisher::DtEncoderCreator)(DtExerciseConn *exConn, DtObjClassDesc *classDesc)

Function prototype for functions that create DtNavAidEncoders.

Constructor & Destructor Documentation

DtNavAidPublisher::DtNavAidPublisher	(	DtNavAidStateRepository *	stateRepToUse,
		DtExerciseConn *	conn,
		const DtObjectId &	entityId = `DtObjectId::defaultId()`
	)

Constructor – State Rep must contain a radioId.

DtNavAidPublisher::DtNavAidPublisher	(	DtExerciseConn *	conn,
		const DtObjectId &	entityId = `DtObjectId::defaultId()`,
		int	radioId = `1`
	)

Constructor.

virtual DtNavAidPublisher::~DtNavAidPublisher ( )

overridevirtual

Destructor.

DtNavAidPublisher::DtNavAidPublisher ( const DtNavAidPublisher & orig )

protected

copy constructor – not implemented

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

Constructor.

DtNavAidPublisher::DtNavAidPublisher	(	RTI::ObjectClassHandle	h,
		DtExerciseConn *	conn,
		const char *	name = `0`,
		const DtDDMRegionSet *	regionSetToUse = `0`
	)

Constructor.

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

Constructor.

DtNavAidPublisher::DtNavAidPublisher	(	DtHlaObjectWithStateRep *	obj,
		DtExerciseConn *	conn
	)

Constructor that creates a publisher for an existing DtHlaObject. (DtHlaObjectWithStateRep is derived from DtHlaObject.) Typically used in conjunction with ownership management, when you want to take ownership and begin updating some attributes of an object that you have already discovered.

virtual DtNavAidPublisher::~DtNavAidPublisher ( )

overridevirtual

destructor

DtNavAidPublisher::DtNavAidPublisher	(	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.

DtNavAidPublisher::DtNavAidPublisher ( const DtNavAidPublisher & orig )

protected

copy constructor – not implemented

Member Function Documentation

virtual bool DtNavAidPublisher::tick ( )

overridevirtual

This function should be called once per frame for each NavAid object. It determines if any data needs to be sent to the other exercise participants and sends that data.

DtNavAidStateRepository * DtNavAidPublisher::navAidStateRep ( )

inlinevirtual

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

DtNavAidStateRepository * DtNavAidPublisher::nasr ( )

inlinevirtual

Synonym for environmentProcessStateRep()

virtual DtNavAidDecoder* DtNavAidPublisher::decoder ( )

virtual

Returns a pointer to the Decoder being used to decode PDUs that we send back into the asSeenByRemote ESR.

virtual DtNavAidEncoder* DtNavAidPublisher::encoder ( )

virtual

Returns a pointer to the Encoder being used to encode current state into an entity state PDU.

virtual const DtObjectId& DtNavAidPublisher::id ( ) const

overridevirtual

Get the environment process's identifier.

virtual const DtObjectId& DtNavAidPublisher::localId ( ) const

overridevirtual

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

virtual const DtGlobalObjectDesignator& DtNavAidPublisher::globalId ( ) const

overridevirtual

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

virtual int DtNavAidPublisher::radioId ( ) const

virtual

Get the radio ID.

virtual void DtNavAidPublisher::sendFinalPduOnDestruction ( bool onOff )

virtual

Set flag indicating whether to send a final PDU with the "FinalPdu" appearance bit set, from within the DtNavAidPublisher destructor.

virtual void DtNavAidPublisher::forceUpdate ( )

overridevirtual

Force a state update to be sent during the next call to tick, even if nothing would normally cause a send.

virtual void DtNavAidPublisher::setHeartbeatMoveTimer ( DtTime time )

virtual

Sets the time threshold used for moving transmitters.

virtual DtTime DtNavAidPublisher::heartbeatMoveTimer ( ) const

virtual

Returns the time threshold used for moving transmitters.

virtual DtTime DtNavAidPublisher::transmitterTimeThreshold ( ) const

virtual

Returns the time threshold being used.

virtual void DtNavAidPublisher::setAntennaLocationThreshold ( double threshold )

virtual

Sets the antenna location threshold. Sets the distance that the antenna must have moved for another PDU to be sent.

Parameters

threshold Threshold in meters defaulted to 500 m.

Deprecated:: Users should now call: nasr()->thresholder()->setAntennaLocationThreshold()

virtual double DtNavAidPublisher::antennaLocationThreshold ( ) const

virtual

Returns the antenna location threshold.

Returns: The location threshold in meters.

Deprecated:: Users should now call: nasr()->thresholder()->antennaLocationThreshold()

Exceptions

DtException if state rep is null.

virtual void DtNavAidPublisher::setAntennaOrientationThreshold ( double threshold )

virtual

Sets the antenna orientation threshold.

Parameters

threshold Threshold in radians defaulted to 180 degrees.

Deprecated:: Users should now call: nasr()->thresholder()->setAntennaOrientationThreshold()

virtual double DtNavAidPublisher::antennaOrientationThreshold ( ) const

virtual

Returns the antenna orientation threshold.

Returns: The orientation threshold in radians.

Deprecated:: Users should now call: nasr()->thresholder()->antennaOrientationThreshold()

Exceptions

DtException if state rep is null.

static void DtNavAidPublisher::setStateRepCreator ( DtStateRepCreator creator )

static

Give us a function to be used for creating SRs.

static DtStateRepCreator DtNavAidPublisher::stateRepCreator ( void )

static

static void DtNavAidPublisher::setEncoderCreator ( DtEncoderCreator creator )

static

Give us a function to be used for creating an encoder.

static void DtNavAidPublisher::setDecoderCreator ( DtDecoderCreator creator )

static

Give us a function to be used for creating a decoder.

static void DtNavAidPublisher::setUseMovingThresholdFlag ( bool flag )

static

Sets the flag to determine whether to use a separate threshold value if the entity that the NavAid is attached to is moving.

static bool DtNavAidPublisher::useMovingThresholdFlag ( )

static

Returns the flag described above.

See Also: setUseMovingThresholdFlag

static void DtNavAidPublisher::setClassDfltTimeThreshold ( DtTime threshold )

static

void DtNavAidPublisher::sendFinalPdu ( )

protected

not virtual since called from destructor.

void DtNavAidPublisher::init ( const DtEntityIdentifier & vehId )

protected

not virtual since called from constructor

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

protected

copy constructor – not implemented

virtual DtNavAidStateRepository* DtNavAidPublisher::navAidStateRep ( )

virtual

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

virtual DtNavAidStateRepository* DtNavAidPublisher::nasr ( )

virtual

Synonym for navAidStateRep().

virtual const char* DtNavAidPublisher::classToUse ( ) const

virtual

Returns the name of the FOM object class to use. Default implementation is to ask the FOM Mapper.

static DtStateRepCreator DtNavAidPublisher::setStateRepCreator ( DtStateRepCreator creator )

static

Give us a function to be used for creating SRs.

static DtEncoderCreator DtNavAidPublisher::setEncoderCreator ( DtEncoderCreator creator )

static

Give us a function to be used for creating encoders.

static DtDecoderCreator DtNavAidPublisher::setDecoderCreator ( DtDecoderCreator creator )

static

Give us a function to be used for creating decoders.

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

protected

copy constructor – not implemented

Member Data Documentation

DtObjectId DtNavAidPublisher::myId

protected

DtNavAidDecoder* DtNavAidPublisher::myDecoder

protected

DtNavAidEncoder* DtNavAidPublisher::myEncoder

protected

bool DtNavAidPublisher::mySendFinalInDtor

protected

DtTime DtNavAidPublisher::myHeartbeatMoveTimer

protected

static DtStateRepCreator DtNavAidPublisher::theStateRepCreator

staticprotected

static DtEncoderCreator DtNavAidPublisher::theEncoderCreator

staticprotected

static DtDecoderCreator DtNavAidPublisher::theDecoderCreator

staticprotected

bool DtNavAidPublisher::theUseMovingThresholdFlag

staticprotected

DtTime DtNavAidPublisher::theClassDfltTimeThreshold

staticprotected

bool DtNavAidPublisher::theClassDfltIsSetFlag

staticprotected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfExtObjects/navAidPublisherDIS.h
/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfExtObjects/navAidPublisherHLA.h

Public Types
typedef DtNavAidStateRepository (	DtStateRepCreator )()

typedef DtNavAidEncoder (	DtEncoderCreator )()

typedef DtNavAidDecoder (	DtDecoderCreator )(DtExerciseConn *conn)

typedef DtNavAidStateRepository (	DtStateRepCreator )()

typedef DtNavAidDecoder (	DtDecoderCreator )(DtExerciseConn exConn, DtObjClassDesc classDesc)

typedef DtNavAidEncoder (	DtEncoderCreator )(DtExerciseConn exConn, DtObjClassDesc classDesc)

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation