chemmisol 0.1
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
chemmisol::InvalidReaction Class Reference

#include <reaction.h>

Inheritance diagram for chemmisol::InvalidReaction:
Inheritance graph
[legend]
Collaboration diagram for chemmisol::InvalidReaction:
Collaboration graph
[legend]

Public Member Functions

 InvalidReaction (const ChemicalSystem *chemical_system, const Reaction *invalid_reaction)
 
const ChemicalSystemgetChemicalSystem () const
 
const ReactiongetInvalidReaction () const
 

Protected Attributes

const ChemicalSystemchemical_system
 
const Reactioninvalid_reaction
 

Detailed Description

Exception thrown when a ChemicalSystem tries to process an ill formed reaction.

A reaction is considered valid when its list of reagents is not empty and contains only components except one species (the "produced species") that cannot be a component.

Constructor & Destructor Documentation

◆ InvalidReaction()

chemmisol::InvalidReaction::InvalidReaction ( const ChemicalSystem chemical_system,
const Reaction invalid_reaction 
)
inline

Defines an InvalidReaction exception.

Parameters
chemical_systemchemical system that tried to handle the ill formed reaction.
invalid_reactionill formed reaction.

Member Function Documentation

◆ getChemicalSystem()

const ChemicalSystem & chemmisol::InvalidReaction::getChemicalSystem ( ) const
inline

Returns a reference to the chemical system that tried to handle the ill formed reaction.

◆ getInvalidReaction()

const Reaction & chemmisol::InvalidReaction::getInvalidReaction ( ) const
inline

Returns reference to the ill formed reaction.

Member Data Documentation

◆ chemical_system

const ChemicalSystem* chemmisol::InvalidReaction::chemical_system
protected

Reference to the chemical system that tried to handle the ill formed reaction.

◆ invalid_reaction

const Reaction* chemmisol::InvalidReaction::invalid_reaction
protected

Reference to the ill formed reaction.


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