bio::chemical::Products Class Reference

#include <Products.h>

Public Member Functions
	Products ()
	Products (Code result)
	Products (Code result, const Substances *substances)
	Products (const Reactants *reactants)
	Products (const Substances *substances)
virtual	~Products ()
	operator Code ()
	operator Reactants ()
	operator Substances ()
virtual bool	operator!= (const Code code) const
virtual bool	operator== (const Code code) const

Protected Attributes
Code	m_result
Substances	m_substances

Detailed Description

Products are the result of a chemical::Reaction. As such, they include Substances (in order to chain Reactions) And they include a Code, indicating the result of the reaction. They can be treated as either Substances or a Code.

Definition at line 36 of file Products.h.

Constructor & Destructor Documentation

Products() [1/5]

bio::chemical::Products::Products

(

)

Definition at line 28 of file Products.cpp.

    :
    m_result(CodePerspective::InvalidId())
{
 
}

Products() [2/5]

bio::chemical::Products::Products

(

Code

result

)

Parameters

result

Definition at line 35 of file Products.cpp.

    :
    m_result(result)
{
 
}

Products() [3/5]

bio::chemical::Products::Products

(

const Substances *

substances

)

Assume m_result Success(), since we're given a value and no error to report.

Parameters

substances

Definition at line 42 of file Products.cpp.

    :
    m_result(code::Success()),
    m_substances(*substances)
{
 
}

Products() [4/5]

bio::chemical::Products::Products

(

const Reactants *

reactants

)

Assume m_result Success(), since we're given a value and no error to report.

Parameters

reactants

Definition at line 50 of file Products.cpp.

    :
    m_result(code::Success()),
    m_substances(reactants->GetAllAsVector< Substance* >())
{
 
}

Products() [5/5]

bio::chemical::Products::Products	(	Code	result,
		const Substances *	substances
	)

Parameters

result
substances

Definition at line 58 of file Products.cpp.

    :
    m_result(result),
    m_substances(*substances)
{
 
}

~Products()

bio::chemical::Products::~Products ( )

virtual

Definition at line 69 of file Products.cpp.

{
 
}

Member Function Documentation

operator Code()

bio::chemical::Products::operator Code

(

)

Returns

*this as a Code.

Definition at line 74 of file Products.cpp.

{
    return m_result;
}

operator Reactants()

bio::chemical::Products::operator Reactants

(

)

see molecular::Pathway for use.

Returns

*this as Reactants

Definition at line 84 of file Products.cpp.

{
    return Reactants(m_substances);
}

operator Substances()

bio::chemical::Products::operator Substances

(

)

Returns

*this as Substances.

Definition at line 79 of file Products.cpp.

{
    return m_substances;
}

operator!=()

bool bio::chemical::Products::operator!= ( const Code  code ) const

virtual

Parameters

code

Returns

whether or not the given code does not match that of *this.

Definition at line 89 of file Products.cpp.

{
    return m_result != code;
}

References m_result.

operator==()

bool bio::chemical::Products::operator== ( const Code  code ) const

virtual

Parameters

code

Returns

whether or not the given code matches that of *this.

Definition at line 94 of file Products.cpp.

{
    return m_result == code;
}

References m_result.

Member Data Documentation

m_result

Code bio::chemical::Products::m_result

protected

Definition at line 106 of file Products.h.

Referenced by operator!=(), and operator==().

m_substances

Substances bio::chemical::Products::m_substances

protected

Definition at line 105 of file Products.h.

---

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

• /home/eons/git/biology/lib_bio/inc/bio/chemical/reaction/Products.h
• /home/eons/git/biology/lib_bio/src/chemical/reaction/Products.cpp