include/vrfExtObjects/refCtrlObjList.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2011 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

#pragma once

#include <vl/refEnvList.h>

#include <vrfExtObjects/reflCtrlObj.h>
#include <vl/dataInter.h>

// class DtReflectedControlObjectList:
//
// Instances of DtReflectedControlObjectList manage the list of 
// remote environmental processes in the exercise.

#include <vrfExtObjects/vrfExtObjectsDefines.h>
class DT_DLL_vrfExtObjects DtReflectedControlObjectList : public DtReflectedEnvironmentProcessList
{

public:

   // Constructor - obtains the set of object classes to subscribe
   // to from the exConn's fomMapper.
   DtReflectedControlObjectList(DtExerciseConn* exConn);

#if DtHLA
   // Constructor - obtains the set of object classes to subscribe
   // to from the exConn's fomMapper.
   DtReflectedControlObjectList(DtExerciseConn* exConn,
     const DtDDMRegionSet* regionSetToUse);

   // Constructor - only subscribe to the RTI::ObjectClassHandles 
   // in handleList.
   DtReflectedControlObjectList ( DtExerciseConn* exConn, const DtList *handleList,
     const DtDDMRegionSet* regionSetToUse = 0);
#endif

   // destructor
   virtual ~DtReflectedControlObjectList();

#if DtHLA
#if DtHLA_1516
   virtual DtReflectedControlObject* lookupCO(RTI::ObjectInstanceHandle id);
#else
   virtual DtReflectedControlObject* lookupCO(RTI::ObjectHandle id);
#endif
#elif (DtDIS || DtTENA)
   // Look up environmental process by identifier.
   virtual DtReflectedControlObject* lookup(const DtObjectId& id);
#else
#  pragma message ( "No protocol defined." )
#endif

   // Get the first/last environmental process in the list.
   virtual DtReflectedControlObject* firstCO() const;
   virtual DtReflectedControlObject* lastCO() const;

   // Look up an environmental process object by DtGlobalObjectDesignator.
   virtual DtReflectedControlObject* lookupCO(
      const DtGlobalObjectDesignator& designator);

   // Environmental process added callback registration/deregistration.
   virtual void addControlObjectAdditionCallback
   (
      DtControlObjectCallbackFunction cb, void* userData
   );
   virtual void removeControlObjectAdditionCallback
   (
      DtControlObjectCallbackFunction cb, void* userData\
   );

   // Environmental process removed callback registration/deregistration.
   virtual void addControlObjectRemovalCallback
   (
      DtControlObjectCallbackFunction cb, void* userData
   );
   virtual void removeControlObjectRemovalCallback
   (
      DtControlObjectCallbackFunction cb, void* userData
   );

protected:

   // copy constructor
   DtReflectedControlObjectList
   (
      const DtReflectedControlObjectList& orig
   );

   // assignment operator
   DtReflectedControlObjectList& operator=
   (
      const DtReflectedControlObjectList& rhs
   );

   static void dataInteractionCallback(DtDataInteraction* i, void* usr);

   virtual void processDataInteraction(DtDataInteraction* i);

#if DtHLA
   virtual DtReflectedObject* newReflectedObject(DtHlaObject* obj) const;
#elif (DtDIS || DtTENA)
   // Create a new reflected control object.
   virtual DtReflectedEnvironmentProcess* newReflectedEnvironmentProcess
   (
      const DtEntityIdentifier& id,
      const DtEntityType& type
   ) const;
#else
#  pragma message ( "No protocol defined." )
#endif
};