This class will wrap a DtControlObjectPublisher to allow for easier creation of a publisher that is compatible with VR-Forces. If you want to create and publish control objects that can be used by VR-Forces, you can use a publisher of this class to facilitate in that creation.

Inheritance diagram for DtVrfControlObjectPublisher:

[legend]

Public Types
typedef DtControlObjectRepository (	MyStateRepCreator )()

Public Member Functions
	DtVrfControlObjectPublisher (const DtEntityType &type, DtExerciseConn conn, const DtGlobalObjectDesignator &glId=DtVrfObjectIdGenerator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId(), DtRwProperties stateProps=0, DtRwProperties *paramProps=0)

	DtVrfControlObjectPublisher (const DtEntityType &type, DtExerciseConn *conn, const DtGlobalObjectDesignator &glId=DtVrfObjectIdGenerator::nullId(), const DtEntityIdentifier &entId=DtEntityIdentifier::nullId(), const DtRwProperties &stateProps=DtRwProperties::emptyProperties(), const DtRwProperties &paramProps=DtRwProperties::emptyProperties())

virtual	~DtVrfControlObjectPublisher ()

virtual bool	tick (bool &extAttrTicked)

virtual DtCtrlPublisherDecoder *	decoder ()

virtual DtCtrlPublisherEncoder *	encoder ()

DtStateRepository *	sr ()

const DtString &	name () const

virtual const DtObjectId &	id () const

virtual const DtObjectId &	localId () const

virtual const DtGlobalObjectDesignator &	globalId () const

virtual void	forceUpdate ()

virtual DtControlObjectPublisher *	controlObjectPublisher ()

virtual void	setSendVrfObjectDataRecord (bool shouldSend)


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


virtual DtControlObjectRepository *	controlObjectProcessStateRep ()

virtual DtControlObjectRepository *	controlObjectStateRep ()

virtual DtControlObjectRepository *	cosr ()

Static Public Member Functions
static void	setInitializer (DtExtendedAttributesInitializerPtr init)

static DtExtendedAttributesInitializerPtr	initializer ()

static void	setObjectClassChooser (DtObjectClassChooserPtr chooser)

static DtObjectClassChooserPtr	objectClassChooser ()

Protected Member Functions
	DtVrfControlObjectPublisher ()

void	initialize (const DtEntityType &type, DtExerciseConn *conn, const DtGlobalObjectDesignator &glId, const DtEntityIdentifier &entId)

virtual DtControlObjectPublisher *	createPublisher (const DtEntityType &type, DtExerciseConn *conn, const DtGlobalObjectDesignator &glId, const DtEntityIdentifier &entId) const

Protected Attributes
DtControlObjectPublisher *	myPublisher

makVrfVrlinkExtToolkit::DtExtendedAttributesObjectPublisher *	myExtAttrPublisher

Static Protected Attributes
static DtObjectClassChooserPtr	theObjectClassChooser

static DtExtendedAttributesInitializerPtr	theInitializer

Private Member Functions
	DtVrfControlObjectPublisher (const DtVrfControlObjectPublisher &)

DtVrfControlObjectPublisher &	operator= (const DtVrfControlObjectPublisher &)

Member Typedef Documentation

typedef DtControlObjectRepository*(* DtVrfControlObjectPublisher::MyStateRepCreator)()

Constructor & Destructor Documentation

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

Create a new instance of the VRF Control Object Publisher which will, in turn, create the DtControlObjectPublisher, 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 DtContrObjectStateRepository class. You can change it in the global DtVrfControlObjectPublisher class before calling this creator.

If supplied, initializes the state repository to publish extended attributes from the supplied state properties.

DtVrfControlObjectPublisher::DtVrfControlObjectPublisher	(	const DtEntityType &	type,
		DtExerciseConn *	conn,
		const DtGlobalObjectDesignator &	glId = `DtVrfObjectIdGenerator::nullId()`,
		const DtEntityIdentifier &	entId = `DtEntityIdentifier::nullId()`,
		const DtRwProperties &	stateProps = `DtRwProperties::emptyProperties()`,
		const DtRwProperties &	paramProps = `DtRwProperties::emptyProperties()`
	)

Create a new instance of the VRF Control Object Publisher which will, in turn, create the DtControlObjectPublisher, 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 DtContrObjectStateRepository class. You can change it in the global DtVrfControlObjectPublisher class before calling this creator.

If supplied, initializes the state repository with the provided state properties.

virtual DtVrfControlObjectPublisher::~DtVrfControlObjectPublisher ( )

virtual

Destructor. Also destroys publisher.

DtVrfControlObjectPublisher::DtVrfControlObjectPublisher ( )

protected

