Evalulator is responsible for maintaining the evaluator list (human-readable), stored as a map. More...

Collaboration diagram for EvaluatorList:

Public Member Functions
bool	AnyError ()
void	ClearTaskFullName ()
	EvaluatorList (VariableList *vList)
	EvaluatorList (const std::string &fileName, VariableList *vList)
	EvaluatorList ()
	Class constructor.
	EvaluatorList (const std::string &fileName)
std::string	GetEvaluatorCommand (const std::string &taskName)
	Retrieve the command for a task.
std::string	GetFullTaskName (std::string taskName)
std::map< std::string, std::string > *	GetList ()
	Retrieve a reference to the list of tasks.
std::string	GetTaskFunction (const std::string taskName)
	retrieves the task's function
std::vector< std::string >	GetTaskKeys ()
	retrieves the keys from the tasks map, as strings
std::vector< std::string >	GetTaskParameters (const std::string taskName)
	Retrieve the parameters for a task.
void	GetTasks (std::vector< std::string > keys, std::vector< std::string > values, bool fullName=0)
	retrieves the keys and values from the tasks map, as strings
std::vector< std::string >	GetTaskValues (bool fullName=0)
	retrieves the values from the tasks map, as strings
bool	Read (const std::string &fileName)
void	SetEvaluatorTask (std::string taskName, std::string fullName)
	Add a new task to the evaluator list.
void	SetFullTaskName (std::string taskName, std::string fullName)
	Add a new task to the evaluator list.
void	SetVarList (VariableList *list)
void	Write (const std::string &fileName)
	~EvaluatorList ()
	Class destructor.

Detailed Description

Evalulator is responsible for maintaining the evaluator list (human-readable), stored as a map.

Notes

Work in progress

Dependencies

Libraries: STL map, string, vector, wxprec

Bugs

None

Change Log

Finished cleaning up code, ker, 25/4/09
Read added, Jeff, sometime in April
Split from NIREPEvaluator, ker, 26/3/09

Constructor & Destructor Documentation

EvaluatorList::EvaluatorList ( )

Class constructor.

Notes: This function is overwritten with a parameter to pass through a reference to the file name. Without it, the evaluator list doesn't get read

EvaluatorList::EvaluatorList ( VariableList * vList )

EvaluatorList::EvaluatorList ( const std::string & fileName )

EvaluatorList::EvaluatorList	(	const std::string &	fileName,
		VariableList *	vList
	)

EvaluatorList::~EvaluatorList ( )

Class destructor.

Member Function Documentation

bool EvaluatorList::AnyError ( ) [inline]

void EvaluatorList::ClearTaskFullName ( ) [inline]

EvaluatorList::GetEvaluatorCommand ( const std::string & taskName ) [inline]

Retrieve the command for a task.

This task retrieves the task's command parameters. For instance, for the task "_A1 = readImage(1,MRI)", this function would return readImage

Parameters:

taskName std::string the reference name of the task

Return values:

std::string the task's command

std::string EvaluatorList::GetFullTaskName ( std::string taskName ) [inline]

EvaluatorList::GetList ( ) [inline]

Retrieve a reference to the list of tasks.

EvaluatorList::GetTaskFunction ( const std::string taskName )

retrieves the task's function

Parameters:

const std::string taskName with the name of the task

Return values:

std::string with the function used by NIREPEvaluator::evaluate

EvaluatorList::GetTaskKeys ( )

retrieves the keys from the tasks map, as strings

Return values:

std::vector<std::string> containing the keys (eg: _A1, _A2, etc)

EvaluatorList::GetTaskParameters ( const std::string taskName )

Retrieve the parameters for a task.

This task retrieves the task's command parameters. For instance, for the task "_A1 = readImage(1,MRI)", this function would return the vector: [0] = 1 [1] = MRI

Parameters:

taskName std::string the reference name of the task

Return values:

std::vector<std::string> the parameters of the task

EvaluatorList::GetTasks	(	std::vector< std::string > *	keys,
		std::vector< std::string > *	values,
		bool	fullName = `0`
	)

retrieves the keys and values from the tasks map, as strings

Parameters:

keys	std::vector<std::string>* containing the keys (eg: _A1, _A2, etc)
vals	std::vector<std::string>* containing the values (eg: readImage(1,MRI), etc)
fullName	bool flag to determine if the fully qualified name is returned or not. defaults to 0 (no).

EvaluatorList::GetTaskValues ( bool fullName = 0 )

retrieves the values from the tasks map, as strings

Parameters:

fullName bool flag to determine if the fully qualified name is returned or not. defaults to 0 (no).

Return values:

std::vector<std::string> containing the values (eg: readImage(1,MRI), etc)

bool EvaluatorList::Read ( const std::string & fileName )

EvaluatorList::SetEvaluatorTask	(	std::string	taskName,
		std::string	fullName
	)		`[inline]`

Add a new task to the evaluator list.

If the task already exists in the evaluator list, the task is updated.

Parameters:

taskName	std::string the reference name of the task. ex: _A1
fullName	std::string the full task function. ex: readImage(1,MRI)

EvaluatorList::SetFullTaskName	(	std::string	taskName,
		std::string	fullName
	)		`[inline]`

Add a new task to the evaluator list.

If the task already exists in the evaluator list, the task is updated.

Parameters:

taskName	std::string the reference name of the task. ex: _A1
fullName	std::string the full task function. ex: readImage(1,MRI)

If the task already exists in the evaluator list, the task is updated.

Parameters:

taskName	std::string the reference name of the task. ex: _A1
fullName	std::string the full task function. ex: readImage(1,MRI)

void EvaluatorList::SetVarList ( VariableList * list ) [inline]

void EvaluatorList::Write ( const std::string & fileName )

EvaluatorList Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation