BIAS::ParamTypeString Class Reference

#include <Utils/ParamTypes.hh>

Inheritance diagram for BIAS::ParamTypeString:

Collaboration diagram for BIAS::ParamTypeString:

Public Member Functions
virtual std::string	GetHint ()
virtual std::string	GetTypeName ()
virtual std::string	GetValueString ()
	ParamTypeString ()
void	SetDefault ()
	resets to default value More...
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	~ParamTypeString ()

Public Attributes
ParamCallbackInterface *	CallbackObject_
	if some one changed a parameter, we should call CallbackObject_->ParameterChanged(Name_); More...
std::string	default_
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_
std::string	value_
bool	WriteToFile_
	is only written to parameter file if true More...

Detailed Description

Definition at line 221 of file ParamTypes.hh.

Constructor & Destructor Documentation

BIAS::ParamTypeString::ParamTypeString ( )

inline

Definition at line 225 of file ParamTypes.hh.

virtual BIAS::ParamTypeString::~ParamTypeString ( )

inlinevirtual

Definition at line 226 of file ParamTypes.hh.

Member Function Documentation

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

inlinevirtual

Reimplemented from BIAS::ParamTypeBase.

Definition at line 238 of file ParamTypes.hh.

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

inlinevirtual

Reimplemented from BIAS::ParamTypeBase.

Definition at line 236 of file ParamTypes.hh.

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

inlinevirtual

Reimplemented from BIAS::ParamTypeBase.

Definition at line 237 of file ParamTypes.hh.

void BIAS::ParamTypeString::SetDefault ( )

inlinevirtual

resets to default value

Reimplemented from BIAS::ParamTypeBase.

Definition at line 231 of file ParamTypes.hh.

virtual int BIAS::ParamTypeString::SetFromString ( const std::string &  s )

inlinevirtual

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 from BIAS::ParamTypeBase.

Definition at line 232 of file ParamTypes.hh.

Member Data Documentation

ParamCallbackInterface* BIAS::ParamTypeBase::CallbackObject_

inherited

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().

std::string BIAS::ParamTypeString::default_

Definition at line 229 of file ParamTypes.hh.

Referenced by BIAS::Param::AddParamString().

bool BIAS::ParamTypeBase::Enhanced_

inherited

hide this parameter from the 'naive' user

Definition at line 76 of file ParamTypes.hh.

int BIAS::ParamTypeBase::Group_

inherited

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_

inherited

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_

inherited

hide this parameter from all users

Definition at line 77 of file ParamTypes.hh.

std::string BIAS::ParamTypeBase::Name_

inherited

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_

inherited

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().

std::string BIAS::ParamTypeString::value_

Definition at line 228 of file ParamTypes.hh.

Referenced by BIAS::Param::AddParamString(), and BIAS::ParamGUIPanel::AddStringWidgets().

bool BIAS::ParamTypeBase::WriteToFile_

inherited

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 file:

• Utils/ParamTypes.hh