DtExtendedPropertiesAggregatePublisher Class Reference

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

Inheritance diagram for DtExtendedPropertiesAggregatePublisher:

Public Member Functions
	DtExtendedPropertiesAggregatePublisher (const DtEntityType &type, DtExerciseConn *conn, DtVrfParameterDb *paramDb, DtRwProperties *stateProps=0, DtRwProperties *paramProps=0, const DtGlobalObjectDesignator &glId=DtVrfObjectIdGenerator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId())
	Constructor.
virtual	~DtExtendedPropertiesAggregatePublisher ()
	Destructor.
virtual void	tick ()
	Ticks the aggregate publisher and extended attributes publisher.
virtual DtExtendedPropertiesAggregateStateRepository *	extPropAggregateStateRep ()
	Returns a pointer to the DtExtendedPropertiesAggregateStateRepository through which you can set or inspect the current state including state properties.
virtual DtExtendedPropertiesAggregateStateRepository *	epagsr ()
Public Member Functions inherited from DtVrfAggregatePublisher
	DtVrfAggregatePublisher (const DtEntityType &type, DtExerciseConn *conn, const DtGlobalObjectDesignator &glId=DtVrfObjectIdGenerator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId())
	Create a new instance of the vrf aggregate publisher which will, in turn, create the vrlink aggregate publisher, given a object id (DIS) or name (HLA).
virtual	~DtVrfAggregatePublisher ()
	Also destroys publisher.
virtual void	addEntity (const DtBaseEntityStateRepository *)
	Convenience routines to add/remove subordinates.
virtual void	removeEntity (const DtBaseEntityStateRepository *)
virtual void	addAggregate (const DtBaseEntityStateRepository *)
virtual void	removeAggregate (const DtBaseEntityStateRepository *)
virtual DtExtAggregateStateRepository *	aggregateProcessStateRep ()
	Returns a pointer to the DtExtAggregateStateRepository - through which you can set or inspect current state information.
virtual DtExtAggregateStateRepository *	aggregateStateRep ()
virtual DtExtAggregateStateRepository *	agsr ()
	Synonym for aggregateProcessStateRep().
virtual DtAggPublisherDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode PDUs that we send back into the asSeenByRemote ESR.
virtual DtAggPublisherEncoder *	encoder ()
	Returns a pointer to the Encoder being used to encode current state into an entity state PDU.
DtStateRepository *	sr ()
	VRL support for common functions.
const DtString &	name () const
virtual const DtObjectId &	id () const
	Get the aggregate's identifier.
virtual const DtObjectId &	localId () const
	Get the aggregate'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 DtAggregatePublisher *	aggregatePublisher ()
	Returns a pointer to myPublisher (the VR-Link DtAggregatePublisher)
virtual void	setSendVrfObjectDataRecord (bool shouldSend)
	Sets whether a separate VrfObjectData record should be sent to convey additional VRF object information.
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

Protected Attributes
DtVrfParameterDb *	myParameterDb
makVrfVrlinkExtToolkit::DtExtendedAttributesObjectPublisher *	myExtAttrPublisher
Protected Attributes inherited from DtVrfAggregatePublisher
DtAggregatePublisher *	myPublisher

Static Protected Attributes
static DtBoost::shared_ptr < DtObjectClassChooser >	theObjectClassChooser

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

Additional Inherited Members
Public Types inherited from DtVrfAggregatePublisher
typedef DtAggregateStateRepository *(*	MyStateRepCreator )()
Protected Member Functions inherited from DtVrfAggregatePublisher
	DtVrfAggregatePublisher ()
	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 void	sendFinalPdu ()
	When this object is destroyed (in DIS) sends out a "final" pdu that sets the appearance to have the DtFinalPduBitVal bit set.

Detailed Description

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

Constructor & Destructor Documentation

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

Constructor.

virtual DtExtendedPropertiesAggregatePublisher::~DtExtendedPropertiesAggregatePublisher ( )

virtual

Destructor.

DtExtendedPropertiesAggregatePublisher::DtExtendedPropertiesAggregatePublisher ( const DtExtendedPropertiesAggregatePublisher &  )

private

Unimplemented.

Member Function Documentation

virtual void DtExtendedPropertiesAggregatePublisher::tick ( )

virtual

Ticks the aggregate publisher and extended attributes publisher.

Reimplemented from DtVrfAggregatePublisher.

virtual DtExtendedPropertiesAggregateStateRepository* DtExtendedPropertiesAggregatePublisher::extPropAggregateStateRep ( )

virtual

Returns a pointer to the DtExtendedPropertiesAggregateStateRepository through which you can set or inspect the current state including state properties.

virtual DtExtendedPropertiesAggregateStateRepository* DtExtendedPropertiesAggregatePublisher::epagsr ( )

virtual

DtExtendedPropertiesAggregatePublisher& DtExtendedPropertiesAggregatePublisher::operator= ( const DtExtendedPropertiesAggregatePublisher &  )

private

Unimplemented.

Member Data Documentation

DtVrfParameterDb* DtExtendedPropertiesAggregatePublisher::myParameterDb

protected

makVrfVrlinkExtToolkit::DtExtendedAttributesObjectPublisher* DtExtendedPropertiesAggregatePublisher::myExtAttrPublisher

protected

DtBoost::shared_ptr<DtObjectClassChooser> DtExtendedPropertiesAggregatePublisher::theObjectClassChooser

staticprotected

---

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

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