Alternate constructor that performs no initialization. Can be used in subclasses to override how initialization is performed. If this constructor is used, the initialize function (or a equivalent replacement) must be called before this class will publish anything.

DtVrfControlObjectPublisher::DtVrfControlObjectPublisher ( const DtVrfControlObjectPublisher & )

private

Unimplemented.

Member Function Documentation

virtual void DtVrfControlObjectPublisher::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 DtVrfControlObjectPublisher::clearExtendedData ( )

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 DtVrfControlObjectPublisher::removeExtendedData ( const DtString & key )

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 DtString DtVrfControlObjectPublisher::extendedData ( const DtString & key ) const

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 bool DtVrfControlObjectPublisher::tick ( bool & extAttrTicked )

virtual

Class method taken from publisher class for control objects at VR-Link level. This will simply call down to the publisher's tick method. This function should be called once per frame for each control object object. It determines if any data needs to be sent to the other exercise participants, and sends that data.

virtual DtControlObjectRepository* DtVrfControlObjectPublisher::controlObjectProcessStateRep ( )

virtual

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

virtual DtControlObjectRepository* DtVrfControlObjectPublisher::controlObjectStateRep ( )

virtual

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

virtual DtControlObjectRepository* DtVrfControlObjectPublisher::cosr ( )

virtual

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

virtual DtCtrlPublisherDecoder* DtVrfControlObjectPublisher::decoder ( )

virtual

Returns a pointer to the Decoder being used to decode PDUs/updates that we send back into the asSeenByRemote state rep.

virtual DtCtrlPublisherEncoder* DtVrfControlObjectPublisher::encoder ( )

virtual

Returns a pointer to the Encoder being used to encode current state into a PDU/update.

DtStateRepository* DtVrfControlObjectPublisher::sr ( )

inline

Returns the state repository.

const DtString& DtVrfControlObjectPublisher::name ( void ) const

inline

Returns the name of the object.

virtual const DtObjectId& DtVrfControlObjectPublisher::id ( ) const

virtual

Get the control object's identifier.

virtual const DtObjectId& DtVrfControlObjectPublisher::localId ( ) const

virtual

Get the control object's localId - same as id for DIS.

virtual const DtGlobalObjectDesignator& DtVrfControlObjectPublisher::globalId ( ) const

virtual

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

virtual void DtVrfControlObjectPublisher::forceUpdate ( )

virtual

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

virtual DtControlObjectPublisher* DtVrfControlObjectPublisher::controlObjectPublisher ( )

virtual

Returns a pointer to myPublisher (the DtControlObjectPublisher)

virtual void DtVrfControlObjectPublisher::setSendVrfObjectDataRecord ( bool shouldSend )

virtual

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

static void DtVrfControlObjectPublisher::setInitializer ( DtExtendedAttributesInitializerPtr init )

static

Sets the extended attributes initializer used by all publishers of this type.

static DtExtendedAttributesInitializerPtr DtVrfControlObjectPublisher::initializer ( )

static

Returns the extended attributes initializer used by all publishers of this type.

static void DtVrfControlObjectPublisher::setObjectClassChooser ( DtObjectClassChooserPtr chooser )

static

Sets the object class chooser used by all publishers of this type.

static DtObjectClassChooserPtr DtVrfControlObjectPublisher::objectClassChooser ( )

static

Returns the object class chooser used by all publishers of this type.

void DtVrfControlObjectPublisher::initialize	(	const DtEntityType &	type,
		DtExerciseConn *	conn,
		const DtGlobalObjectDesignator &	glId,
		const DtEntityIdentifier &	entId
	)

protected

Called by the constructor to initialize the publisher.

virtual DtControlObjectPublisher* DtVrfControlObjectPublisher::createPublisher	(	const DtEntityType &	type,
		DtExerciseConn *	conn,
		const DtGlobalObjectDesignator &	glId,
		const DtEntityIdentifier &	entId
	)		const

protectedvirtual

Reimplemented in DtVrfGlobalEnvironmentObjectPublisher, and DtVrfWeatherObjectPublisher.

DtVrfControlObjectPublisher& DtVrfControlObjectPublisher::operator= ( const DtVrfControlObjectPublisher & )

private

Unimplemented.

Member Data Documentation

DtControlObjectPublisher* DtVrfControlObjectPublisher::myPublisher

protected

makVrfVrlinkExtToolkit::DtExtendedAttributesObjectPublisher* DtVrfControlObjectPublisher::myExtAttrPublisher

protected

DtObjectClassChooserPtr DtVrfControlObjectPublisher::theObjectClassChooser

staticprotected

DtExtendedAttributesInitializerPtr DtVrfControlObjectPublisher::theInitializer

staticprotected

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation