include/vrfExtObjects/reflCtrlObj.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2003 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: reflCtrlObj.h,v $ $Revision: 1.10 $ $State: Exp $
*********************************************************************/

#ifndef REFLCTRLOBJ_H
#define REFLCTRLOBJ_H

#if DtHLA
   #include <vl/hReflectedObj.h>
   #define DtCOReflectedObjectType DtReflectedObject
#elif DtDIS
   #include <vl/dReflEnvProc.h>
   #define DtCOReflectedObjectType DtReflectedEnvironmentProcess
#elif DtTENA
   #include <vl/tReflEnvProc.h>
   #define DtCOReflectedObjectType DtReflectedEnvironmentProcess
#else
#  pragma message ( "No protocol defined." )
#endif

#include <vrfExtObjects/controlObjSR.h>

// Callback function that takes a DtReflectedControlObject 
// and usr data.

class DtReflectedControlObject;

typedef void (*DtControlObjectCallbackFunction)
(
   DtReflectedControlObject* obj, void* userData
);

class DtExerciseConn;

#include <vrfExtObjects/vrfExtObjectsDefines.h>
class DT_DLL_vrfExtObjects DtReflectedControlObject : public DtCOReflectedObjectType
{
public:
#if DtHLA
   // constructor
   DtReflectedControlObject(DtHlaObject* obj, DtExerciseConn* conn);
#elif (DtDIS || DtTENA)
   // constructor
   DtReflectedControlObject
   (
      DtExerciseConn* conn,
      const DtEntityIdentifier& id,
      const DtEntityType& type
   );
#else
#  pragma message ( "No protocol defined." )
#endif

   // destructor
   virtual ~DtReflectedControlObject();

   // Returns ptr to environmentProcessStateRepository --
   // through which you can inspect current state info.
   virtual DtControlObjectRepository* controlObjectStateRep() const;

   // Synonym for environmentStateRep.
   virtual DtControlObjectRepository* cosr() const;

   // Implementation for abstract base class.  Calls cosr().
   virtual DtStateRepository* stateRep() const;

#if DtDIS
   // Process an environment process state PDU.  
   // Calls processEnvironmentProcess().
   virtual void processStateMessage(const DtStateMsg& msg);
#endif

   // Get the next and previous elements in the reflected 
   // cwenvironment process list.
   virtual DtReflectedControlObject* nextCO() const;
   virtual DtReflectedControlObject* prevCO() const;

   // Get the next and previous elements, wrap at the ends of the list.
   virtual DtReflectedControlObject* wrapNextCO() const;
   virtual DtReflectedControlObject* wrapPrevCO() const;

   // Environment Process callback registration/deregistration.
   virtual void addPostUpdateCallback
   (
      DtControlObjectCallbackFunction cb, void* userData
   );
   virtual void removePostUpdateCallback
   (
      DtControlObjectCallbackFunction cb, void* userData
   );

   static void postUpdateCallback
   (
      DtReflectedControlObject* obj, void* userData
   );

   virtual void processPostUpdateCallback(DtReflectedControlObject* obj);

   // updateExtensions()
   // extracts the extended environmental process state information,
   // if present, from the state repository
   virtual void updateExtensions();

private:
   // not implemented.
   DtReflectedControlObject(const DtReflectedControlObject& orig);
   DtReflectedControlObject& operator=(const DtReflectedControlObject& orig);

};

#endif