VR-Forces 4.0.4 Class Documentation: include/vrfobjparam/systemParameterData.h Source File

Go to the documentation of this file.
00001 /*******************************************************************************
00002 ** Copyright (c) 2007 MAK Technologies, Inc.
00003 ** All rights reserved.
00004 *******************************************************************************/
00005 /*******************************************************************************
00006 ** $RCSfile: systemParameterData.h,v $ $Revision: 1.3 $ $State: Exp $
00007 *******************************************************************************/
00008 
00011 
00013 
00014 #ifndef systemParameterData_h
00015 #define systemParameterData_h
00016 
00017 #include "vrfobjparam/vrfobjparamDefines.h"
00018 #include "vrfutil/rdrWritr.h"
00019 #include "vrfutil/rwString.h"
00020 #include "tdbutil/stringKeyFactory.h"
00021 
00022 #include <memory>
00023 
00024 class DtSystemParameterData;
00025 
00027 typedef DtStringKeyFactoryWithParam<DtSystemParameterData, const DtString&> DtSystemParameterDataFactory;
00028 
00032 class DT_DLL_vrfobjparam DtSystemParameterData : public DtReaderWriter
00033 {
00034 public:
00035    DtSystemParameterData(const DtString& name, DtReaderWriterRegistry* 
00036       parentRegistry = NULL);
00037 
00038    DtSystemParameterData(const DtString& name, const DtSystemParameterData& orig,
00039       DtReaderWriterRegistry* parentRegistry = 0);
00040 
00041    DtSystemParameterData& operator=(const DtSystemParameterData& orig);
00042 
00043    virtual ~DtSystemParameterData();
00044 
00047    virtual DtString parameterType() const = 0;
00048 
00049    virtual DtSystemParameterData* clone() const = 0;
00050 
00051    virtual DtString parameterName() const;
00052    virtual void setParameterName(const DtString& name);
00053 
00054    virtual DtString variableType() const;
00055    virtual void setVariableType(const DtString& type);
00056 
00057    virtual DtString displayLabel() const;
00058    virtual void setDisplayLabel(const DtString& label);
00059 
00060    virtual DtString displayUnits() const;
00061    virtual void setDisplayUnits(const DtString& units);
00062 
00063    virtual DtString sourceUnits() const;
00064    virtual void setSourceUnits(const DtString& units);
00065 
00069    virtual void assignDefaultValueToReaderWriter(DtReaderWriter* rwToChange) const;
00070 
00073    static DtSystemParameterData* createSystemParamterData(const DtString& type);
00074 
00077    static DtSystemParameterDataFactory* factory();
00078 
00079 protected:
00080    DtRwString myParameterName;
00081    DtRwString myVariableType;
00082    DtRwString myDisplayLabel;
00083    DtRwString myDisplayUnits;
00084    DtRwString mySourceUnits;
00085    static std::auto_ptr<DtSystemParameterDataFactory> theFactory;
00086 };
00087 
00088 
00089 #endif