Class for reading MOOS configuration files. More...

#include <ProcessConfigReader.h>

Inheritance diagram for CProcessConfigReader:

Collaboration diagram for CProcessConfigReader:

Public Member Functions
	CProcessConfigReader ()
virtual	~CProcessConfigReader ()
std::string	GetAppName ()
std::string	GetFileName ()
void	SetAppName (std::string sAppName)
bool	GetConfigurationParam (std::string sAppName, std::string sParam, std::string &sVal)
	READ STRINGS.
bool	GetConfigurationParam (std::string sAppName, std::string sParam, double &dfVal)
bool	GetConfigurationParam (std::string sAppName, std::string sParam, float &fVal)
bool	GetConfigurationParam (std::string sAppName, std::string sParam, bool &bVal)
bool	GetConfigurationParam (std::string sAppName, std::string sParam, int &nVal)
bool	GetConfigurationParam (std::string sAppName, std::string sParam, unsigned int &nVal)
bool	GetConfigurationParam (std::string sParam, std::string &sVal)
bool	GetConfigurationParam (std::string sParam, double &dfVal)
	READ DOUBLES.
bool	GetConfigurationParam (std::string sParam, float &fVal)
	READ FLOATS.
bool	GetConfigurationParam (std::string sParam, bool &bVal)
	READ BOOLS.
bool	GetConfigurationParam (std::string sParam, int &nVal)
	READ INTS.
bool	GetConfigurationParam (std::string sParam, unsigned int &nVal)
bool	GetConfigurationParam (std::string sParam, std::vector< double > &Vec, int &nRows, int &nCols)
	READ VECTORS.
bool	GetConfiguration (std::string sAppName, STRING_LIST &Params)
Public Attributes
std::string	m_sAppName

Detailed Description

Class for reading MOOS configuration files.

Definition at line 50 of file ProcessConfigReader.h.

Constructor & Destructor Documentation

CProcessConfigReader::CProcessConfigReader ( )

Definition at line 44 of file ProcessConfigReader.cpp.

CProcessConfigReader::~CProcessConfigReader ( ) [virtual]

Definition at line 49 of file ProcessConfigReader.cpp.

Member Function Documentation

std::string CProcessConfigReader::GetAppName ( )

returns the name of the application an instance of this class is concerned with

Definition at line 62 of file ProcessConfigReader.cpp.

bool CProcessConfigReader::GetConfiguration	(	std::string	sAppName,
		STRING_LIST &	Params
	)

return a list of strings of Token = Val for the specfied named application configuration block

Definition at line 75 of file ProcessConfigReader.cpp.

bool CProcessConfigReader::GetConfigurationParam	(	std::string	sParam,
		std::vector< double > &	Vec,
		int &	nRows,
		int &	nCols
	)

READ VECTORS.

read a vector<double> parameter for a Process "m_sName" (can be interprested as a matrix with (rows x cols)

Definition at line 336 of file ProcessConfigReader.cpp.

bool CProcessConfigReader::GetConfigurationParam	(	std::string	sParam,
		unsigned int &	nVal
	)

read a unsigned int parameter for a Process "m_sName"

Definition at line 316 of file ProcessConfigReader.cpp.

bool CProcessConfigReader::GetConfigurationParam	(	std::string	sParam,
		int &	nVal
	)

READ INTS.

read a int parameter for a Process "m_sName"

Definition at line 290 of file ProcessConfigReader.cpp.

bool CProcessConfigReader::GetConfigurationParam	(	std::string	sParam,
		bool &	bVal
	)

READ BOOLS.

read a bool parameter for a Process "m_sName"

Definition at line 150 of file ProcessConfigReader.cpp.

bool CProcessConfigReader::GetConfigurationParam	(	std::string	sAppName,
		std::string	sParam,
		std::string &	sVal
	)

READ STRINGS.

read a string parameter for a named process

Definition at line 243 of file ProcessConfigReader.cpp.

bool CProcessConfigReader::GetConfigurationParam	(	std::string	sParam,
		double &	dfVal
	)

READ DOUBLES.

read a double parameter for a Process "m_sName"

Definition at line 190 of file ProcessConfigReader.cpp.

bool CProcessConfigReader::GetConfigurationParam	(	std::string	sParam,
		std::string &	sVal
	)

read a string parameter for a Process "m_sName"

Definition at line 273 of file ProcessConfigReader.cpp.

bool CProcessConfigReader::GetConfigurationParam	(	std::string	sAppName,
		std::string	sParam,
		int &	nVal
	)

read a integer parameter for a named process

Definition at line 304 of file ProcessConfigReader.cpp.

bool CProcessConfigReader::GetConfigurationParam	(	std::string	sAppName,
		std::string	sParam,
		unsigned int &	nVal
	)

read a unsigned integer parameter for a named process

Definition at line 325 of file ProcessConfigReader.cpp.

bool CProcessConfigReader::GetConfigurationParam	(	std::string	sAppName,
		std::string	sParam,
		bool &	bVal
	)

read a bool parameter for a named process

Definition at line 171 of file ProcessConfigReader.cpp.

bool CProcessConfigReader::GetConfigurationParam	(	std::string	sParam,
		float &	fVal
	)

READ FLOATS.

read a float parameter for a Process "m_sName"

Definition at line 223 of file ProcessConfigReader.cpp.

bool CProcessConfigReader::GetConfigurationParam	(	std::string	sAppName,
		std::string	sParam,
		double &	dfVal
	)

read a double parameter for a named process

Definition at line 204 of file ProcessConfigReader.cpp.

bool CProcessConfigReader::GetConfigurationParam	(	std::string	sAppName,
		std::string	sParam,
		float &	fVal
	)

read a float parameter for a named process

Definition at line 232 of file ProcessConfigReader.cpp.

std::string CProcessConfigReader::GetFileName ( )

returns the name of the mission file this process is accessing

Definition at line 67 of file ProcessConfigReader.cpp.

void CProcessConfigReader::SetAppName ( std::string sAppName )

set the name of the application (MOOSProcess) that this class shoud concern itself with (unless directed otherwise)

Definition at line 57 of file ProcessConfigReader.cpp.

Member Data Documentation

std::string CProcessConfigReader::m_sAppName

the name of process an instance this class will handle unless told otherwise

Definition at line 109 of file ProcessConfigReader.h.

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

/home/toby/moos-ivp/MOOS-2375-Oct0611/Core/MOOSGenLib/ProcessConfigReader.h
/home/toby/moos-ivp/MOOS-2375-Oct0611/Core/MOOSGenLib/ProcessConfigReader.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation