class DtReflectedControlObjectList: More...

Inheritance diagram for DtReflectedControlObjectList:

Public Member Functions
	DtReflectedControlObjectList (DtExerciseConn *exConn, const DtRwProperties &stateProps=DtRwProperties::emptyProperties(), const DtRwProperties &paramProps=DtRwProperties::emptyProperties())
	Constructor - obtains the set of object classes to subscribe to from the exConn's fomMapper.
	DtReflectedControlObjectList (DtExerciseConn exConn, const DtDDMRegionSet regionSetToUse, const DtRwProperties &stateProps=DtRwProperties::emptyProperties(), const DtRwProperties &paramProps=DtRwProperties::emptyProperties())
	Constructor - obtains the set of object classes to subscribe to from the exConn's fomMapper.
	DtReflectedControlObjectList (DtExerciseConn exConn, const DtList handleList, const DtDDMRegionSet *regionSetToUse=0, const DtRwProperties &stateProps=DtRwProperties::emptyProperties(), const DtRwProperties &paramProps=DtRwProperties::emptyProperties())
	Constructor - only subscribe to the RTI::ObjectClassHandles in handleList.
virtual	~DtReflectedControlObjectList ()
	Destructor.
virtual void	setPropertyPrototypes (const DtRwProperties &stateProps, const DtRwProperties &paramProps)
	Sets the prototypes for state and parameter properties.
virtual DtReflectedControlObject *	lookupCO (RTI::ObjectHandle id)
	Look up environmental process by handle.
virtual DtReflectedControlObject *	firstCO () const
	Get the first/last environmental process in the list.
virtual DtReflectedControlObject *	lastCO () const
virtual DtReflectedControlObject *	lookupCO (const DtGlobalObjectDesignator &designator)
	Look up an environmental process object by DtGlobalObjectDesignator.
virtual void	addControlObjectAdditionCallback (DtControlObjectCallbackFunction cb, void *userData)
	Environmental process added callback registration.
virtual void	removeControlObjectAdditionCallback (DtControlObjectCallbackFunction cb, void *userData)
	Environmental process added callback deregistration.
virtual void	addControlObjectRemovalCallback (DtControlObjectCallbackFunction cb, void *userData)
	Environmental process removed callback registration.
virtual void	removeControlObjectRemovalCallback (DtControlObjectCallbackFunction cb, void *userData)
	Environmental process removed callback deregistration.

Static Public Member Functions
static void	setInitializer (DtExtendedAttributesInitializerPtr init)
	Set the initializer used by all reflected lists of this type.
static DtExtendedAttributesInitializerPtr	initializer ()
	Returns the initializer used by all reflected lists of this type.

Protected Member Functions
void	initializeExtendedProperties ()
	Determines whether or not extended properties available. Called from constructors.
virtual bool	readyToAdd (DtReflectedObject *obj)
	Overridden to make sure extended properties are updated before checking if the object is ready to add.
virtual void	processDataInteraction (DtDataInteraction *i)
virtual DtReflectedObject *	newReflectedObject (DtHlaObject *obj) const
	Create a new reflected control object.
virtual void	controlObjectAdded (DtReflectedControlObject *)

Static Protected Member Functions
static void	dataInteractionCallback (DtDataInteraction i, void usr)
static void	controlObjectAddedCallback (DtReflectedControlObject controlObject, void userData)
	When an control object is added initialize any extended properties (if supported and available) as well as add update callback for object.

Protected Attributes
DtRwProperties	myStatePropertiesPrototype
DtRwProperties	myParameterPropertiesPrototype

Static Protected Attributes
static DtExtendedAttributesInitializerPtr	theInitializer

Private Member Functions
	DtReflectedControlObjectList (const DtReflectedControlObjectList &orig)
	Not implemented.
DtReflectedControlObjectList &	operator= (const DtReflectedControlObjectList &rhs)
	Not implemented.

Detailed Description

class DtReflectedControlObjectList:

Instances of DtReflectedControlObjectList will manage the list of remote environmental processes in the exercise and process any extended VRF data that may be published for these objects.

Constructor & Destructor Documentation

DtReflectedControlObjectList::DtReflectedControlObjectList	(	DtExerciseConn *	exConn,
		const DtRwProperties &	stateProps = `DtRwProperties::emptyProperties()`,
		const DtRwProperties &	paramProps = `DtRwProperties::emptyProperties()`
	)

Constructor - obtains the set of object classes to subscribe to from the exConn's fomMapper.

If state and parameter property prototypes are specified, calls setPropertyPrototypes. If not, properties will not be decoded until setPropertyPrototypes is called.

DtReflectedControlObjectList::DtReflectedControlObjectList	(	DtExerciseConn *	exConn,
		const DtDDMRegionSet *	regionSetToUse,
		const DtRwProperties &	stateProps = `DtRwProperties::emptyProperties()`,
		const DtRwProperties &	paramProps = `DtRwProperties::emptyProperties()`
	)

