propertyInterface.h

Go to the documentation of this file.

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


#pragma once

#include <vrfutil/vrfutilDefines.h>
#include <vrfutil/rwBoolean.h>
#include <vrfutil/rwString.h>
#include <vrfutil/rwInt.h>
#include <vrfutil/rwReal.h>
#include <vrfutil/readerWriterFactory.h>
#include <vlutil/vlTime.h>

#include <string>

class DT_DLL_vrfutil DtPropertyInterface
{
public:
   enum MergeFlags
   {
      Replace = 0x00000001,   
      MinimalSimilarityCheck = 0x00000002, 
      RollUp = 0x00000004,    


      AddMissing = 0x00000008 
   };

   virtual ~DtPropertyInterface() {};

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

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

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

   virtual int hlaAlignment() const = 0;

   virtual const char* propertyType() const = 0;

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

   int getSize() const
   {
      int size = 0;
      getSize(size);

      return size;
   }

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

   virtual bool isSimilarProperty(const DtPropertyInterface* rhs) const
   {
      return (std::string(rhs->propertyType()) == std::string(propertyType()));
   }

   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 reset() = 0;
};

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 char* encode(char*) const;

   virtual const char* decode(const char*);

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

   virtual void getSize(int& size) const;

   virtual int hlaAlignment() const;

   virtual const char* propertyType() const;

   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 wasUpdatedSince(DtTime t) const;

   virtual void reset();

protected:

   DtClock myClock;
   mutable DtTime myUpdateTime;
   
};

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 wasUpdatedSince(DtTime t) const;

   virtual void enableThresholding(bool enable);

   virtual void setThreshold(double percentage);

   static void setDefaultThreshold(double percentage);

   virtual void setMaxUpdateInterval(DtTime interval);

   static void setDefaultMaxUpdateInterval(DtTime interval);

   virtual void setMaxUnchangedUpdateInterval(DtTime interval);

   static void setDefaultMaxUnchangedUpdateInterval(DtTime interval);

protected:

   bool myThresholdingEnabled;

   mutable _RwType myLastEncodedValue;

   mutable DtTime myLastEncodeTime;

   static double myDefaultThreshold;
   double myThreshold;

   static DtTime myDefaultMaxUpdateInterval;
   DtTime myMaxUpdateInterval;

   static DtTime myDefaultMaxUnchangedUpdateInterval;
   DtTime myMaxUnchangedUpdateInterval;
};

typedef DtRwProperty<DtRwString> DtRwPropertyString;
typedef DtRwPropertyWithThreshold<DtRwInt> DtRwPropertyInt;
typedef DtRwProperty<DtRwBoolean> DtRwPropertyBoolean;
typedef DtRwPropertyWithThreshold<DtRwReal> DtRwPropertyReal;