CFluxMode Class Reference

#include <CFluxMode.h>

List of all members.

Public Types
typedef std::map< size_t, C_FLOAT64 >::const_iterator	const_iterator
Public Member Functions
	CFluxMode ()
	CFluxMode (const CFluxMode &src)
	CFluxMode (const std::map< size_t, C_FLOAT64 > &reactions, const bool &reversible)
	CFluxMode (const CTableauLine *line)
	~CFluxMode ()
const_iterator	begin () const
const_iterator	end () const
bool	isReversible () const
unsigned C_INT32	size () const
bool	isReversed (const CFluxMode &mode)
C_FLOAT64	getMultiplier (const size_t &index) const

---

Member Typedef Documentation

typedef std::map< size_t, C_FLOAT64 >::const_iterator CFluxMode::const_iterator

---

Constructor & Destructor Documentation

CFluxMode::CFluxMode

(

)

Default constructor

CFluxMode class. Used to return the flux modes in human readable form

Created for Copasi by Stefan Hoops 2002-05-10 (C) Stefan Hoops 2002

CFluxMode::CFluxMode

(

const CFluxMode &

src

)

Copy constructor

Parameters:

const CFluxMode &

src

CFluxMode::CFluxMode	(	const std::map< size_t, C_FLOAT64 > &	reactions,
		const bool &	reversible
	)

Specific constructor

Parameters:

const	std::map< size_t, C_FLOAT64 > & reactions
const	bool & reversible

CFluxMode::CFluxMode

(

const CTableauLine *

line

)

Specific constructor

Parameters:

const CTableauLine &

line

CFluxMode::~CFluxMode

(

)

Destructor

---

Member Function Documentation

CFluxMode::const_iterator CFluxMode::begin

(

)

const

Retrieve the iterator to the first element of the flux mode

Returns:

CFluxMode::const_iterator begin;

CFluxMode::const_iterator CFluxMode::end

(

)

const

Retrieve the iterator pointing beyond the last element of the flux mode

Returns:

CFluxMode::const_iterator end;

C_FLOAT64 CFluxMode::getMultiplier

(

const size_t &

index

)

const

Retrieve the multiplier for the indexed reaction

Parameters:

const

size_t & index

Returns:

C_FLOAT64 multiplier

bool CFluxMode::isReversed

(

const CFluxMode &

mode

)

Determine whether the current mode is the reversed mode

Parameters:

const

CFluxMode &mode

Returns:

bool isReversed

bool CFluxMode::isReversible

(

)

const

Check whether the mode is reversible

Returns:

"bool" isReversible

unsigned C_INT32 CFluxMode::size

(

)

const

Retrieves the size of the mode

Returns:

"unsigned C_INT32" size

---

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

• copasi/elementaryFluxModes/CFluxMode.h
• copasi/elementaryFluxModes/CFluxMode.cpp