configVar.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 1992-2010 VT MAK
** All rights reserved.
******************************************************************************/



#ifndef configVar_H_
#define configVar_H_

#include "baseConfigVar.h"
#include "varGroup.h"
#include "varType.h"

#include <mtl/env.h>
#include <vlutil/vlExceptions.h>
#include <cmdLine/cmdLine.h>

#ifdef DtUSE_UTILITIES_NAMESPACE
namespace DtUSE_UTILITIES_NAMESPACE
{
#endif


class DtVector;
class DtTaitBryan;

DtDeclareVarType(DtString,DtString)
DtDeclareVarType(int,int)
DtDeclareVarType(unsigned int,unsigned int)
DtDeclareVarType(double,double)
DtDeclareVarType(float,float)
DtDeclareVarType(DtVector,DtString)
DtDeclareVarType(bool,bool)
DtDeclareVarType(DtTaitBryan,DtString)

template <typename T>
class DtConfigVariable : public DtBaseConfigVariable
{
public:   

   DtConfigVariable(DtVariableGroup* group, const DtString& aName,T aDefault,       
      const DtString& aDescription = "", 
      DtVariableScope aScope = DtBaseConfigVariable::DtScopeBoth,
      bool isRequired = false,
      const DtString& aShortcut = "");

   DtConfigVariable(DtVariableGroup& group, const DtString& aName, T aDefault, 
      const DtString& aDescription = "", 
      DtVariableScope aScope = DtBaseConfigVariable::DtScopeBoth,
      bool isRequired = false,
      const DtString& aShortcut = "");

   virtual ~DtConfigVariable();

   virtual void getCommandLineArg(DtCmdLine::CmdLine&);

   virtual void updateFromCommandLineArg();

   virtual void getEnvironmentSchemaType(DtEnvironment env,TypeSet& usedTypes) const;

   virtual DtEnvValueSP getEnvironmentValue(DtEnvironment env);

   virtual void updateFromEnvironment(DtEnvironment env);

   virtual DtString type() const;

   virtual bool isRequired() const;
   
   // \brief Get/Set the variable name.
   virtual const DtString& name() const;

   void setName(const DtString& name);

   // \brief Get/Set the variable value.
   T value() const;
   void setValue(T aValue);

   // \brief Get/Set the variable's shortcut
   const DtString& shortcut() const;
   void setShortcut(const DtString& aShortcut);


   T defaultValue() const;
   void setDefaultValue(T aDefault);   

   T* getInternalPtrValue();

protected: 

   //Internal Type
   typedef typename DtVarType<T>::ArgType ArgType;

   DtString myName;
   DtString myShortcut;
   bool myRequiredFlag;

   DtVariableGroup* myGroup;

   T myDefault;
   T myValue;
};

template <>
DT_DLL_MTL void DtConfigVariable<bool>::updateFromCommandLineArg();

template <>
DT_DLL_MTL void DtConfigVariable<bool>::getCommandLineArg(DtCmdLine::CmdLine& cmdLine);

#include "configVar.inl"

#ifdef DtUSE_UTILITIES_NAMESPACE
}
#endif

#endif