Constructor - obtains the set of object classes to subscribe to from the exConn's fomMapper.

If state and parameter property prototypes are specified, calls setPropertyPrototypes. If not, properties will not be decoded until setPropertyPrototypes is called.

DtReflectedControlObjectList::DtReflectedControlObjectList	(	DtExerciseConn *	exConn,
		const DtList *	handleList,
		const DtDDMRegionSet *	regionSetToUse = `0`,
		const DtRwProperties &	stateProps = `DtRwProperties::emptyProperties()`,
		const DtRwProperties &	paramProps = `DtRwProperties::emptyProperties()`
	)

Constructor - only subscribe to the RTI::ObjectClassHandles in handleList.

If state and parameter property prototypes are specified, calls setPropertyPrototypes. If not, properties will not be decoded until setPropertyPrototypes is called.

virtual DtReflectedControlObjectList::~DtReflectedControlObjectList ( )

virtual

Destructor.

DtReflectedControlObjectList::DtReflectedControlObjectList ( const DtReflectedControlObjectList & orig )

private

Not implemented.

Member Function Documentation

virtual void DtReflectedControlObjectList::setPropertyPrototypes	(	const DtRwProperties &	stateProps,
		const DtRwProperties &	paramProps
	)

virtual

Sets the prototypes for state and parameter properties.

Each reflected object will be initialized with this prototype and will therefore decode the included properties.

virtual DtReflectedControlObject* DtReflectedControlObjectList::lookupCO ( RTI::ObjectHandle id )

virtual

Look up environmental process by handle.

virtual DtReflectedControlObject* DtReflectedControlObjectList::firstCO ( ) const

virtual

Get the first/last environmental process in the list.

virtual DtReflectedControlObject* DtReflectedControlObjectList::lastCO ( ) const

virtual

virtual DtReflectedControlObject* DtReflectedControlObjectList::lookupCO ( const DtGlobalObjectDesignator & designator )

virtual

Look up an environmental process object by DtGlobalObjectDesignator.

virtual void DtReflectedControlObjectList::addControlObjectAdditionCallback	(	DtControlObjectCallbackFunction	cb,
		void *	userData
	)

virtual

Environmental process added callback registration.

virtual void DtReflectedControlObjectList::removeControlObjectAdditionCallback	(	DtControlObjectCallbackFunction	cb,
		void *	userData
	)

virtual

Environmental process added callback deregistration.

virtual void DtReflectedControlObjectList::addControlObjectRemovalCallback	(	DtControlObjectCallbackFunction	cb,
		void *	userData
	)

virtual

Environmental process removed callback registration.

virtual void DtReflectedControlObjectList::removeControlObjectRemovalCallback	(	DtControlObjectCallbackFunction	cb,
		void *	userData
	)

virtual

Environmental process removed callback deregistration.

static void DtReflectedControlObjectList::setInitializer ( DtExtendedAttributesInitializerPtr init )

static

Set the initializer used by all reflected lists of this type.

static DtExtendedAttributesInitializerPtr DtReflectedControlObjectList::initializer ( )

static

Returns the initializer used by all reflected lists of this type.

DtReflectedControlObjectList& DtReflectedControlObjectList::operator= ( const DtReflectedControlObjectList & rhs )

private

Not implemented.

void DtReflectedControlObjectList::initializeExtendedProperties ( )

protected

Determines whether or not extended properties available. Called from constructors.

virtual bool DtReflectedControlObjectList::readyToAdd ( DtReflectedObject * obj )

protectedvirtual

Overridden to make sure extended properties are updated before checking if the object is ready to add.

static void DtReflectedControlObjectList::dataInteractionCallback	(	DtDataInteraction *	i,
		void *	usr
	)

staticprotected

virtual void DtReflectedControlObjectList::processDataInteraction ( DtDataInteraction * i )

protectedvirtual

virtual DtReflectedObject* DtReflectedControlObjectList::newReflectedObject ( DtHlaObject * obj ) const

protectedvirtual

Create a new reflected control object.

static void DtReflectedControlObjectList::controlObjectAddedCallback	(	DtReflectedControlObject *	controlObject,
		void *	userData
	)

staticprotected

When an control object is added initialize any extended properties (if supported and available) as well as add update callback for object.

virtual void DtReflectedControlObjectList::controlObjectAdded ( DtReflectedControlObject * )

protectedvirtual

Reimplemented in DtReflectedVrfControlObjectList.

Member Data Documentation

DtRwProperties DtReflectedControlObjectList::myStatePropertiesPrototype

protected

DtRwProperties DtReflectedControlObjectList::myParameterPropertiesPrototype

protected

DtExtendedAttributesInitializerPtr DtReflectedControlObjectList::theInitializer

staticprotected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfExtObjects/reflectedControlObjectList.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation