reflectedExtEntityList.h

Go to the documentation of this file.

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


#pragma once

#include <vrfExtObjects/dllExport.h>
#include <vrfExtObjects/reflectedExtEntity.h>
#include <vrfExtObjects/extendedAttributesInitializer.h>
#include <vl/reflectedEntityList.h>
#include <vl/dataInteraction.h>
#include <vlutil/vlHashlist.h>
#include <vlutil/vlSmartPointers.h>

class DtRwProperties;

class DT_DLL_vrfExtObjects DtReflectedExtEntityList : public DtReflectedEntityList
{

public:

   DtReflectedExtEntityList(DtExerciseConn* exConn,
      const DtRwProperties& stateProps = DtRwProperties::emptyProperties(),
      const DtRwProperties& paramProps = DtRwProperties::emptyProperties());

#if DtHLA
   DtReflectedExtEntityList(DtExerciseConn* exConn,
      const DtDDMRegionSet* regionSetToUse,
      const DtRwProperties& stateProps = DtRwProperties::emptyProperties(),
      const DtRwProperties& paramProps = DtRwProperties::emptyProperties());

   DtReflectedExtEntityList(DtExerciseConn* exConn,
      const DtList *handleList, const DtDDMRegionSet* regionSetToUse = 0,
      const DtRwProperties& stateProps = DtRwProperties::emptyProperties(),
      const DtRwProperties& paramProps = DtRwProperties::emptyProperties());

   static void DiGuyObjectUpdateCb(DtReflectedDIGuyObject* diGuyObject, void* usr );
#endif

   virtual ~DtReflectedExtEntityList() override;

   virtual void setPropertyPrototypes(const DtRwProperties& stateProps,
      const DtRwProperties& paramProps);
   
   virtual void setWaitForVrfExtendedData(bool);
   
   virtual bool waitForVrfExtendedData() const;

#if DtHLA
   #if DtHLA_1516
      virtual DtReflectedExtEntity* lookupEE(RTI::ObjectInstanceHandle id);
   #else
      virtual DtReflectedExtEntity* lookupEE(RTI::ObjectHandle id);
   #endif

   virtual DtReflectedExtEntity* lookupEE(const DtGlobalObjectDesignator& objName);
#else // DtDIS
   virtual DtReflectedExtEntity* lookup(const DtObjectId& id);
#endif

   virtual DtReflectedExtEntity* firstEE() const;
   
   virtual DtReflectedExtEntity* lastEE() const;

   virtual void addEntityAdditionCallback (
      DtExtEntityCallbackFunction cb, void* userData);

   virtual void removeEntityAdditionCallback (
      DtExtEntityCallbackFunction cb, void* userData);

   virtual void addEntityRemovalCallback (
      DtExtEntityCallbackFunction cb, void* userData);

   virtual void removeEntityRemovalCallback (
      DtExtEntityCallbackFunction cb, void* userData);

   static void setTimeoutRequestTime(DtTime t);
   static DtTime timeoutRequestTime();

   static void setInitializer(DtExtendedAttributesInitializerPtr init);
   
   static DtExtendedAttributesInitializerPtr initializer();
   
   static void setRequestVrfObjectData(bool);
   static bool shouldRequestVrfObjectData();

protected:

   void initializeExtendedProperties();

   void processVrfObjectStateUpdateMessage(DtDataInteraction* interaction);
   void processVrfObjectDataMessage(DtDataInteraction* interaction);

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

   virtual void processDataInteraction(DtDataInteraction* i);

#if DtHLA
   virtual DtReflectedObject *
   newReflectedObject(DtHlaObject *obj) const override;
   virtual void addToObjectList(DtReflectedObject *refObj) override;
#else // DtDIS
   virtual DtReflectedEntity *
   newReflectedEntity(const DtEntityIdentifier &id,
                      const DtEntityType &type) const override;
#endif

   virtual void cleanupObjectDataMessageHashList();

   virtual bool readyToAdd(DtReflectedObject *obj) override;
   
   virtual bool setupVrfObjectData(DtReflectedObject* object);

   virtual bool addObjectIfWaitingForVrfMessage(DtReflectedExtEntity*);

   virtual void requestVrfObjectData(DtReflectedObject* object);

   virtual bool timeOutVrfObjectDataRequest(DtReflectedObject* obj);

   virtual void removeAndDelete(DtReflectedObject* obj, const char* msg = NULL) override;

   virtual void diguyExtensionsSetup(); 
   
#if DtDIS
   virtual void processObjectAdditionCallbacks(DtReflectedObject *object) override;
#endif

   virtual void entityAdded(DtReflectedEntity *) override;

   static void entityUpdatedCallback(DtReflectedEntity* entity, void* userData);
   virtual void entityUpdated(DtReflectedEntity*);

   static void entityRemovedCallback(DtReflectedEntity* entity, void* userData);
   virtual void entityRemoved(DtReflectedEntity*);

private:

   DtReflectedExtEntityList(const DtReflectedExtEntityList& orig);
   
   DtReflectedExtEntityList& operator=(const DtReflectedExtEntityList& rhs);

protected:

   DtHashlist myObjectDataMessageHashlist;

   DtHashList myObjectDataMessageRequestList;

#if DtDIS
   DtHashList myWaitingForVrfObjectData;
#else // DtHLA
   DtObjectIdHashList myWaitingForVrfObjectData;
#endif

   static DtTime theTimeoutRequestTime;

   bool myWaitForVrfExtendedData;

   DtRwProperties myStatePropertiesPrototype;
   DtRwProperties myParameterPropertiesPrototype;

   static DtExtendedAttributesInitializerPtr theInitializer;

   static bool theRequestVrfObjectData;
};