Generated on Wed Apr 29 2015 11:51:41 for GGL-4.1.2 by doxygen 1.8.3.1
Public Types | Public Member Functions | Data Fields
ggl::chem::Reaction Class Reference

Reaction description. More...

#include <Reaction.hh>

Public Types

typedef std::multiset
< std::string > 
Metabolite_Container
 container that stores all metabolites/educts of the reaction More...
 
typedef std::multiset
< std::string > 
Product_Container
 container that stores all products of the reaction More...
 

Public Member Functions

void clear (void)
 resets the content to values of default construction; More...
 
bool operator< (const Reaction &r2) const
 
 Reaction ()
 Default construction with empty content. More...
 
 Reaction (const std::string &rule_id, const Metabolite_Container &metabolites, const Product_Container &products, const double rate, const std::string &transState)
 
 ~Reaction ()
 Destruction. More...
 

Data Fields

Metabolite_Container metabolites
 the SMILES of the molecules involved in this reaction More...
 
Product_Container products
 the SMILES of the produced molecules of this reaction More...
 
double rate
 the rate of the reaction More...
 
std::string rule_id
 
std::string transState
 

Detailed Description

    A data container describing information of a chemical reaction.
Author
Martin Mann (c) 2009 http://www.bioinf.uni-freiburg.de/~mmann/
Alexander Ullrich

Definition at line 20 of file Reaction.hh.

Member Typedef Documentation

typedef std::multiset< std::string > ggl::chem::Reaction::Metabolite_Container

Definition at line 25 of file Reaction.hh.

typedef std::multiset< std::string > ggl::chem::Reaction::Product_Container

Definition at line 28 of file Reaction.hh.

Constructor & Destructor Documentation

ggl::chem::Reaction::Reaction ( )
ggl::chem::Reaction::Reaction ( const std::string &  rule_id,
const Metabolite_Container metabolites,
const Product_Container products,
const double  rate,
const std::string &  transState 
)

Construction

Parameters
rule_idthe identifier of the rule that was applied
metabolitesthe SMILES of the molecules involved
productsthe SMILES of the produced molecules
ratethe rate of the reaction
transStatethe SMILES of the transition state
ggl::chem::Reaction::~Reaction ( )

Member Function Documentation

void ggl::chem::Reaction::clear ( void  )
bool ggl::chem::Reaction::operator< ( const Reaction r2) const

Comparison operator to enable the storage of Reaction objects in ordered containers like std::set that require a strict less ordering.

Parameters
r2the Reaction to compare to
Returns
true if [ (rule_id < r2.rule_id) or equal and (less products) or equal and (less metabolites) or equal and (equal product number and one SMILES smaller) or equal and (equal metabolites number and one SMILES smaller) or equal and (both rates are set) and (rate < r2.rate) ], false otherwise

Field Documentation

Metabolite_Container ggl::chem::Reaction::metabolites

Definition at line 38 of file Reaction.hh.

Product_Container ggl::chem::Reaction::products

Definition at line 41 of file Reaction.hh.

double ggl::chem::Reaction::rate

Definition at line 44 of file Reaction.hh.

std::string ggl::chem::Reaction::rule_id

the identifier of the ggl::chem::ChemRule rule that was applied in this reaction.

Definition at line 35 of file Reaction.hh.

std::string ggl::chem::Reaction::transState

The SMILES of the transition state along the reaction. It is used to calculate appropriate reaction rates.

Definition at line 48 of file Reaction.hh.


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