VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions
DtReflectedControlObjectList Class Reference

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.

Inheritance diagram for DtReflectedControlObjectList:
Inheritance graph
[legend]

Public Member Functions

 DtReflectedControlObjectList (DtExerciseConn *exConn, const DtRwProperties &stateProps=DtRwProperties::emptyProperties(), const DtRwProperties &paramProps=DtRwProperties::emptyProperties())
 
 DtReflectedControlObjectList (DtExerciseConn *exConn, const DtDDMRegionSet *regionSetToUse, const DtRwProperties &stateProps=DtRwProperties::emptyProperties(), const DtRwProperties &paramProps=DtRwProperties::emptyProperties())
 
 DtReflectedControlObjectList (DtExerciseConn *exConn, const DtList *handleList, const DtDDMRegionSet *regionSetToUse=0, const DtRwProperties &stateProps=DtRwProperties::emptyProperties(), const DtRwProperties &paramProps=DtRwProperties::emptyProperties())
 
virtual ~DtReflectedControlObjectList ()
 
virtual void setPropertyPrototypes (const DtRwProperties &stateProps, const DtRwProperties &paramProps)
 
virtual DtReflectedControlObjectlookupCO (RTI::ObjectHandle id)
 
virtual DtReflectedControlObjectfirstCO () const
 
virtual DtReflectedControlObjectlastCO () const
 
virtual DtReflectedControlObjectlookupCO (const DtGlobalObjectDesignator &designator)
 
virtual void addControlObjectAdditionCallback (DtControlObjectCallbackFunction cb, void *userData)
 
virtual void removeControlObjectAdditionCallback (DtControlObjectCallbackFunction cb, void *userData)
 
virtual void addControlObjectRemovalCallback (DtControlObjectCallbackFunction cb, void *userData)
 
virtual void removeControlObjectRemovalCallback (DtControlObjectCallbackFunction cb, void *userData)
 

Static Public Member Functions

static void setInitializer (DtExtendedAttributesInitializerPtr init)
 
static
DtExtendedAttributesInitializerPtr 
initializer ()
 

Protected Member Functions

void initializeExtendedProperties ()
 
virtual bool readyToAdd (DtReflectedObject *obj)
 
virtual void processDataInteraction (DtDataInteraction *i)
 
virtual DtReflectedObjectnewReflectedObject (DtHlaObject *obj) const
 
virtual void controlObjectAdded (DtReflectedControlObject *)
 

Static Protected Member Functions

static void dataInteractionCallback (DtDataInteraction *i, void *usr)
 
static void controlObjectAddedCallback (DtReflectedControlObject *controlObject, void *userData)
 

Protected Attributes

DtRwProperties myStatePropertiesPrototype
 
DtRwProperties myParameterPropertiesPrototype
 

Static Protected Attributes

static
DtExtendedAttributesInitializerPtr 
theInitializer
 

Private Member Functions

 DtReflectedControlObjectList (const DtReflectedControlObjectList &orig)
 
DtReflectedControlObjectListoperator= (const DtReflectedControlObjectList &rhs)
 

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

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:

Document ID: Generated on Wed Mar 27 22:49:11 EDT 2024 from SVN revision 264633
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)