configVariable.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 1992-2025 MAK Technologies, Inc
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include "baseConfigVariable.h"
#include "variableGroup.h"
#include "varType.h"

#include <mtl/environment.h>
#include <vlutil/vlExceptions.h>
#include <cmdLine/cmdLine.h>
#include <matrix/vlVector.h>

#ifdef DtUSE_UTILITIES_NAMESPACE
namespace DtUSE_UTILITIES_NAMESPACE
{
#endif

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 )
DtDeclareVarType( std::string, std::string );

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 = "");
   
   DtConfigVariable(DtVariableGroup& group, T aDefault,
      const DtString& aDescription = "", DtVariableScope aScope = DtBaseConfigVariable::DtScopeBoth,
      bool isRequired = false);

   DtConfigVariable( DtVariableGroup* group, const DtConfigVariable<T>& orig );

   DtConfigVariable( DtVariableGroup& group, const DtConfigVariable<T>& orig );

   virtual ~DtConfigVariable();

   DtConfigVariable& operator=(const DtConfigVariable& rhs);

   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;


   virtual const DtString& name() const;
   void setName(const DtString& name);



   T value() const;
   void setValue(T aValue);


   const DtString& shortcut() const;
   void setShortcut(const DtString& aShortcut);


   void setNameAndShortcut(const DtString& aName);


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


   T* getInternalPtrValue();

protected:

   DtConfigVariable( const DtConfigVariable& other );

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 "configVariable.inl"

#ifdef DtUSE_UTILITIES_NAMESPACE
}
#endif