DtVrfExtEntityPublisher Class Reference

This class extends DtVrfEntityPublisher to support the publishing of VR-Forces state properties as extended attributes of the entity. More...

Inheritance diagram for DtVrfExtEntityPublisher:

Public Member Functions
	DtVrfExtEntityPublisher (const DtEntityType &type, DtExerciseConn *conn, DtVrfParameterDb *paramDb, const DtGlobalObjectDesignator &glId=DtGlobalObjectDesignator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId(), DtRwProperties *stateProps=0, DtRwProperties *paramProps=0)
	Constructor.
virtual	~DtVrfExtEntityPublisher ()
	Destructor.
Public Member Functions inherited from DtVrfEntityPublisher
	DtVrfEntityPublisher (const DtEntityType &type, DtExerciseConn *conn, const DtGlobalObjectDesignator &glId=DtGlobalObjectDesignator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId(), DtRwProperties *stateProps=0, DtRwProperties *paramProps=0)
	Create a new instance of the VRF entity publisher which will, in turn, create the VR-Link entity publisher, given a object id (DIS) or name (HLA).
	DtVrfEntityPublisher (const DtEntityType &type, DtExerciseConn *conn, const DtGlobalObjectDesignator &glId=DtGlobalObjectDesignator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId(), const DtRwProperties &stateProps=DtRwProperties::emptyProperties(), const DtRwProperties &paramProps=DtRwProperties::emptyProperties())
	Create a new instance of the VRF entity publisher which will, in turn, create the VR-Link entity publisher, given a object id (DIS) or name (HLA).
virtual	~DtVrfEntityPublisher ()
	Destructor. Also destroys publisher.
virtual void	tick ()
	Class method taken from publisher class for entities at VR-Link level.
virtual DtEntPublisherDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode PDUs/updates that we send back into the asSeenByRemote state rep.
virtual DtEntPublisherEncoder *	encoder ()
	Returns a pointer to the Encoder being used to encode current state into a PDU/update.
virtual void	setPublishesDiGuyInfo (bool has)
	Indicates that DI-Guy data should be published.
virtual bool	publishesDiGuyInfo ()
	Whether or not DI-Guy data will be published.
virtual void	setSendDiGuyPdus (bool yesNo)
	Tell the publisher to send DI Guy PDU's.
virtual bool	sendDiGuyPdus () const
	Determine whether this publisher will send DI Guy PDU's.
virtual void	createAndSendDiGuyPdus ()
	Override this to have your own custom marshalling of DI-Guy PDUs.
DtStateRepository *	sr ()
	VRL support for common functions.
const DtString &	name () const
virtual const DtObjectId &	id () const
	Get the entity's identifier.
virtual const DtObjectId &	localId () const
	Get the entity's localId - same as id for DIS.
virtual const DtGlobalObjectDesignator &	globalId () const
	Get the global object designator - same as id for DIS.
virtual void	forceUpdate ()
	Force a state update to be sent during the next call to tick, even if nothing would normally cause a send.
virtual bool	sendVrfObjectData ()
	Sends vrf object data update from the ensr() to the network.
virtual DtEntityPublisher *	entityPublisher ()
	Returns a pointer to myPublisher (the VR-Link DtEntityPublisher)
virtual void	setSendVrfObjectDataRecord (bool shouldSend)
	Sets whether a separate VrfObjectData message should be sent to convey additional VRF object information.
virtual void	processDataInteraction (DtDataInteraction *i)
	Used internally. Should not be directly called.
virtual DtExtEntityStateRepository *	entityProcessStateRep ()
virtual DtExtEntityStateRepository *	entityStateRep ()
virtual DtExtEntityStateRepository *	ensr ()

Protected Attributes
DtVrfParameterDb *	myParameterDb
Protected Attributes inherited from DtVrfEntityPublisher
DtEntityPublisher *	myPublisher
DtTime	myTimeLastVrfDataSend
bool	myPublishesDIGuyInfo
makVrfVrlinkExtToolkit::DtExtendedAttributesObjectPublisher *	myExtAttrPublisher

