CEFMTask Class Reference

#include <CEFMTask.h>

Inheritance diagram for CEFMTask:

List of all members.

Public Member Functions
	CEFMTask (const CCopasiContainer *pParent=NULL)
	CEFMTask (const CEFMTask &src, const CCopasiContainer *pParent=NULL)
virtual	~CEFMTask ()
virtual bool	setCallBack (CProcessReport *pCallBack)
virtual bool	initialize (const OutputFlag &of, COutputHandler *pOutputHandler, std::ostream *pOstream)
virtual bool	process (const bool &useInitialValues)
virtual bool	setMethodType (const int &type)
const std::vector< CFluxMode > &	getFluxModes () const
std::string	getFluxModeDescription (const CFluxMode &fluxMode) const
std::string	getReactionEquation (const std::map< size_t, C_FLOAT64 >::const_iterator &itReaction) const
std::pair< C_FLOAT64, C_FLOAT64 >	getSpeciesChanges (const CFluxMode &fluxMode, const CMetab &metab) const
std::string	getNetReaction (const CFluxMode &fluxMode) const
std::string	getInternalSpecies (const CFluxMode &fluxMode) const
Static Public Member Functions
static bool	isValidMethod (const unsigned C_INT32 &method, const unsigned C_INT32 *validMethods)
Static Public Attributes
static const unsigned C_INT32	ValidMethods []

---

Constructor & Destructor Documentation

CEFMTask::CEFMTask

(

const CCopasiContainer *

pParent = NULL

)

default constructor

Parameters:

const

CCopasiContainer * pParent (default: NULL)

CEFMTask::CEFMTask	(	const CEFMTask &	src,
		const CCopasiContainer *	pParent = NULL
	)

Copy constructor

Parameters:

const

COptTask & src

CEFMTask::~CEFMTask

(

)

[virtual]

Destructor

---

Member Function Documentation

std::string CEFMTask::getFluxModeDescription

(

const CFluxMode &

fluxMode

)

const

Retrieve the description of the flux mode

Parameters:

const

CFluxMode & fluxMode

Returns:

std::string fluxModeDescription

const std::vector< CFluxMode > & CEFMTask::getFluxModes

(

)

const

Retrieve the Flux Modes

Returns:

const std::vector< CFluxMode > &

std::string CEFMTask::getInternalSpecies

(

const CFluxMode &

fluxMode

)

const

Retrieve the internal species for the given flux mode.

Parameters:

const

CFluxMode & fluxMode

Returns:

std::string species

std::string CEFMTask::getNetReaction

(

const CFluxMode &

fluxMode

)

const

Retrieve the net reaction for the given flux mode.

Parameters:

const

CFluxMode & fluxMode

Returns:

std::string netReaction

std::string CEFMTask::getReactionEquation

(

const std::map< size_t, C_FLOAT64 >::const_iterator &

itReaction

)

const

Retrieve the reaction equation of the part of the flux mode pointed at by itReaction

Parameters:

const

std::map< size_t, C_FLOAT64 >::const_iterator & itReaction

Returns:

std::string reactionEquation

std::pair< C_FLOAT64, C_FLOAT64 > CEFMTask::getSpeciesChanges	(	const CFluxMode &	fluxMode,
		const CMetab &	metab
	)		const

Retrieve the species changes for the given flux mode and species

Parameters:

const	CFluxMode & fluxMode
const	CMetab & pMetab

Returns:

std::pair< C_FLOAT64, C_FLOAT64 > changes

bool CEFMTask::initialize	(	const OutputFlag &	of,
		COutputHandler *	pOutputHandler,
		std::ostream *	pOstream
	)		[virtual]

Initialize the task. If an ostream is given this ostream is used instead of the target specified in the report. This allows nested tasks to share the same output device.

Parameters:

const	OutputFlag & of
COutputHandler	* pOutputHandler
std::ostream	* pOstream (default: NULL)

Returns:

bool success

Reimplemented from CCopasiTask.

static bool CEFMTask::isValidMethod	(	const unsigned C_INT32 &	method,
		const unsigned C_INT32 *	validMethods
	)		[static]

Check whether the given method is in the list of valid methods This list must end with CCopasiMethod::unset

Parameters:

const	unsigned C_INT32 & method
const	unsigned C_INT32 * validMethods

Returns:

bool isValid

Reimplemented from CCopasiTask.

bool CEFMTask::process

(

const bool &

useInitialValues

)

[virtual]

Process the task with or without initializing to the initial state.

Parameters:

const

bool & useInitialValues

Returns:

bool success

Reimplemented from CCopasiTask.

bool CEFMTask::setCallBack

(

CProcessReport *

pCallBack

)

[virtual]

Set the call back of the task

Parameters:

CProcessReport

* pCallBack

Returns:

bool succes

Reimplemented from CCopasiTask.

bool CEFMTask::setMethodType

(

const int &

type

)

[virtual]

Set the method type applied to solve the task

Parameters:

const

CCopasiMethod::SubType & type

Returns:

bool success

Reimplemented from CCopasiTask.

---

Member Data Documentation

const unsigned C_INT32 CEFMTask::ValidMethods [static]

Initial value:

{
  CCopasiMethod::EFMAlgorithm,



 


 
  0
}

The methods which can be selected for performing this task.

CEFMTask class.

This class implements a optimization task which is comprised of a of a problem and a method.

Reimplemented from CCopasiTask.

---

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

• copasi/elementaryFluxModes/CEFMTask.h
• copasi/elementaryFluxModes/CEFMTask.cpp