multiVar.h

Go to the documentation of this file.

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

#ifndef multiVar_H_
#define multiVar_H_

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

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

#include <vector>

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

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

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

   virtual ~DtMultiConfigVariable();

   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.
   const std::vector<T>& values() const;
   void setValues(const std::vector<T>& aValue);
   void addValue(T aValue);
   void removeValue(T aValue);
   void clearValues();

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

protected: 

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

   DtString myName;
   DtString myItemName;
   DtString myShortcut;
   bool myRequiredFlag;

   DtVariableGroup* myGroup;

   std::vector<T> myValues;
};

#include "multiVar.inl"

#endif


//#endif