varGroup.h

Go to the documentation of this file.

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



#ifndef varGroup_H_
#define varGroup_H_

#include "baseConfigVar.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 bool isRequired() const;

   virtual const DtString& name() const;

   virtual DtString type() 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);

   DtEnvValueSP getGroupValue(DtEnvironment env);


protected:
   DtString myName;
   DtString myType;

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

#ifdef DtUSE_UTILITIES_NAMESPACE
}
#endif

#endif