COPASI API  4.40.278
CFluxMode Class Reference

#include <CFluxMode.h>

Public Types

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

Public Member Functions

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

Private Attributes

std::map< size_t, C_FLOAT64mReactions
 
bool mReversible
 

Member Typedef Documentation

◆ const_iterator

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

Constructor & Destructor Documentation

◆ CFluxMode() [1/4]

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

References CONSTRUCTOR_TRACE.

◆ CFluxMode() [2/4]

CFluxMode::CFluxMode ( const CFluxMode src)

Copy constructor

Parameters
const CFluxMode &src

◆ CFluxMode() [3/4]

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

Specific constructor

Parameters
conststd::map< size_t, C_FLOAT64 > & reactions
constbool & reversible

◆ CFluxMode() [4/4]

CFluxMode::CFluxMode ( const CTableauLine line)

Specific constructor

Parameters
const CTableauLine &line

References CTableauLine::getFluxMode(), CTableauLine::isReversible(), mReactions, and mReversible.

◆ ~CFluxMode()

CFluxMode::~CFluxMode ( )

Destructor

Member Function Documentation

◆ begin()

CFluxMode::const_iterator CFluxMode::begin ( ) const

Retrieve the iterator to the first element of the flux mode

Returns
CFluxMode::const_iterator begin;

References mReactions.

Referenced by CEFMTask::getFluxModeDescription(), CEFMTask::getNetReactionData(), and CEFMTask::getSpeciesChanges().

◆ end()

CFluxMode::const_iterator CFluxMode::end ( ) const

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

Returns
CFluxMode::const_iterator end;

References mReactions.

Referenced by CEFMTask::getFluxModeDescription(), CEFMTask::getNetReactionData(), and CEFMTask::getSpeciesChanges().

◆ getMultiplier()

C_FLOAT64 CFluxMode::getMultiplier ( const size_t &  index) const

Retrieve the multiplier for the indexed reaction

Parameters
constsize_t & index
Returns
C_FLOAT64 multiplier

References mReactions.

◆ isReversed()

bool CFluxMode::isReversed ( const CFluxMode mode)

Determine whether the current mode is the reversed mode

Parameters
constCFluxMode &mode
Returns
bool isReversed

References mReactions, and size().

◆ isReversible()

bool CFluxMode::isReversible ( ) const

Check whether the mode is reversible

Returns
"bool" isReversible

References mReversible.

Referenced by CEFMTask::getNetReaction().

◆ size()

size_t CFluxMode::size ( ) const

Retrieves the size of the mode

Returns
"size_t" size

References mReactions.

Referenced by isReversed().

Member Data Documentation

◆ mReactions

std::map< size_t, C_FLOAT64 > CFluxMode::mReactions
private

Vector containing an index to a reaction and the multiplier for that reaction.

Referenced by begin(), CFluxMode(), end(), getMultiplier(), isReversed(), and size().

◆ mReversible

bool CFluxMode::mReversible
private

Reversibility of the mode.

Referenced by CFluxMode(), and isReversible().


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