VR-Forces Development_Version Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Classes | Public Member Functions | Static Public Member Functions | Protected Types | Protected Attributes | Private Member Functions
DtReflectedBulkEnvironmentProcess Class Reference

A reflected object which wraps another reflected object to allow a bulk environment process to be processed in pieces. More...

Inheritance diagram for DtReflectedBulkEnvironmentProcess:
Inheritance graph
[legend]

Classes

struct  CallbackInfo
struct  SubObjectInfo

Public Member Functions

 DtReflectedBulkEnvironmentProcess (DtReflectedControlObject *obj, DtExerciseConn *conn)
 Constructor.
virtual ~DtReflectedBulkEnvironmentProcess ()
 Destructor.
virtual DtStateRepositorystateRep () const
 Implementation for abstract base class. Calls cosr().
const DtReflectedControlObjectreflectedControlObject () const
 Returns the reflected control object this bulk object wraps.
virtual unsigned numberOfSubObjects () const
 Returns the number of sub-objects.
virtual void setActiveSubObject (const DtEntityIdentifier &entityId)
 Sets the active sub-object, which dictates the state repository to be returned by any of the state repository accessor methods.
virtual void resetActiveSubObject ()
 Resets the active sub-object to be the first one.
virtual bool incrementActiveSubObject ()
 Makes the next sub-object in the list the active sub-object.
virtual void processControlObjectUpdated (DtReflectedControlObject *obj)
 Process updates to bulk control object. Updates the sub-objects.
virtual void updateExtensions ()
 Extracts the extended environmental process state information, if present, from the sub-object state repositories.
virtual DtControlObjectRepositorycontrolObjectStateRep () const
 Returns a pointer to the repository for the sub-object currently being processed.
virtual DtControlObjectRepositorycosr () const
 Returns a pointer to the repository for the sub-object currently being processed.
virtual void addNewSubObjectCallback (DtControlObjectCallbackFunction cb, void *userData)
 Registers for callbacks for addition of new sub-objects.
virtual void removeNewSubObjectCallback (DtControlObjectCallbackFunction cb, void *userData)
 Registers for callbacks for addition of new sub-objects.
virtual void addPostUpdateCallback (DtControlObjectCallbackFunction cb, void *userData)
 Registers for callbacks for updates to the current active sub-object.
virtual void removePostUpdateCallback (DtControlObjectCallbackFunction cb, void *userData)
 Registers for callbacks for updates to the current active sub-object.
virtual void addAboutToBeRemovedCallback (DtControlObjectCallbackFunction cb, void *userData)
 Registers for callbacks for removal of a sub-object.
virtual void removeAboutToBeRemovedCallback (DtControlObjectCallbackFunction cb, void *userData)
 Registers for callbacks for removal of a sub-object.
- Public Member Functions inherited from DtReflectedControlObject
 DtReflectedControlObject (DtHlaObject *obj, DtExerciseConn *conn)
virtual ~DtReflectedControlObject ()
virtual void processStateMessage (const DtStateMsg &msg)
virtual DtReflectedControlObjectnextCO () const
virtual DtReflectedControlObjectprevCO () const
virtual DtReflectedControlObjectwrapNextCO () const
virtual DtReflectedControlObjectwrapPrevCO () const
virtual void processPostUpdateCallback (DtReflectedControlObject *obj)

Static Public Member Functions

static void postControlObjectUpdateCallback (DtReflectedControlObject *obj, void *userData)
- Static Public Member Functions inherited from DtReflectedControlObject
static void postUpdateCallback (DtReflectedControlObject *obj, void *userData)

Protected Types

typedef std::map
< DtEntityIdentifier,
SubObjectInfo
SubObjectMap

Protected Attributes

DtReflectedControlObjectmyReflectedObject
std::list< CallbackInfomyNewSubObjectCallbacks
SubObjectMap mySubObjects
DtEntityIdentifier myActiveSubObject

Private Member Functions

 DtReflectedBulkEnvironmentProcess (const DtReflectedBulkEnvironmentProcess &orig)
DtReflectedBulkEnvironmentProcessoperator= (const DtReflectedBulkEnvironmentProcess &orig)

Detailed Description

A reflected object which wraps another reflected object to allow a bulk environment process to be processed in pieces.

Member Typedef Documentation

typedef std::map<DtEntityIdentifier, SubObjectInfo> DtReflectedBulkEnvironmentProcess::SubObjectMap
protected

Constructor & Destructor Documentation

DtReflectedBulkEnvironmentProcess::DtReflectedBulkEnvironmentProcess ( DtReflectedControlObject obj,
DtExerciseConn *  conn 
)

Constructor.

