CReadConfig Class Reference

#include <CReadConfig.h>

List of all members.

Public Types
enum	Mode { NEXT = 0, SEARCH, LOOP, ALL }
Public Member Functions
	CReadConfig ()
	CReadConfig (const std::string &name)
	~CReadConfig ()
std::string	getVersion ()
void	getDefaults ()
C_INT32	fail ()
C_INT32	getVariable (const std::string &name, const std::string &type, void *pout, CReadConfig::Mode mode=CReadConfig::NEXT)
C_INT32	getVariable (const std::string &name, const std::string &type, void *pout1, void *pout2, CReadConfig::Mode mode=CReadConfig::NEXT)
void	rewind ()

---

Detailed Description

CReadConfig class. A more elaborate class description. New Class based on pmutils read functionality

(C) Stefan Hoops 2001

---

Member Enumeration Documentation

enum CReadConfig::Mode

Enumerator:

NEXT
SEARCH
LOOP
ALL

---

Constructor & Destructor Documentation

CReadConfig::CReadConfig

(

void

)

Default consructor. This creates a configuration buffer for input assigning a filename. It is currently useless.

CReadConfig::CReadConfig

(

const std::string &

name

)

Specified constructor. This opens the configuration file using the filename specified as the argument.

Parameters:

name	name of the confguration file.

CReadConfig::~CReadConfig

(

void

)

Destructor. The destructor calls the method free().

---

Member Function Documentation

C_INT32 CReadConfig::fail

(

)

Returns the failure status.

Returns:

mFail

See also:

mFail

void CReadConfig::getDefaults

(

)

Load various system wide default values

C_INT32 CReadConfig::getVariable	(	const std::string &	name,
		const std::string &	type,
		void *	pout,
		CReadConfig::Mode	mode = CReadConfig::NEXT
	)

Retrieves a variable from the input file.

Parameters:

name	name of the variable to be retrieved.
type	type of the variable to be retrieved.
*pout	pointer to the location where the retrieved variable is stored.

Returns:

mFail

See also:

mFail

C_INT32 CReadConfig::getVariable	(	const std::string &	name,
		const std::string &	type,
		void *	pout1,
		void *	pout2,
		CReadConfig::Mode	mode = CReadConfig::NEXT
	)

Retrieves a variable from the input file.

Parameters:

name	name of the variable to be retrieved.
type	type of the variable to be retrieved.
*pout1	pointer to the location where the first part of the retrieved variable is stored.
*pout2	pointer to the location where the second part of the retrieved variable is stored.

Returns:

mFail

See also:

mFail

std::string CReadConfig::getVersion

(

)

Retrieves the version string of the configbuffer

void CReadConfig::rewind

(

)

Rewind the buffer

---

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

• copasi/utilities/CReadConfig.h
• copasi/utilities/CReadConfig.cpp