systemParameterData.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjparam/vrfobjparamDefines.h"
#include "vrfutil/readerWriter.h"
#include "vrfutil/rwString.h"
#include "vrfutil/rwBoolean.h"
#include "vrfutil/rwInt.h"
#include "tdbutil/stringKeyFactory.h"

#include <memory>

class DtSystemParameterData;

typedef DtStringKeyFactoryWithParam<DtSystemParameterData, const DtString&> DtSystemParameterDataFactory;

class DT_DLL_vrfobjparam DtSystemParameterData : public DtReaderWriter
{
public:
   DtSystemParameterData(const DtString& name, DtReaderWriterRegistry* 
      parentRegistry = NULL);

   DtSystemParameterData(const DtString& name, const DtSystemParameterData& orig,
      DtReaderWriterRegistry* parentRegistry = 0);

   DtSystemParameterData& operator=(const DtSystemParameterData& orig);

   virtual ~DtSystemParameterData();

   virtual DtString parameterType() const = 0;

   virtual DtSystemParameterData* clone() const = 0;

   virtual DtString parameterName() const;
   virtual void setParameterName(const DtString& name);

   virtual DtString variableType() const;
   virtual void setVariableType(const DtString& type);

   virtual DtString displayLabel() const;
   virtual void setDisplayLabel(const DtString& label);

   virtual DtString displayUnits() const;
   virtual void setDisplayUnits(const DtString& units);

   virtual DtString sourceUnits() const;
   virtual void setSourceUnits(const DtString& units);

   virtual void assignDefaultValueToReaderWriter(DtReaderWriter* rwToChange) const;

   static DtSystemParameterData* createSystemParamterData(const DtString& type);

   static DtSystemParameterDataFactory* factory();

   virtual bool operator==(const DtSystemParameterData&) const;

   virtual void setRollUpRule(const DtString&);
   virtual DtString rollUpRule() const;

   virtual void setListItems(const DtString&);
   virtual const DtString& listItems() const;

   virtual void getListItems(std::vector<DtString>& keys, std::vector<DtString>& values) const;

   virtual void setListDisplay(int);
   virtual int listDisplay() const;

   virtual void setAllowEdit(const bool);
   virtual bool allowEdit() const;

protected:
   DtRwString myParameterName;
   DtRwString myVariableType;
   DtRwString myDisplayLabel;
   DtRwString myDisplayUnits;
   DtRwString mySourceUnits;
   DtRwString myListItems;
   DtRwInt myListDisplay;
   DtRwBoolean myAllowEdit;
   DtRwString myRollUpRule;
   static std::auto_ptr<DtSystemParameterDataFactory> theFactory;
};