Private Member Functions
	DtVrfExtEntityPublisher (const DtVrfExtEntityPublisher &)
	Unimplemented.
DtVrfExtEntityPublisher &	operator= (const DtVrfExtEntityPublisher &)
	Unimplemented.

Additional Inherited Members
Static Public Member Functions inherited from DtVrfEntityPublisher
static void	setInitializer (DtExtendedAttributesInitializerPtr init)
	Sets the extended attributes initializer used by all publishers of this type.
static DtExtendedAttributesInitializerPtr	initializer ()
	Returns the extended attributes initializer used by all publishers of this type.
static void	setObjectClassChooser (DtObjectClassChooserPtr chooser)
	Sets the object class chooser used by all publishers of this type.
static DtObjectClassChooserPtr	objectClassChooser ()
	Returns the object class chooser used by all publishers of this type.
static void	setVrfDataTimeThreshold (DtTime time)
static DtTime	vrfDataTimeThreshold ()
Protected Member Functions inherited from DtVrfEntityPublisher
	DtVrfEntityPublisher ()
	Alternate constructor that performs no initialization.
void	initialize (const DtEntityType &type, DtExerciseConn *conn, const DtGlobalObjectDesignator &glId, const DtEntityIdentifier &entId)
	Called by the constructor to initialize the publisher.
virtual bool	sendVrfDataUpdate ()
	Sends out a vrf data update message if needed.
virtual bool	needsVrfObjectDataUpdate ()
	Return true if the vrf object data message needs to be updated from a heartbeat or if the object data has changed.
virtual void	processSendVrfObjectDataMessage (DtDataInteraction *interaction)
	Send message if interaction is requesting the entity id we are publishing.
virtual bool	sendMessage (const DtSimulationAddress &receiver, DtSimInterfaceContent *message)
virtual bool	setContentForNet (DtDataInteraction *dataInter, DtSimInterfaceContent *content) const
	Fill out the payload data.
virtual void	sendMessageInteraction (const DtSimulationAddress &receiver, DtDataInteraction &data)
	Send the message interaction.
Static Protected Member Functions inherited from DtVrfEntityPublisher
static void	dataInteractionCallback (DtDataInteraction *i, void *usr)
	Used internally to see if a request is made of this object to send a VRF object update.
Static Protected Attributes inherited from DtVrfEntityPublisher
static DtTime	theVrfDataTimeThreshold
static bool	myDiGuyEncodersSetup
static DtObjectClassChooserPtr	theObjectClassChooser
static DtExtendedAttributesInitializerPtr	theInitializer

Detailed Description

This class extends DtVrfEntityPublisher to support the publishing of VR-Forces state properties as extended attributes of the entity.

Constructor & Destructor Documentation

DtVrfExtEntityPublisher::DtVrfExtEntityPublisher	(	const DtEntityType &	type,
		DtExerciseConn *	conn,
		DtVrfParameterDb *	paramDb,
		const DtGlobalObjectDesignator &	glId = DtGlobalObjectDesignator::nullId(),
		const DtEntityIdentifier &	entId = DtEntityIdentifier::nullId(),
		DtRwProperties *	stateProps = 0,
		DtRwProperties *	paramProps = 0
	)

Constructor.

virtual DtVrfExtEntityPublisher::~DtVrfExtEntityPublisher ( )

virtual

Destructor.

DtVrfExtEntityPublisher::DtVrfExtEntityPublisher ( const DtVrfExtEntityPublisher &  )

private

Unimplemented.

Member Function Documentation

DtVrfExtEntityPublisher& DtVrfExtEntityPublisher::operator= ( const DtVrfExtEntityPublisher &  )

private

Unimplemented.

Member Data Documentation

DtVrfParameterDb* DtVrfExtEntityPublisher::myParameterDb

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfExtendedProperties/vrfExtEntityPublisher.h