multiConfigVariable.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2013 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 <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 = "" );

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

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

   virtual ~DtMultiConfigVariable();

   DtMultiConfigVariable& operator = ( const DtMultiConfigVariable& other );

   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 );



   const std::vector<T>& values() const;
   void setValues(const std::vector<T>& aValue);
   void addValue(T aValue);
   void removeValue(T aValue);
   void clearValues();



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


protected:

   DtMultiConfigVariable( const DtMultiConfigVariable& other );

protected:

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

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

   DtVariableGroup* myGroup;

   std::vector<T> myValues;

};

#include "multiConfigVariable.inl"