SHOGUN  6.1.3
List of all members | Public Member Functions | Protected Attributes
ParameterObserverInterface Class Referenceabstract

Detailed Description

Interface for the parameter observer classes

Definition at line 55 of file ParameterObserverInterface.h.

Inheritance diagram for ParameterObserverInterface:
[legend]

Public Member Functions

 ParameterObserverInterface ()
 
 ParameterObserverInterface (std::vector< std::string > &parameters)
 
 ParameterObserverInterface (const std::string &filename, std::vector< std::string > &parameters)
 
virtual ~ParameterObserverInterface ()
 
virtual bool filter (const std::string &param)
 
virtual void on_next (const TimedObservedValue &value)=0
 
virtual void on_error (std::exception_ptr)=0
 
virtual void on_complete ()=0
 
virtual void clear ()
 

Protected Attributes

std::vector< std::string > m_parameters
 
SG_OBS_VALUE_TYPE m_type
 

Constructor & Destructor Documentation

◆ ParameterObserverInterface() [1/3]

Default constructor

Definition at line 40 of file ParameterObserverInterface.cpp.

◆ ParameterObserverInterface() [2/3]

ParameterObserverInterface ( std::vector< std::string > &  parameters)

Constructor

Parameters
parameterslist of parameters which we want to watch over

Definition at line 44 of file ParameterObserverInterface.cpp.

◆ ParameterObserverInterface() [3/3]

ParameterObserverInterface ( const std::string &  filename,
std::vector< std::string > &  parameters 
)

Constructor

Parameters
filenamename of the generated output file
parameterslist of parameters which we want to watch over

Definition at line 50 of file ParameterObserverInterface.cpp.

◆ ~ParameterObserverInterface()

Virtual destructor

Definition at line 56 of file ParameterObserverInterface.cpp.

Member Function Documentation

◆ clear()

virtual void clear ( )
virtual

Method useful to empty the observer from obseverd value it may have stored.

Reimplemented in CParameterObserverCV.

Definition at line 109 of file ParameterObserverInterface.h.

◆ filter()

bool filter ( const std::string &  param)
virtual

Filter function, check if the parameter name supplied is what we want to monitor

Parameters
paramthe param name
Returns
true if param is found inside of m_parameters list

Definition at line 60 of file ParameterObserverInterface.cpp.

◆ on_complete()

virtual void on_complete ( )
pure virtual

Method which will be called on completion

Implemented in CParameterObserverCV.

◆ on_error()

virtual void on_error ( std::exception_ptr  )
pure virtual

Method which will be called on errors

Implemented in CParameterObserverCV.

◆ on_next()

virtual void on_next ( const TimedObservedValue value)
pure virtual

Method which will be called when the parameter observable emits a value.

Parameters
valuethe value emitted by the parameter observable

Implemented in CParameterObserverCV.

Member Data Documentation

◆ m_parameters

std::vector<std::string> m_parameters
protected

List of parameter's names we want to monitor

Definition at line 109 of file ParameterObserverInterface.h.

◆ m_type

SG_OBS_VALUE_TYPE m_type
protected

The type of params this observers accept

Definition at line 120 of file ParameterObserverInterface.h.


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

SHOGUN Machine Learning Toolbox - Documentation