EasyLocalpp  3.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends | List of all members
EasyLocal::Core::Parametrized Class Referenceabstract

#include <parameter.hh>

Inheritance diagram for EasyLocal::Core::Parametrized:
Inheritance graph
[legend]
Collaboration diagram for EasyLocal::Core::Parametrized:
Collaboration graph
[legend]

Public Member Functions

 Parametrized (const std::string &prefix, const std::string &description)
 
virtual void ReadParameters (std::istream &is=std::cin, std::ostream &os=std::cout)
 
virtual void Print (std::ostream &os=std::cout) const
 
template<typename T >
void GetParameterValue (std::string flag, T &value)
 
void CopyParameterValues (const Parametrized &p)
 
template<typename T >
void SetParameter (std::string flag, const T &value)
 
bool IsRegistered () const
 

Protected Member Functions

virtual void RegisterParameters ()=0
 

Protected Attributes

ParameterBox parameters
 

Static Protected Attributes

static std::list< Parametrized * > overall_parametrized
 

Friends

bool CommandLineParameters::Parse (int argc, const char *argv[], bool check_unregistered, bool silent)
 

Detailed Description

A class representing a parametrized component of EasyLocal++.

Definition at line 325 of file parameter.hh.

Constructor & Destructor Documentation

EasyLocal::Core::Parametrized::Parametrized ( const std::string &  prefix,
const std::string &  description 
)
inline

Constructor.

Parameters
prefixnamespace of the parameters
descriptionsemantics of the parameters group

Definition at line 334 of file parameter.hh.

Member Function Documentation

void EasyLocal::Core::Parametrized::CopyParameterValues ( const Parametrized &  p)
inline

Definition at line 383 of file parameter.hh.

template<typename T >
void EasyLocal::Core::Parametrized::GetParameterValue ( std::string  flag,
T &  value 
)
inline

Gets a given parameter

Definition at line 366 of file parameter.hh.

bool EasyLocal::Core::Parametrized::IsRegistered ( ) const
inline

Definition at line 422 of file parameter.hh.

virtual void EasyLocal::Core::Parametrized::Print ( std::ostream &  os = std::cout) const
inlinevirtual

Print all parameter values on an output stream.

Reimplemented in EasyLocal::Core::SearchEngine< Input, State, CFtype >, and EasyLocal::Core::SimpleLocalSearch< Input, Output, State, CFtype >.

Definition at line 355 of file parameter.hh.

virtual void EasyLocal::Core::Parametrized::ReadParameters ( std::istream &  is = std::cin,
std::ostream &  os = std::cout 
)
inlinevirtual

Read all parameters from an input stream (prints hints on output stream).

Reimplemented in EasyLocal::Core::SearchEngine< Input, State, CFtype >, and EasyLocal::Core::SimpleLocalSearch< Input, Output, State, CFtype >.

Definition at line 340 of file parameter.hh.

virtual void EasyLocal::Core::Parametrized::RegisterParameters ( )
protectedpure virtual

Implemented in EasyLocal::Core::SearchEngine< Input, State, CFtype >, and EasyLocal::Core::AbstractLocalSearch< Input, Output, State, CFtype >.

template<typename T >
void EasyLocal::Core::Parametrized::SetParameter ( std::string  flag,
const T &  value 
)
inline

Sets a given parameter to a given value

Definition at line 403 of file parameter.hh.

Friends And Related Function Documentation

bool CommandLineParameters::Parse ( int  argc,
const char *  argv[],
bool  check_unregistered,
bool  silent 
)
friend

Member Data Documentation

std::list<Parametrized*> EasyLocal::Core::Parametrized::overall_parametrized
staticprotected

Definition at line 436 of file parameter.hh.

ParameterBox EasyLocal::Core::Parametrized::parameters
protected

Definition at line 434 of file parameter.hh.

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