rwProperty.h

Go to the documentation of this file.

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


#pragma once

#include <readerWriter/readerWriterDefines.h>
#include <readerWriter/propertyInterface.h>
#include <readerWriter/rwBoolean.h>
#include <readerWriter/rwString.h>
#include <readerWriter/rwInt.h>
#include <readerWriter/rwReal.h>
#include <readerWriter/rwVector.h>
#include <readerWriter/readerWriterFactory.h>
#include <vlutil/vlTime.h>

#include <string>

template <typename _RwType>
class DtRwProperty : public _RwType, public DtPropertyInterface
{
private:
   DtRwProperty();

public:

   DtRwProperty(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
   DtRwProperty(const DtString& name, const DtRwProperty& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwProperty& operator=(const DtRwProperty& orig);
   virtual ~DtRwProperty();

   virtual void copy(const DtPropertyInterface& rhs);


   virtual char* encode(char*) const;

   virtual const char* decode(const char*);

   virtual void getSize(int& size) const;

   virtual int hlaAlignment() const;

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

   virtual const char* propertyType() const;

   virtual DtSymbolString propertyName() const { return _RwType::name(); };

   virtual void setPropertyName(const DtString& propertyName) { _RwType::setName(propertyName); };

   virtual void getSelf(DtlObjPtr args,
      const DtReaderWriter::SearchPaths& searchPaths = DtReaderWriter::SearchPaths(),
      const DtVariableBindingsList& variableBindings = DtReaderWriter::nullVariableReference());

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

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

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

   virtual DtPropertyInterface* property();
   virtual const DtPropertyInterface* property() const;

   virtual void recordUpdateTime() const;

   virtual bool isUpdateNeeded(DtTime t) const;

   virtual bool hasReceivedUpdateSince(DtTime t) const;

   virtual DtTime updateClockTime() const;

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

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

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

   virtual void reset();

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

protected:

   DtClock myClock;
   mutable DtTime myUpdateTime;
   unsigned myDisRecordType;
   bool myIsPublished;
   bool myKeepPublishingSettingsOnCopy;

   bool myDebugEnabled;
};

enum DtThresholdAlgorithm
{
   DtThresholdNone = 0,
   DtThresholdPercent = 1,
   DtThresholdValue = 2
};

template <typename _RwType>
class DtRwPropertyWithThreshold : public DtRwProperty<_RwType>
{
private:
   DtRwPropertyWithThreshold();

public:

   DtRwPropertyWithThreshold(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyWithThreshold(const DtString& name, const DtRwPropertyWithThreshold& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyWithThreshold& operator=(const DtRwPropertyWithThreshold& orig);
   virtual ~DtRwPropertyWithThreshold();

   virtual char* encode(char*) const;

   virtual bool isUpdateNeeded(DtTime t) const;

   virtual void setThresholdAlgorithm(DtThresholdAlgorithm alg);
   virtual DtThresholdAlgorithm thresholdAlgorithm() const;

   virtual void setDefaultThresholdAlgorithm(DtThresholdAlgorithm alg);

   virtual void setThreshold(double value);
   virtual double threshold() const;

   static void setDefaultThreshold(double value);

   virtual void setMaxUpdateInterval(DtTime interval);
   virtual DtTime maxUpdateInterval() const;

   static void setDefaultMaxUpdateInterval(DtTime interval);

   virtual void setMaxUnchangedUpdateInterval(DtTime interval);
   virtual DtTime maxUnchangedUpdateInterval() const;

   static void setDefaultMaxUnchangedUpdateInterval(DtTime interval);

   virtual void processPublicationArg(DtlObjPtr arg);

   virtual void copyPublishingSettings(const DtPropertyInterface& prop);

   virtual double percentChanged() const;

   virtual double amountChanged() const;

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

protected:
   
   mutable _RwType myLastEncodedValue;

   mutable DtTime myLastEncodeTime;

   static DtThresholdAlgorithm myDefaultThresholdAlgorithm;
   DtThresholdAlgorithm myThresholdAlgorithm;

   static double myDefaultThreshold;
   double myThreshold;

   static DtTime myDefaultMaxUpdateInterval;
   DtTime myMaxUpdateInterval;

   static DtTime myDefaultMaxUnchangedUpdateInterval;
   DtTime myMaxUnchangedUpdateInterval;
};

class DT_DLL_readerWriter DtRwPropertyString : public DtRwProperty<DtRwString>
{
public:
   DtRwPropertyString(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyString(const DtString& name, const DtString& value,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyString(const DtString& name, const DtRwPropertyString& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyString(const DtRwPropertyString& orig,
      DtReaderWriterRegistry* parentRegistry = 0);

   DtRwPropertyString& operator=(const DtRwPropertyString& orig);

   virtual ~DtRwPropertyString();
};

class DT_DLL_readerWriter DtRwPropertySizedString : public DtRwPropertyString
{
public:
   DtRwPropertySizedString(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertySizedString(const DtString& name, const DtString& value,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertySizedString(const DtString& name, const DtRwPropertySizedString& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertySizedString(const DtRwPropertySizedString& orig,
      DtReaderWriterRegistry* parentRegistry = 0);

   virtual ~DtRwPropertySizedString();

   virtual char* encode(char*) const;

   virtual const char* decode(const char*);

   virtual void getSize(int& size) const;

   virtual int hlaAlignment() const;

   const char* readerWriterType() const;

   static const char* theXmlType();

   virtual const char* xmlType() const
   {
      return theXmlType();
   }
};

#define rwProperties_INL_
#include <readerWriter/rwProperty.inl>
#undef rwProperties_INL_

class DT_DLL_readerWriter DtRwPropertyBoolean : public DtRwProperty<DtRwBoolean>
{
public:
   DtRwPropertyBoolean(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyBoolean(const DtString& name, bool value,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyBoolean(const DtString& name, const DtRwPropertyBoolean& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyBoolean(const DtRwPropertyBoolean& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyBoolean& operator=(const DtRwPropertyBoolean& orig);
   virtual ~DtRwPropertyBoolean();
};

class DT_DLL_readerWriter DtRwPropertyInt : public DtRwPropertyWithThreshold<DtRwInt>
{
public:
   DtRwPropertyInt(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyInt(const DtString& name, int value,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyInt(const DtString& name, const DtRwPropertyInt& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyInt(const DtRwPropertyInt& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyInt& operator=(const DtRwPropertyInt& orig);
   virtual ~DtRwPropertyInt();
   virtual bool isSimilarProperty(const DtPropertyInterface* rhs, bool strict) const override;
};

class DT_DLL_readerWriter DtRwPropertyInt8 : public DtRwPropertyWithThreshold < DtRwInt8 >
{
public:
   DtRwPropertyInt8(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyInt8(const DtString& name, DtInt8 value, 
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyInt8(const DtString& name, const DtRwPropertyInt8& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyInt8(const DtRwPropertyInt8& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyInt8& operator=(const DtRwPropertyInt8& orig);
   virtual ~DtRwPropertyInt8();
   virtual bool isSimilarProperty(const DtPropertyInterface* rhs, bool strict) const override;
};

class DT_DLL_readerWriter DtRwPropertyInt16 : public DtRwPropertyWithThreshold < DtRwInt16 >
{
public:
   DtRwPropertyInt16(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyInt16(const DtString& name, DtInt16 value, 
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyInt16(const DtString& name, const DtRwPropertyInt16& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyInt16(const DtRwPropertyInt16& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyInt16& operator=(const DtRwPropertyInt16& orig);
   virtual ~DtRwPropertyInt16();
   virtual bool isSimilarProperty(const DtPropertyInterface* rhs, bool strict) const override;
};

class DT_DLL_readerWriter DtRwPropertyInt32 : public DtRwPropertyWithThreshold < DtRwInt32 >
{
public:
   DtRwPropertyInt32(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyInt32(const DtString& name, DtInt32 value, 
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyInt32(const DtString& name, const DtRwPropertyInt32& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyInt32(const DtRwPropertyInt32& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyInt32& operator=(const DtRwPropertyInt32& orig);
   virtual ~DtRwPropertyInt32();
   virtual bool isSimilarProperty(const DtPropertyInterface* rhs, bool strict) const override;
};

class DT_DLL_readerWriter DtRwPropertyReal : public DtRwPropertyWithThreshold<DtRwReal>
{
public:
   DtRwPropertyReal(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyReal(const DtString& name, DtReal value, 
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyReal(const DtString& name, const DtRwPropertyReal& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyReal(const DtRwPropertyReal& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyReal& operator=(const DtRwPropertyReal& orig);
   virtual ~DtRwPropertyReal();
   virtual bool isSimilarProperty(const DtPropertyInterface* rhs, bool strict) const override;
};

class DT_DLL_readerWriter DtRwPropertyReal32 : public DtRwPropertyWithThreshold < DtRwReal32 >
{
public:
   DtRwPropertyReal32(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyReal32(const DtString& name, DtFloat32 value, 
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyReal32(const DtString& name, const DtRwPropertyReal32& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyReal32(const DtRwPropertyReal32& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyReal32& operator=(const DtRwPropertyReal32& orig);
   virtual ~DtRwPropertyReal32();
   virtual bool isSimilarProperty(const DtPropertyInterface* rhs, bool strict) const override;
};

class DT_DLL_readerWriter DtRwPropertyReal64 : public DtRwPropertyWithThreshold < DtRwReal64 >
{
public:
   DtRwPropertyReal64(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyReal64(const DtString& name, DtFloat64 value,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyReal64(const DtString& name, const DtRwPropertyReal64& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyReal64(const DtRwPropertyReal64& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyReal64& operator=(const DtRwPropertyReal64& orig);
   virtual ~DtRwPropertyReal64();
   virtual bool isSimilarProperty(const DtPropertyInterface* rhs, bool strict) const override;
};

class DT_DLL_readerWriter DtRwPropertyVector : public DtRwPropertyWithThreshold < DtRwVector >
{
public:
   DtRwPropertyVector(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyVector(const DtString& name, const DtVector& value,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyVector(const DtString& name, const DtRwPropertyVector& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyVector(const DtRwPropertyVector& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyVector& operator=(const DtRwPropertyVector& orig);
   virtual ~DtRwPropertyVector();
};


class DT_DLL_readerWriter DtRwPropertyOffsetVector : public DtRwPropertyWithThreshold < DtRwOffsetVector >
{
public:
   DtRwPropertyOffsetVector(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyOffsetVector(const DtString& name, const DtVector& value,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyOffsetVector(const DtString& name, const DtRwPropertyOffsetVector& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyOffsetVector(const DtRwPropertyOffsetVector& orig,
      DtReaderWriterRegistry* parentRegistry = 0);
   DtRwPropertyOffsetVector& operator=(const DtRwPropertyOffsetVector& orig);
   virtual ~DtRwPropertyOffsetVector();
};