DtGlobalEnvironmentObjectPublisher Class Reference

This class will wrap a VR-Link DtEnvironmentalProcessPublisher to allow for easier creation of a publisher that is compatible with VR-Forces. More...

Inheritance diagram for DtGlobalEnvironmentObjectPublisher:

Public Member Functions
	DtGlobalEnvironmentObjectPublisher (DtExerciseConn *conn, const DtObjectType &type, const DtGlobalObjectDesignator &id=DtGlobalObjectDesignator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId())
	Create a new instance of the control object publisher which will, in turn, create the environmental process publisher, given a object id (DIS) or name (HLA). More...
	DtGlobalEnvironmentObjectPublisher (DtExerciseConn *conn, const DtObjectType &type, const DtDDMRegionSet *regionSetToUse, const DtGlobalObjectDesignator &id=DtVrfObjectIdGenerator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId())
virtual	~DtGlobalEnvironmentObjectPublisher ()
	Also destroys publisher. More...
virtual DtGlobalEnvironmentObjectRepository *	gesr ()
	Access the underlying network state repository. More...
virtual const DtGlobalEnvironmentObjectRepository *	gesr () const
virtual void	sendUpdateWhenTimeChangesBy (double)
	When the time of day changes by this amount send an update. Default is 1 second. More...
virtual double	updateWhenTimeChangesBy () const
Public Member Functions inherited from DtWeatherObjectPublisher
	DtWeatherObjectPublisher (DtExerciseConn *conn, const DtObjectType &type, const DtGlobalObjectDesignator &id=DtGlobalObjectDesignator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId())
	Create a new instance of the control object publisher which will, in turn, create the environmental process publisher, given a object id (DIS) or name (HLA). More...
	DtWeatherObjectPublisher (DtExerciseConn *conn, const DtObjectType &type, const DtDDMRegionSet *regionSetToUse, const DtGlobalObjectDesignator &id=DtGlobalObjectDesignator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId())
	DtWeatherObjectPublisher (DtEnvironmentProcessRepository *stateRepToUse, DtExerciseConn *conn, const DtObjectType &type, const DtGlobalObjectDesignator &id=DtGlobalObjectDesignator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId(), const char *name=0, const DtDDMRegionSet *regionSetToUse=0)
virtual	~DtWeatherObjectPublisher ()
	Also destroys publisher. More...
virtual DtWeatherObjectRepository *	wesr ()
	Access the underlying network state repository. More...
virtual const DtWeatherObjectRepository *	wesr () const
Public Member Functions inherited from DtControlObjectPublisher
	DtControlObjectPublisher (DtExerciseConn *conn, const DtObjectType &type, const DtGlobalObjectDesignator &id=DtGlobalObjectDesignator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId())
	Create a new instance of the control object publisher which will, in turn, create the environmental process publisher, given a object id (DIS) or name (HLA). More...
	DtControlObjectPublisher (DtEnvironmentProcessRepository *sr, DtExerciseConn *conn, const DtObjectType &type, const DtGlobalObjectDesignator &id=DtGlobalObjectDesignator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId())
	DtControlObjectPublisher (DtExerciseConn *conn, const DtObjectType &type, const DtDDMRegionSet *regionSetToUse, const DtGlobalObjectDesignator &id=DtVrfObjectIdGenerator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId())
	DtControlObjectPublisher (DtEnvironmentProcessRepository *sr, DtExerciseConn *conn, const DtObjectType &type, const DtDDMRegionSet *regionSetToUse, const DtGlobalObjectDesignator &id=DtVrfObjectIdGenerator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId())
virtual	~DtControlObjectPublisher ()
	Also destroys publisher. More...
virtual void	tick ()
	Class method taken from publisher class for environmentals at VR-Link level. More...
virtual DtControlObjectRepository *	cosr ()
	Synonym for environmentProcessStateRep(). More...
virtual void	setSendVrfObjectDataRecord (bool shouldSend)
	Sets whether a separate VrfObjectData record should be sent to convey additional VRF object information. More...
virtual DtCtrlPublisherDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode PDUs that we send back into the asSeenByRemote ESR. More...
virtual DtCtrlPublisherEncoder *	encoder ()
	Returns a pointer to the Encoder being used to encode current state into an entity state PDU. More...
virtual void	setExtendedData (const DtString &key, const DtString &value)
virtual void	clearExtendedData ()
virtual void	removeExtendedData (const DtString &key)
virtual DtString	extendedData (const DtString &key) const

Private Member Functions
	DtGlobalEnvironmentObjectPublisher (const DtGlobalEnvironmentObjectPublisher &)
	Unimplemented. More...
DtGlobalEnvironmentObjectPublisher &	operator= (const DtGlobalEnvironmentObjectPublisher &)

Additional Inherited Members
Static Public Member Functions inherited from DtControlObjectPublisher
static DtGlobalObjectDesignator	nextId (DtExerciseConn *)
Protected Member Functions inherited from DtWeatherObjectPublisher
void	init ()

Detailed Description

This class will wrap a VR-Link DtEnvironmentalProcessPublisher to allow for easier creation of a publisher that is compatible with VR-Forces.

If you want to create and publish environmental objects that can be used by VR-Forces, you can use a publisher of this class to facilitate in that creation

Constructor & Destructor Documentation

DtGlobalEnvironmentObjectPublisher::DtGlobalEnvironmentObjectPublisher	(	DtExerciseConn *	conn,
		const DtObjectType &	type,
		const DtGlobalObjectDesignator &	id = DtGlobalObjectDesignator::nullId(),
		const DtEntityIdentifier &	entId = DtEntityIdentifier::nullId()
	)

Create a new instance of the control object publisher which will, in turn, create the environmental process publisher, given a object id (DIS) or name (HLA).

This class will use the default factory as supplied in the DtVrfObjectIdGenerator class

The state repository will initially be set to the DtControlObjectRepository class. You can change it in the global DtGlobalEnvironmentObjectPublisher class before calling this creator

DtGlobalEnvironmentObjectPublisher::DtGlobalEnvironmentObjectPublisher	(	DtExerciseConn *	conn,
		const DtObjectType &	type,
		const DtDDMRegionSet *	regionSetToUse,
		const DtGlobalObjectDesignator &	id = DtVrfObjectIdGenerator::nullId(),
		const DtEntityIdentifier &	entId = DtEntityIdentifier::nullId()
	)

virtual DtGlobalEnvironmentObjectPublisher::~DtGlobalEnvironmentObjectPublisher ( )

virtual

Also destroys publisher.

DtGlobalEnvironmentObjectPublisher::DtGlobalEnvironmentObjectPublisher ( const DtGlobalEnvironmentObjectPublisher &  )

private

Unimplemented.

Member Function Documentation

virtual DtGlobalEnvironmentObjectRepository* DtGlobalEnvironmentObjectPublisher::gesr ( )

virtual

Access the underlying network state repository.

virtual const DtGlobalEnvironmentObjectRepository* DtGlobalEnvironmentObjectPublisher::gesr ( ) const

virtual

virtual void DtGlobalEnvironmentObjectPublisher::sendUpdateWhenTimeChangesBy ( double  )

virtual

When the time of day changes by this amount send an update. Default is 1 second.

virtual double DtGlobalEnvironmentObjectPublisher::updateWhenTimeChangesBy ( ) const

virtual

DtGlobalEnvironmentObjectPublisher& DtGlobalEnvironmentObjectPublisher::operator= ( const DtGlobalEnvironmentObjectPublisher &  )

private

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfExtObjects/globalEnvironmentObjectPublisher.h