include/vrfExtObjects/reflExtAgg.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2004 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: reflExtAgg.h,v $ $Revision: 1.14 $ $State: Exp $
*******************************************************************************/

#ifndef REFLEXTAGG_H
#define REFLEXTAGG_H

#if DtHLA
   #include <vl/hReflectedObj.h>
   #define DtAggReflectedObjectType DtReflectedObject
#elif DtDIS
   #include <vl/dReflectedAgg.h>
   #define DtAggReflectedObjectType DtReflectedAggregate
#elif DtTENA
   #include <vl/tReflectedAgg.h>
   #define DtAggReflectedObjectType DtReflectedAggregate
#else
#  pragma message ( "No protocol defined." )
#endif

#include <vrfExtObjects/extAggSR.h>

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

class DtReflectedExtAggregate;

typedef void (*DtExtAggregateCallbackFunction)
(
   DtReflectedExtAggregate* obj, void* userData
);

class DtExerciseConn;

#include <vrfExtObjects/vrfExtObjectsDefines.h>
class DT_DLL_vrfExtObjects DtReflectedExtAggregate : public DtAggReflectedObjectType
{

public:

#if DtHLA
   DtReflectedExtAggregate
   (
      DtHlaObject* obj,
      DtExerciseConn* conn
   );
   DtReflectedExtAggregate(DtExerciseConn* conn, DtAggregateStateRepository* esrToUse);
#elif (DtDIS || DtTENA)
   // constructor
   DtReflectedExtAggregate
   (
      DtExerciseConn* conn,
      const DtEntityIdentifier& id,
      const DtEntityType& type
   );
#else
#  pragma message ( "No protocol defined." )
#endif

   // destructor
   virtual ~DtReflectedExtAggregate();

   // Returns a pointer to an aggregate state repository through which you can 
   // inspect current state info.
   virtual DtExtAggregateStateRepository* extAggregateStateRep() const;

   // Synonym for extAggregateStateRep.
   virtual DtExtAggregateStateRepository* easr() const;

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

#if DtDIS
   // Process an aggregate state PDU.  
   // Calls DtReflectedAggregate::processStateMessage().
   virtual void processStateMessage(const DtStateMsg& msg);
#endif

   // Get the next and previous elements in the reflected aggregate list.
   virtual DtReflectedExtAggregate* nextEA() const;
   virtual DtReflectedExtAggregate* prevEA() const;

   // Get the next and previous elements, wrap at the ends of the list.
   virtual DtReflectedExtAggregate* wrapNextEA() const;
   virtual DtReflectedExtAggregate* wrapPrevEA() const;

   // Aggregate callback registration/deregistration.
   virtual void addPostUpdateCallback
   (
      DtExtAggregateCallbackFunction cb, void* userData
   );
   virtual void removePostUpdateCallback
   (
      DtExtAggregateCallbackFunction cb, void* userData
   );

   static void postUpdateCallback
   (
      DtReflectedExtAggregate* agg, void* userData
   );

   virtual void processPostUpdateCallback(DtReflectedExtAggregate* agg);

   virtual void updateExtensions();

   // Overridden from bast class to make public.
   virtual void processPostUpdateCallbacks();

private:

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

   // assignment operator
   DtReflectedExtAggregate& operator=(const DtReflectedExtAggregate& orig);

};

#endif