Must be passed the DtReflectedControlObject which it will wrap and help parse into sub-objects.

virtual DtReflectedBulkEnvironmentProcess::~DtReflectedBulkEnvironmentProcess ( )
virtual

Destructor.

DtReflectedBulkEnvironmentProcess::DtReflectedBulkEnvironmentProcess ( const DtReflectedBulkEnvironmentProcess orig)
private

Member Function Documentation

virtual DtControlObjectRepository* DtReflectedBulkEnvironmentProcess::controlObjectStateRep ( ) const
virtual

Returns a pointer to the repository for the sub-object currently being processed.

Reimplemented from DtReflectedControlObject.

virtual DtControlObjectRepository* DtReflectedBulkEnvironmentProcess::cosr ( ) const
virtual

Returns a pointer to the repository for the sub-object currently being processed.

Reimplemented from DtReflectedControlObject.

virtual DtStateRepository* DtReflectedBulkEnvironmentProcess::stateRep ( ) const
virtual

Implementation for abstract base class. Calls cosr().

Reimplemented from DtReflectedControlObject.

const DtReflectedControlObject* DtReflectedBulkEnvironmentProcess::reflectedControlObject ( ) const

Returns the reflected control object this bulk object wraps.

virtual unsigned DtReflectedBulkEnvironmentProcess::numberOfSubObjects ( ) const
virtual

Returns the number of sub-objects.

virtual void DtReflectedBulkEnvironmentProcess::setActiveSubObject ( const DtEntityIdentifier &  entityId)
virtual

Sets the active sub-object, which dictates the state repository to be returned by any of the state repository accessor methods.

virtual void DtReflectedBulkEnvironmentProcess::resetActiveSubObject ( )
virtual

Resets the active sub-object to be the first one.

virtual bool DtReflectedBulkEnvironmentProcess::incrementActiveSubObject ( )
virtual

Makes the next sub-object in the list the active sub-object.

If the end of the list has been reached, wraps to the beginning and returns false.

virtual void DtReflectedBulkEnvironmentProcess::addNewSubObjectCallback ( DtControlObjectCallbackFunction  cb,
void *  userData 
)
virtual

Registers for callbacks for addition of new sub-objects.

virtual void DtReflectedBulkEnvironmentProcess::removeNewSubObjectCallback ( DtControlObjectCallbackFunction  cb,
void *  userData 
)
virtual

Registers for callbacks for addition of new sub-objects.

virtual void DtReflectedBulkEnvironmentProcess::addPostUpdateCallback ( DtControlObjectCallbackFunction  cb,
void *  userData 
)
virtual

Registers for callbacks for updates to the current active sub-object.

Reimplemented from DtReflectedControlObject.

virtual void DtReflectedBulkEnvironmentProcess::removePostUpdateCallback ( DtControlObjectCallbackFunction  cb,
void *  userData 
)
virtual

Registers for callbacks for updates to the current active sub-object.

Reimplemented from DtReflectedControlObject.

virtual void DtReflectedBulkEnvironmentProcess::addAboutToBeRemovedCallback ( DtControlObjectCallbackFunction  cb,
void *  userData 
)
virtual

Registers for callbacks for removal of a sub-object.

virtual void DtReflectedBulkEnvironmentProcess::removeAboutToBeRemovedCallback ( DtControlObjectCallbackFunction  cb,
void *  userData 
)
virtual

Registers for callbacks for removal of a sub-object.

static void DtReflectedBulkEnvironmentProcess::postControlObjectUpdateCallback ( DtReflectedControlObject obj,
void *  userData 
)
static
virtual void DtReflectedBulkEnvironmentProcess::processControlObjectUpdated ( DtReflectedControlObject obj)
virtual

Process updates to bulk control object. Updates the sub-objects.

virtual void DtReflectedBulkEnvironmentProcess::updateExtensions ( )
virtual

Extracts the extended environmental process state information, if present, from the sub-object state repositories.

Reimplemented from DtReflectedControlObject.

DtReflectedBulkEnvironmentProcess& DtReflectedBulkEnvironmentProcess::operator= ( const DtReflectedBulkEnvironmentProcess orig)
private

Member Data Documentation

DtReflectedControlObject* DtReflectedBulkEnvironmentProcess::myReflectedObject
protected
std::list<CallbackInfo> DtReflectedBulkEnvironmentProcess::myNewSubObjectCallbacks
protected
SubObjectMap DtReflectedBulkEnvironmentProcess::mySubObjects
protected
DtEntityIdentifier DtReflectedBulkEnvironmentProcess::myActiveSubObject
protected

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

Document ID: Generated on Tue Mar 8 22:13:38 EST 2016 from SVN revision 162938
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)