propertyInterface.h

Go to the documentation of this file.

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


#pragma once

#include <readerWriter/readerWriterDefines.h>
#include <readerWriter/readerWriterFactory.h>
#include <readerWriter/rwString.h>
#include <readerWriter/rwVector.h>
#include <vlutil/vlTime.h>

#include <string>
#include <boost/optional.hpp>

// Must be incremented whenever the encoding for properties changes.
const int DtPropertyVersion = 1;

class DT_DLL_readerWriter DtPropertyInterface
{
public:

   enum MergeFlags
   {
      Replace = 0x00000001,   // Replace contents wholesale
      MinimalSimilarityCheck = 0x00000002, // Do not do a stringent compare on items -- allows for partial item replacement
      RollUp = 0x00000004,    // This will add up numerical items and keep string items if the values are similar, else it will remove.
                              // Any item that exists in the to be merged that does not exist in the source will be added as long as
                              // the structures are similar, else they will be ignored
      AddMissing = 0x00000008,// Any items missing will be added to the target
      KeepPublishedSettings = 0x00000010 // Keeps the current setting for whether the property is published
   };

   virtual ~DtPropertyInterface();

      
   template <typename ValueType>
   boost::optional<ValueType> propertyValue() const;

   template <typename ValueType>
   bool setPropertyValue(ValueType val);

      
   virtual const DtPropertyInterface* findPropertyInterface(const DtString& propertyName) const
   {
      return 0;
   }

   virtual DtPropertyInterface* findPropertyInterface(const DtString& propertyName)
   {
      return 0;
   }

      
   template <typename SpecificPropType>
   const SpecificPropType* findProperty(const DtString& propertyName) const;
   template <typename SpecificPropType>
   SpecificPropType* findProperty(const DtString& propertyName);

      
   template <typename ValueType>
   boost::optional<ValueType> findPropertyValue(const DtString& propertyName) const;

   template <typename ValueType>
   bool findAndSetPropertyValue(const DtString& propertyName, ValueType val);

      
   virtual bool addProperty(DtPropertyInterface* property)
   {
      return false;
   }

   template <typename SpecificPropType>
   SpecificPropType* addNewProperty(const DtString& propertyName);

      
   virtual bool removeProperty(const DtString& propertyName)
   {
      return false;
   }

   virtual bool removeProperty(const DtPropertyInterface* property)
   {
      return false;
   }

   virtual void copy(const DtPropertyInterface& rhs) = 0;

      
   virtual char* encode(char*) const = 0;

   virtual const char* decode(const char*) = 0;

   virtual void getSize(int& size) const = 0;

   int getSize() const;

   virtual int hlaAlignment() const = 0;

   virtual const char* propertyType() const = 0;

   virtual DtSymbolString propertyName() const = 0;

   virtual void setPropertyName(const DtString& propertyName) = 0;

   virtual DtString stringRep(const DtString& root = "") const = 0;


      
   virtual DtReaderWriter* readerWriter() = 0;
   virtual const DtReaderWriter* readerWriter() const = 0;

   virtual bool isSimilarProperty(const DtPropertyInterface* rhs, bool strict = true) const;

   //
   virtual bool merge(const DtPropertyInterface& target, MergeFlags,
      const DtMergePath& path = DtMergePath(), const std::set<DtString>& ignore = std::set<DtString>()) = 0;

   virtual DtlObjPtr getData(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings) = 0;

   virtual void writePublishInformation(std::string& fp, int indentLevel);

   virtual bool isPublishedArg(DtlObjPtr arg, unsigned& disVarRecType);

   virtual void copyPublishingSettings(const DtPropertyInterface& prop);

   virtual void setKeepPublishingSettings(bool keep) = 0;
   virtual bool keepPublishingSettings() const = 0;

   virtual bool isUpdateNeeded(DtTime t) const = 0;

   virtual bool hasReceivedUpdateSince(DtTime t) const = 0;

   virtual DtTime updateClockTime() const = 0;

   virtual bool isPublished() const = 0;
   virtual void setIsPublished(bool isPub) = 0;

   virtual unsigned disRecordType() const = 0;
   virtual void setDisRecordType(unsigned recType) = 0;

   virtual void reset() = 0;

   virtual bool isDebugEnabled() const = 0;
   virtual void setDebugEnabled(bool en) = 0;

   virtual void processPublicationArgs(DtlObjPtr arg);
   virtual void processPublicationArg(DtlObjPtr arg);
};

#define propertyInterface_INL_
#include "propertyInterface.inl"
#undef propertyInterface_INL_