rwProperties.h

Go to the documentation of this file.

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


#pragma once

#include "vrfutil/rwVariableBindings.h"
#include "vlutil/vlString.h"
#include <vrfutil/readerWriterFactory.h>
#include <vrfutil/propertyInterface.h>

namespace tbb
{
   class spin_mutex;
}

class DT_DLL_vrfutil DtRwProperties : public DtRwVariableBindings, public DtPropertyInterface
{
private:
   DtRwProperties();

public:

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

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

   virtual const char* readerWriterType() const;

   virtual bool isValidProperty(const DtPropertyInterface*) const;

   virtual DtPropertyInterface* createProperty(DtlObjPtr args, DtReaderWriterRegistry* parentRegistry);

   virtual char* encode(char*) const;

   virtual const char* decode(const char*);

   virtual void getSize(int& size) const;

   static DtReaderWriterPropertyFactory* propertyFactory();
   static void cleanupPropertyFactory();

   virtual void copyVariables(const DtRwVariableBindings& other);

   virtual bool isReadonly() const;

   virtual int hlaAlignment() const;

   virtual int requiredPadding(const char* buf, const DtPropertyInterface* field) const;

   virtual const char* propertyType() const;

   virtual int count() const;

   virtual const DtReaderWriter* findProperty(const DtString& propName) const;
   virtual DtReaderWriter* findProperty(const DtString& propName);

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

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

   virtual DtRwProperties createFromPercentages(const DtRwProperties& percentages, const DtRwProperties& baseValues,
      const DtString& base = "Base-");

   virtual bool findRootAndVariable(const DtString& varName, DtReaderWriter*& root, DtReaderWriter*& variable) const;
   virtual DtReaderWriter* readerWriter();
   virtual const DtReaderWriter* readerWriter() const;

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

   virtual bool wasUpdatedSince(DtTime t) const;

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

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

   virtual void clearVariables();

   virtual void reset();

   virtual void removeVariable(DtReaderWriter*);
   virtual void removeVariable(const DtReaderWriter*);

   virtual void invalidateCache();

   virtual void invalidateCacheForProperty(const DtString& propName);



   static bool rollUpInteger(const DtReaderWriter* source, DtReaderWriter* destination, const DtMergePath& path);

   static bool rollUpReal(const DtReaderWriter* source, DtReaderWriter* destination, const DtMergePath& path);

   static bool rollUpString(const DtReaderWriter* source, DtReaderWriter* destination, const DtMergePath& path);

   static bool rollUpBoolean(const DtReaderWriter* source, DtReaderWriter* destination, const DtMergePath& path);

protected:
   virtual void filterIgnoredProperties(DtReaderWriter* rw, const std::set<DtString>& ignore);

   virtual void getInterface(DtPropertyInterface* pFace, DtlObjPtr args, 
      const DtReaderWriter::SearchPaths& searchPaths = SearchPaths(),
      const DtVariableBindingsList& variableBindings = nullVariableReference());

   virtual void writeSelf(std::string& fp, int indentLevel, bool writeUnspecified, const DtFilename& path);

   virtual void putData(std::string&, int indentLevel = 0);

   virtual int hlaAlignment(const DtPropertyInterface* field) const;

   virtual void getSize(const DtPropertyInterface*, int& size) const;

   virtual char* encode(const DtPropertyInterface*, char* buf) const;
   virtual const char* decode(DtPropertyInterface* iFace, const char* buf);

   virtual void unrecognizedItem(const DtEnvironmentSP env, const DtEnvValueSP root,
      const DtReaderWriter::SearchPaths& searchPaths, const DtVariableBindingsList& varBindings);

   virtual bool traverseAndModifyPercentage(DtRwProperties& results, const DtRwProperties& baseValues,
      const DtReaderWriter* percentage, const DtString& base) const;

protected:
   static DtReaderWriterPropertyFactory* thePropertyFactory;

   mutable std::multimap<DtString, DtReaderWriter*> myRwPropertyCache;
   mutable tbb::spin_mutex* myCacheMutex;

   DtClock myClock;

   mutable DtTime myLastTimeSizeChanged;

   mutable int mySizeAtLastCheck;

   bool myIsPublished;
   unsigned myDisRecordType;
};