controlObjectRepository.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/controlObjectBaseRepository.h>
#include <readerWriter/rwProperties.h>
#include <readerWriter/noArgumentCallbackList.h>
#if DtHLA
#include <vrfExtObjects/stateRepositoryWithExtendedAttributesHLA.h>
#else
#include <vrfExtObjects/stateRepositoryWithExtendedAttributesDIS.h>
#endif
#include <vector>


class DT_DLL_vrfExtObjects DtControlObjectRepository :
   public makVrfVrlinkExtToolkit::DtStateRepositoryWithExtendedAttributes<DtControlObjectBaseRepository>
{

public:

   typedef void (*PropertyDecoder) (const char* buffer, unsigned size, int version, void* usr);
   typedef void (*PropertyEncoder) (std::vector<char>& buffer, void* usr);

   DtControlObjectRepository();

   virtual ~DtControlObjectRepository() override;

   DtControlObjectRepository(const DtControlObjectRepository& orig);

   virtual void initialize(DtRwProperties* stateProps, DtRwProperties* paramProps);

   virtual void initialize(const DtRwProperties& stateProps, const DtRwProperties& paramProps);

   virtual void initialize();

   virtual bool isInitialized() const;

   DtControlObjectRepository& operator=(
      const DtControlObjectRepository& orig);

   virtual DtStateRepository *clone(bool copy = false) const override;

   virtual int compare(const DtControlObjectRepository* rhs);

   virtual const DtRwProperties& stateProperties() const
   {
      if (myStateProperties)
      {
         return *myStateProperties;
      }

      return DtRwProperties::emptyProperties();
   }

   virtual const DtRwProperties& parameterProperties() const
   {
      if (myParameterProperties)
      {
         return *myParameterProperties;
      }

      return DtRwProperties::emptyProperties();
   }

   virtual bool sensorsKilled() const;
   virtual void setSensorsKilled(bool killed);

#if DtDIS
   void mapPropertiesToRecordTypes(const DtRwProperties* properties,
      std::map<unsigned, DtString>& recTypesToAttrNames);
#endif
      
   static DtEnvironmentProcessRepository* create();

   virtual void updateExtensions() override;

   virtual bool updatePropertiesFromAttributes(bool updatesOnly = true);

   virtual void updateAttributesFromProperties();

   virtual void addPropertyDecoder(const DtString& propName, PropertyDecoder decoder, void* usr,
      unsigned disRecordType = 0);

   virtual void addPropertyEncoder(const DtString& propName, PropertyEncoder encoder, void* usr,
      unsigned disRecordType = 0);

   virtual void addVrfObjectDataDecoder( const DtString& propName, PropertyDecoder decoder, void* usr,
      unsigned disRecordType = 0);

   virtual void addVrfObjectDataEncoder( const DtString& propName, PropertyEncoder encoder, void* usr,
      unsigned disRecordType = 0);

   virtual void removePropertyEncodersAndDecoders();

   virtual bool createVrfObjectDataMessage() override;

   virtual void giveOwernshipOfProperties();

   virtual DtTime lastPropertyEncodeTime() const { return myLastEncodeTime; }

   virtual DtTime lastPropertyDecodeTime() const { return myLastDecodeTime; }


   virtual void addPropertyUpdatedCallback(
      DtNoArgumentCallbackList::DtCallbackFunctionType fcn, void* usrData);
   virtual void removePropertyUpdatedCallback(
      DtNoArgumentCallbackList::DtCallbackFunctionType fcn, void* usrData);   

protected:

   virtual void initializeVrfObjectDataProperties();

   virtual void encodePropertyIfNeeded(const DtSymbolString& propName, DtReaderWriter* propRw);

protected:

   DtRwProperties* myStateProperties;
   DtRwProperties* myParameterProperties;
   DtEntityType myLastCheckedEnvType;
   bool myOwnsProperties;

   bool myIsInitialized;

   struct PropertyDecoderInfo
   {
      PropertyDecoderInfo() : decoder(0), usr(0) {};
      PropertyDecoderInfo(const DtString& pn, PropertyDecoder d, void* u)
         : propertyName(pn), decoder(d), usr(u) {};

      DtString propertyName;
      PropertyDecoder decoder;
      void* usr;
   };

   struct PropertyEncoderInfo
   {
      PropertyEncoderInfo() : encoder(0), usr(0) {};
      PropertyEncoderInfo(const DtString& pn, PropertyEncoder e, void* u)
         : propertyName(pn), encoder(e), usr(u) {};

      DtString propertyName;
      PropertyEncoder encoder;
      void* usr;
   };

   std::list<PropertyDecoderInfo> myVrfObjectDataDecoders;
   std::list<PropertyDecoderInfo> myAdditionalDecoders;
   std::list<PropertyEncoderInfo> myAdditionalEncoders;

   std::vector<char> myPropertyBuffer;
   DtClock myClock;
   DtTime myLastEncodeTime;
   DtTime myLastDecodeTime;

   bool mySensorsKilled;

   bool myReceivedVrfObjectDataVersion;
   bool myReceivedVrfPropertyVersion;

   mutable int myPropertyVersion;

   mutable DtRangeItems myRangeItemsCache;

   DtNoArgumentCallbackList myPropertyUpdatedCallbacks;
};