DtControlObjectPublisher 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 DtControlObjectPublisher:

Public Member Functions
	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

Static Public Member Functions
static DtGlobalObjectDesignator	nextId (DtExerciseConn *)

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

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

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).

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 DtControlObjectPublisher class before calling this creator

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

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

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

virtual DtControlObjectPublisher::~DtControlObjectPublisher ( )

virtual

Also destroys publisher.

DtControlObjectPublisher::DtControlObjectPublisher ( const DtControlObjectPublisher &  )

private

Unimplemented.

Member Function Documentation

static DtGlobalObjectDesignator DtControlObjectPublisher::nextId ( DtExerciseConn *  )

static

virtual void DtControlObjectPublisher::setExtendedData ( const DtString &  key, const DtString &  value  )

virtual

Extended record data is a key/value pair. The value and key is always a string representation and is up to the developer to determine the format of the value. The values are set through the publisher

virtual void DtControlObjectPublisher::clearExtendedData ( )

virtual

virtual void DtControlObjectPublisher::removeExtendedData ( const DtString &  key )

virtual

virtual DtString DtControlObjectPublisher::extendedData ( const DtString &  key ) const

virtual

virtual void DtControlObjectPublisher::tick ( )

virtual

Class method taken from publisher class for environmentals at VR-Link level.

This will simply call down to the base publisher to handle the method. This function should be called once per frame for each environment process object. It determines if any data needs to be sent to the other exercise participants, and sends that data.

virtual DtControlObjectRepository* DtControlObjectPublisher::cosr ( )

virtual

Synonym for environmentProcessStateRep().

virtual void DtControlObjectPublisher::setSendVrfObjectDataRecord ( bool  shouldSend )

virtual

Sets whether a separate VrfObjectData record should be sent to convey additional VRF object information.

virtual DtCtrlPublisherDecoder* DtControlObjectPublisher::decoder ( )

virtual

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

virtual DtCtrlPublisherEncoder* DtControlObjectPublisher::encoder ( )

virtual

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

DtControlObjectPublisher& DtControlObjectPublisher::operator= ( const DtControlObjectPublisher &  )

private

---

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

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