Basic Image AlgorithmS Library 2.8.0
Public Member Functions | Public Attributes

BIAS::ParamTypeString Class Reference

#include <Utils/ParamTypes.hh>

Inheritance diagram for BIAS::ParamTypeString:
Collaboration diagram for BIAS::ParamTypeString:

List of all members.

Public Member Functions

virtual std::string GetHint ()
virtual std::string GetTypeName ()
virtual std::string GetValueString ()
 ParamTypeString ()
void SetDefault ()
 resets to default value
virtual int SetFromString (const std::string &s)
 This is a common interface to let a specialized instance read its data from a string.
virtual ~ParamTypeString ()

Public Attributes

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

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 ( ) [inline, virtual]

Definition at line 226 of file ParamTypes.hh.


Member Function Documentation

virtual std::string BIAS::ParamTypeString::GetHint ( ) [inline, virtual]

Reimplemented from BIAS::ParamTypeBase.

Definition at line 238 of file ParamTypes.hh.

virtual std::string BIAS::ParamTypeString::GetTypeName ( ) [inline, virtual]

Reimplemented from BIAS::ParamTypeBase.

Definition at line 236 of file ParamTypes.hh.

virtual std::string BIAS::ParamTypeString::GetValueString ( ) [inline, virtual]

Reimplemented from BIAS::ParamTypeBase.

Definition at line 237 of file ParamTypes.hh.

void BIAS::ParamTypeString::SetDefault ( ) [inline, virtual]

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) [inline, 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 from BIAS::ParamTypeBase.

Definition at line 232 of file ParamTypes.hh.


Member Data Documentation

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

Definition at line 229 of file ParamTypes.hh.

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

hide this parameter from the 'naive' user

Definition at line 76 of file ParamTypes.hh.

int BIAS::ParamTypeBase::Group_ [inherited]
std::string BIAS::ParamTypeBase::Help_ [inherited]
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]

The documentation for this class was generated from the following file:
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends