stateRepository.h

Go to the documentation of this file.

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


#pragma once

#include <vl/globalObjectDesignator.h>
#include <vlutil/vlMachineTypes.h>
#include <vl/objectId.h>
#include <vl/hlaObject.h>

#ifdef DtDIS
#include <vl/attributeRecordSet.h>
#endif

#include <iosfwd>
#include <map>
class DtStateRepositoryExtension;

typedef DtStateRepositoryExtension* (*DtSrExtCreatorFnc)();


#ifdef DtHLA
class DT_DLL_VL DtGenericAttributeInfo
{
public:

   DtGenericAttributeInfo() : wasUpdated(false) {}
   DtGenericAttributeInfo(const DtGenericAttributeInfo& other)
      : handle(other.handle)
      , buffer(other.buffer)
      , wasUpdated(other.wasUpdated){}

   ~DtGenericAttributeInfo() {}

   RTI::AttributeHandle handle;
   std::vector<char> buffer;
   bool wasUpdated;
};
#endif

class DT_DLL_VL DtStateRepository
{
public:

   DtStateRepository();

   DtStateRepository(const DtStateRepository& orig);

   virtual ~DtStateRepository();

   DtStateRepository& operator=(const DtStateRepository& orig);

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

   virtual void printData() const;

   virtual void printDataToStream(std::ostream& stream) const;

#if DtHLA
   virtual void setGlobalId(const DtString& id);
   virtual const DtString& globalId() const;
#elif DtDIS
   virtual void setGlobalId(const DtGlobalObjectDesignator& id);
   virtual const DtGlobalObjectDesignator& globalId() const;
#endif

#if DtHLA

   virtual void setLocalId(const DtObjectId& id);
   virtual const DtObjectId& localId() const;

#endif


#ifdef DtDIS




   virtual void setAttributeRecords(const DtAttributeRecordSet& records);

   virtual void setAttributeRecords(const DtStandardVariableRecordPtrVector& records);
   
   virtual const DtAttributeRecordSet& attributeRecordSet() const;

   virtual DtAttributeRecordSet& attributeRecordSet();

   virtual const DtStandardVariableRecordPtrVector& attributeRecords() const;

   virtual const DtStandardVariableRecordPtrVector& attributeRecords(unsigned int recordType) const;

   virtual DtStandardVariableRecord* attributeRecord(unsigned int recordType) const;

   virtual int removeAttributeRecord(unsigned int recordType, bool removeAll = true);

   virtual DtStandardVariableRecordPtrVector& getAttributeRecords(unsigned int recordType,
      DtStandardVariableRecordPtrVector& vec) const;

   virtual DtStandardVariableRecordPtrVector& getAttributeRecords(DtStandardVariableRecordPtrVector& vec) const;

   virtual void addAttributeRecord( DtStandardVariableRecord* record );

   virtual void addAttributeRecord(std::unique_ptr<DtStandardVariableRecord> record);

   virtual void clearAttributeRecords();
#endif
   
   static bool addStateRepositoryExtension(DtString srExtName, DtSrExtCreatorFnc fnc);

   virtual DtStateRepositoryExtension* stateRepositoryExtension(DtString srExtName) const;

   virtual std::vector<DtString> stateRepositoryExtensionNames() const;

   virtual void setStateRepositoryExtensions(std::map<DtString, DtStateRepositoryExtension*> extensions);

   virtual const std::map<DtString, DtStateRepositoryExtension*> stateRepositoryExtensions() const;

#ifdef DtHLA
   // The following functions are related to unknown attribute encoding and decoding.
   
   virtual bool publishesAttribute(const RTI::AttributeHandle& val) const;

   virtual void setAttributeByHandle(const RTI::AttributeHandle& attrHdl, const char* attrValue, unsigned size);

   virtual const char* getAttributeByHandle(const RTI::AttributeHandle& attrHdl, unsigned& size) const;

   virtual void setAttributeByName(const DtString& attrName, const char* attrValue, unsigned size, DtHlaObject* hlaObj);

   virtual const char* getAttributeByName(const DtString& attrName, unsigned& size, DtHlaObject* hlaObj) const;


   virtual const char* getAttributeByHandleIfUpdated(const RTI::AttributeHandle& attrHdl, unsigned& size) const;

#endif
   

#ifdef DtDIS
   virtual unsigned int numberOfAttributeRecords() const;
#endif

#ifdef DtHLA
   DtString myGlobalId;
#elif DtDIS
   DtGlobalObjectDesignator myGlobalId;
#endif

#ifdef DtHLA
   DtObjectId myLocalId;

   std::map<RTI::AttributeHandle, DtGenericAttributeInfo*> myAttributesByHandle;
#endif

#ifdef DtDIS
   DtAttributeRecordSet myAttributeRecords;
   mutable DtStandardVariableRecordPtrVector myReturnedRecords;
#endif
   typedef std::map<DtString, DtStateRepositoryExtension*> DtStateRepositoryExtensionMap;
   DtStateRepositoryExtensionMap myStateRepositoryExtensionMap;

   static std::map<DtString, DtSrExtCreatorFnc> theStateRepositoryExtensionCreatorMap;
};

DT_DLL_VL std::ostream & operator << (std::ostream &str, const DtStateRepository &sr);