iRoCS Toolbox  1.1.0
Public Member Functions | Static Public Member Functions
svt::ProgressReporterCerr Class Reference

#include <ProgressReporterCerr.hh>

Inheritance diagram for svt::ProgressReporterCerr:
Collaboration diagram for svt::ProgressReporterCerr:

Public Member Functions

virtual void additionalInfo (int taskLevel, const std::string &text)
 (description) More...
 
virtual void clearScreen ()
 (description) More...
 
template<typename STDATA >
void loadParameters (STDATA &stData)
 
virtual int reportingLevel ()
 
virtual void reportProgress (const char *message, float percentOfCompletion)
 
virtual void reportProgress (int taskLevel, const std::string &taskName, float completenessPercent, const std::string &completenessPlainText)
 This method is called if some progress was made. More...
 
template<typename STDATA >
void saveParameters (STDATA &stData) const
 
virtual void setMaxTaskLevel (int n)
 
void setVerboseLevel (int verboseLevel)
 set the reporting level for reportProgress() method. More...
 

Static Public Member Functions

static const char * description ()
 
static void getParamInfos (std::vector< ParamInfo > &p)
 get information about the parameters, that are used in loadParameters() and saveParameters(). More...
 
static const char * name ()
 

Detailed Description

Definition at line 60 of file ProgressReporterCerr.hh.

Member Function Documentation

◆ reportProgress() [1/2]

virtual void svt::ProgressReporterCerr::reportProgress ( const char *  message,
float  percentOfCompletion 
)
inlinevirtual

Definition at line 63 of file ProgressReporterCerr.hh.

◆ reportingLevel()

virtual int svt::ProgressReporterCerr::reportingLevel ( )
inlinevirtual

Definition at line 69 of file ProgressReporterCerr.hh.

◆ setMaxTaskLevel()

virtual void svt::ProgressReporter::setMaxTaskLevel ( int  n)
inlinevirtualinherited

Definition at line 107 of file ProgressReporter.hh.

◆ clearScreen()

virtual void svt::ProgressReporter::clearScreen ( )
inlinevirtualinherited

(description)

Parameters

Definition at line 123 of file ProgressReporter.hh.

◆ reportProgress() [2/2]

virtual void svt::ProgressReporter::reportProgress ( int  taskLevel,
const std::string &  taskName,
float  completenessPercent,
const std::string &  completenessPlainText 
)
inlinevirtualinherited

This method is called if some progress was made.

Parameters
taskLevellevel of current task, e.g. 1 for parameter tuning, 2 for cross validation, 3 for multiclass algorithm, 4 for twoclass algorithm, etc.
taskNameplain test name of current task
completenessPercentcompleteness of current task as float between 0.0 and 1.0 (-1 means cannot be calculated, -2 means start of such a task without percent values)
completenessPlainTextcompleteness of current task as plain text message, e.g. "3 of 32"
Exceptions
TrainingCanceledcould be thrown, when user canceled the training process or when a timeOut appeared

Definition at line 156 of file ProgressReporter.hh.

Referenced by svt::CrossValidator< FV, SVMTYPE, PROBLEM >::preprocessTrainingData().

◆ additionalInfo()

virtual void svt::ProgressReporter::additionalInfo ( int  taskLevel,
const std::string &  text 
)
inlinevirtualinherited

(description)

Parameters

Definition at line 304 of file ProgressReporter.hh.

◆ setVerboseLevel()

void svt::ProgressReporter::setVerboseLevel ( int  verboseLevel)
inlineinherited

set the reporting level for reportProgress() method.

0 means report nothing. Higher numbers mean: report more.

Parameters
verboseLevelonly report progress events equal to or below this level

Definition at line 337 of file ProgressReporter.hh.

◆ loadParameters()

template<typename STDATA >
void svt::ProgressReporter::loadParameters ( STDATA &  stData)
inlineinherited

Definition at line 343 of file ProgressReporter.hh.

◆ saveParameters()

template<typename STDATA >
void svt::ProgressReporter::saveParameters ( STDATA &  stData) const
inlineinherited

Definition at line 350 of file ProgressReporter.hh.

◆ getParamInfos()

static void svt::ProgressReporter::getParamInfos ( std::vector< ParamInfo > &  p)
inlinestaticinherited

get information about the parameters, that are used in loadParameters() and saveParameters().

The Infos are appended to the passed array

Parameters
parray of ParamInfos. The Infos will be appended to this array

Definition at line 366 of file ProgressReporter.hh.

◆ name()

static const char* svt::ProgressReporter::name ( )
inlinestaticinherited

Definition at line 383 of file ProgressReporter.hh.

◆ description()

static const char* svt::ProgressReporter::description ( )
inlinestaticinherited

Definition at line 388 of file ProgressReporter.hh.


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