BIAS::ParamTypeBase Class Reference

This file holds the definitions of the parameter types used by BIAS::Param. More...

#include <Utils/ParamTypes.hh>

Inheritance diagram for BIAS::ParamTypeBase:

Collaboration diagram for BIAS::ParamTypeBase:

Public Member Functions
virtual std::string	GetHint ()
virtual std::string	GetTypeName ()
virtual std::string	GetValueString ()
	ParamTypeBase ()
virtual void	SetDefault ()
virtual int	SetFromString (const std::string &s)
	This is a common interface to let a specialized instance read its data from a string. More...
virtual	~ParamTypeBase ()

Public Attributes
ParamCallbackInterface *	CallbackObject_
	if some one changed a parameter, we should call CallbackObject_->ParameterChanged(Name_); More...
bool	Enhanced_
	hide this parameter from the 'naive' user More...
int	Group_
std::string	Help_
bool	Hidden_
	hide this parameter from all users More...
std::string	Name_
char	ShortCmd_
bool	WriteToFile_
	is only written to parameter file if true More...

Detailed Description

This file holds the definitions of the parameter types used by BIAS::Param.

Author

mdunda 03 2004

Definition at line 49 of file ParamTypes.hh.

Constructor & Destructor Documentation

ParamTypeBase::~ParamTypeBase ( )

virtual

Definition at line 47 of file ParamTypes.cpp.

ParamTypeBase::ParamTypeBase

(

)

Definition at line 35 of file ParamTypes.cpp.

Member Function Documentation

virtual std::string BIAS::ParamTypeBase::GetHint ( )

inlinevirtual

Reimplemented in BIAS::ParamTypeEnum, BIAS::ParamTypeString, BIAS::ParamTypeDouble, BIAS::ParamTypeInt, and BIAS::ParamTypeBool.

Definition at line 69 of file ParamTypes.hh.

virtual std::string BIAS::ParamTypeBase::GetTypeName ( )

inlinevirtual

Reimplemented in BIAS::ParamTypeEnum, BIAS::ParamTypeVecInt, BIAS::ParamTypeVecDbl, BIAS::ParamTypeString, BIAS::ParamTypeDouble, BIAS::ParamTypeInt, and BIAS::ParamTypeBool.

Definition at line 67 of file ParamTypes.hh.

virtual std::string BIAS::ParamTypeBase::GetValueString ( )

inlinevirtual

Reimplemented in BIAS::ParamTypeEnum, BIAS::ParamTypeVecInt, BIAS::ParamTypeVecDbl, BIAS::ParamTypeString, BIAS::ParamTypeDouble, BIAS::ParamTypeInt, and BIAS::ParamTypeBool.

Definition at line 68 of file ParamTypes.hh.

virtual void BIAS::ParamTypeBase::SetDefault ( )

inlinevirtual

Reimplemented in BIAS::ParamTypeEnum, BIAS::ParamTypeVecInt, BIAS::ParamTypeVecDbl, BIAS::ParamTypeString, BIAS::ParamTypeDouble, BIAS::ParamTypeInt, and BIAS::ParamTypeBool.

Definition at line 58 of file ParamTypes.hh.

int ParamTypeBase::SetFromString ( const std::string &  s )

virtual

This is a common interface to let a specialized instance read its data from a string.

Used from ParseCommandLine() and ReadParam() to be overwritten in derived class

Reimplemented in BIAS::ParamTypeEnum, BIAS::ParamTypeVecInt, BIAS::ParamTypeVecDbl, BIAS::ParamTypeString, BIAS::ParamTypeDouble, BIAS::ParamTypeInt, and BIAS::ParamTypeBool.

Definition at line 56 of file ParamTypes.cpp.

Member Data Documentation

ParamCallbackInterface* BIAS::ParamTypeBase::CallbackObject_

if some one changed a parameter, we should call CallbackObject_->ParameterChanged(Name_);

Definition at line 82 of file ParamTypes.hh.

Referenced by BIAS::ParamGUIPanel::OnChoice().

bool BIAS::ParamTypeBase::Enhanced_

hide this parameter from the 'naive' user

Definition at line 76 of file ParamTypes.hh.

int BIAS::ParamTypeBase::Group_

Definition at line 78 of file ParamTypes.hh.

Referenced by BIAS::Param::AddParamBool(), BIAS::Param::AddParamDouble(), BIAS::Param::AddParamEnum(), BIAS::Param::AddParamInt(), BIAS::Param::AddParamString(), BIAS::Param::AddParamVecDbl(), and BIAS::Param::AddParamVecInt().

std::string BIAS::ParamTypeBase::Help_

Definition at line 73 of file ParamTypes.hh.

Referenced by BIAS::ParamGUIPanel::AddBoolWidgets(), BIAS::ParamGUIPanel::AddDoubleWidgets(), BIAS::ParamGUIPanel::AddEnumWidgets(), BIAS::Param::AddParamBool(), BIAS::Param::AddParamDouble(), BIAS::Param::AddParamEnum(), BIAS::Param::AddParamInt(), BIAS::Param::AddParamString(), BIAS::Param::AddParamVecDbl(), BIAS::Param::AddParamVecInt(), BIAS::ParamGUIPanel::AddStringWidgets(), BIAS::ParamGUIPanel::AddVecDblWidgets(), and BIAS::ParamGUIPanel::AddVecIntWidgets().

bool BIAS::ParamTypeBase::Hidden_

hide this parameter from all users

Definition at line 77 of file ParamTypes.hh.

std::string BIAS::ParamTypeBase::Name_

Definition at line 69 of file ParamTypes.hh.

Referenced by BIAS::ParamGUIPanel::AddBoolWidgets(), BIAS::ParamGUIPanel::AddDoubleWidgets(), BIAS::ParamGUIPanel::AddEnumWidgets(), BIAS::Param::AddParamBool(), BIAS::Param::AddParamDouble(), BIAS::Param::AddParamEnum(), BIAS::Param::AddParamInt(), BIAS::Param::AddParamString(), BIAS::Param::AddParamVecDbl(), BIAS::Param::AddParamVecInt(), BIAS::ParamGUIPanel::AddStringWidgets(), BIAS::ParamGUIPanel::AddVecDblWidgets(), BIAS::ParamGUIPanel::AddVecIntWidgets(), and BIAS::ParamGUIPanel::OnChoice().

char BIAS::ParamTypeBase::ShortCmd_

Definition at line 74 of file ParamTypes.hh.

Referenced by BIAS::Param::AddParamBool(), BIAS::Param::AddParamDouble(), BIAS::Param::AddParamEnum(), BIAS::Param::AddParamInt(), BIAS::Param::AddParamString(), BIAS::Param::AddParamVecDbl(), and BIAS::Param::AddParamVecInt().

bool BIAS::ParamTypeBase::WriteToFile_

is only written to parameter file if true

Definition at line 75 of file ParamTypes.hh.

Referenced by BIAS::Param::AddParamBool(), BIAS::Param::AddParamDouble(), BIAS::Param::AddParamEnum(), BIAS::Param::AddParamInt(), BIAS::Param::AddParamString(), BIAS::Param::AddParamVecDbl(), and BIAS::Param::AddParamVecInt().

---

The documentation for this class was generated from the following files:

• Utils/ParamTypes.hh
• Utils/ParamTypes.cpp