CReactionResult Class Reference

#include <CModelAnalyzer.h>

Public Member Functions
	CReactionResult ()
const std::string &	getName () const
std::string	getResultString (bool rt, bool verbose) const
bool	hasIssue () const
bool	writeResult (std::ostream &os, bool rt, bool verbose, bool writeToStream=true) const
virtual	~CReactionResult ()

Protected Attributes
std::vector< std::string >	mChemEqMods
std::vector< std::string >	mChemEqProds
std::vector< std::string >	mChemEqSubs
std::vector< std::string >	mFunctionParametersMods
std::vector< std::string >	mFunctionParametersParams
std::vector< std::string >	mFunctionParametersProds
std::vector< std::string >	mFunctionParametersSubs
std::vector< std::string >	mFunctionParametersTime
std::vector< std::string >	mFunctionParametersVar
std::vector< std::string >	mFunctionParametersVol
CFunctionAnalyzer::Result	mFunctionResult
bool	mKineticUnspecifiedReversibility
std::vector< std::string >	mNotMetabolite
std::string	mReactionName
bool	mReversibilityMismatch

Friends
class	CModelAnalyzer

Constructor & Destructor Documentation

CReactionResult()

CReactionResult::CReactionResult

(

)

~CReactionResult()

CReactionResult::~CReactionResult ( )

virtual

Member Function Documentation

getName()

const std::string & CReactionResult::getName

(

)

const

Returns

the name of the reaction for this result

References mReactionName.

getResultString()

std::string CReactionResult::getResultString	(	bool	rt,
		bool	verbose
	)		const

Parameters

rt	use html wrapping / colors
verbose	add more information

Returns

the string representation of the result

References writeResult().

hasIssue()

bool CReactionResult::hasIssue

(

)

const

Returns

true, if the analysis showed there was an issue with the reaction false otherwise

References writeResult().

writeResult()

bool CReactionResult::writeResult	(	std::ostream &	os,
		bool	rt,
		bool	verbose,
		bool	writeToStream = true
	)		const

writes a text report about the function to the stream. The return value indicates if a problem was reported.

Parameters

rt	use html wrapping / colors
verbose	add more information
writeToStream	boolean indicating whether results should be written to stream (default), or only checked whether there was an issue

Returns

boolean indicating whether there was an issue or not

References mChemEqMods, mChemEqProds, mChemEqSubs, mFunctionParametersMods, mFunctionParametersParams, mFunctionParametersProds, mFunctionParametersSubs, mFunctionParametersTime, mFunctionParametersVar, mFunctionParametersVol, mFunctionResult, mKineticUnspecifiedReversibility, mNotMetabolite, mReactionName, mReversibilityMismatch, CFunctionAnalyzer::write(), and CFunctionAnalyzer::Result::writeResult().

Referenced by getResultString(), and hasIssue().

Friends And Related Function Documentation

CModelAnalyzer

friend class CModelAnalyzer

friend

Member Data Documentation

mChemEqMods

std::vector<std::string> CReactionResult::mChemEqMods

protected

Referenced by CModelAnalyzer::checkReaction(), and writeResult().

mChemEqProds

std::vector<std::string> CReactionResult::mChemEqProds

protected

Referenced by CModelAnalyzer::checkReaction(), and writeResult().

mChemEqSubs

std::vector<std::string> CReactionResult::mChemEqSubs

protected

Referenced by CModelAnalyzer::checkReaction(), and writeResult().

mFunctionParametersMods

std::vector<std::string> CReactionResult::mFunctionParametersMods

protected

Referenced by CModelAnalyzer::checkReaction(), and writeResult().

mFunctionParametersParams

std::vector<std::string> CReactionResult::mFunctionParametersParams

protected

Referenced by CModelAnalyzer::checkReaction(), and writeResult().

mFunctionParametersProds

std::vector<std::string> CReactionResult::mFunctionParametersProds

protected

Referenced by CModelAnalyzer::checkReaction(), and writeResult().

mFunctionParametersSubs

std::vector<std::string> CReactionResult::mFunctionParametersSubs

protected

Referenced by CModelAnalyzer::checkReaction(), and writeResult().

mFunctionParametersTime

std::vector<std::string> CReactionResult::mFunctionParametersTime

protected

Referenced by CModelAnalyzer::checkReaction(), and writeResult().

mFunctionParametersVar

std::vector<std::string> CReactionResult::mFunctionParametersVar

protected

Referenced by CModelAnalyzer::checkReaction(), and writeResult().

mFunctionParametersVol

std::vector<std::string> CReactionResult::mFunctionParametersVol

protected

Referenced by CModelAnalyzer::checkReaction(), and writeResult().

mFunctionResult

CFunctionAnalyzer::Result CReactionResult::mFunctionResult

protected

Referenced by CModelAnalyzer::checkReaction(), and writeResult().

mKineticUnspecifiedReversibility

bool CReactionResult::mKineticUnspecifiedReversibility

protected

Referenced by CModelAnalyzer::checkReaction(), and writeResult().

mNotMetabolite

std::vector<std::string> CReactionResult::mNotMetabolite

protected

Referenced by CModelAnalyzer::checkReaction(), and writeResult().

mReactionName

std::string CReactionResult::mReactionName

protected

Referenced by CModelAnalyzer::checkReaction(), getName(), and writeResult().

mReversibilityMismatch

bool CReactionResult::mReversibilityMismatch

protected

Referenced by CModelAnalyzer::checkReaction(), and writeResult().

---

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

• CModelAnalyzer.h
• CModelAnalyzer.cpp