variableGroup.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2013 VT MAK
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include "baseConfigVariable.h"

#ifdef DtUSE_UTILITIES_NAMESPACE
namespace DtUSE_UTILITIES_NAMESPACE
{
#endif

class DT_DLL_MTL DtVariableGroup : public DtBaseConfigVariable
{
public:

   DtVariableGroup( DtVariableGroup* parent, const DtString& groupName,
      const DtString& groupType = "", const DtString& aDescription = "" );

   virtual ~DtVariableGroup();

   virtual void addBaseVariable( DtBaseConfigVariable* var );

   virtual bool changeOnce() const;

   virtual const DtString& name() const;

   virtual bool isRequired() const;

   virtual void getCommandLineArg( DtCmdLine::CmdLine& cmdLine );

   virtual void updateFromCommandLineArg();

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

   // MJI - This implies getting an "environment value", not getting a value from
   // the environment passed in.
   virtual DtEnvValueSP getEnvironmentValue( DtEnvironment env );

   virtual void updateFromEnvironment( DtEnvironment env );

   virtual DtString type() const;

   DtEnvValueSP getGroupValue( DtEnvironment env );

protected:

   DtVariableGroup( const DtVariableGroup& other );

   DtVariableGroup& operator = ( const DtVariableGroup& other );

protected:

   DtString myName;
   DtString myType;

   DtVariableGroup* myParent;
   typedef std::list<DtBaseConfigVariable*> VariableList;
   VariableList myVars;

};

#ifdef DtUSE_UTILITIES_NAMESPACE
}
#endif