#include <Reactants.h>

Inheritance diagram for bio::chemical::Reactants:

Collaboration diagram for bio::chemical::Reactants:

Public Member Functions
	Reactants (Substances &substances)

virtual	~Reactants ()

	BIO_DISAMBIGUATE_ALL_CLASS_METHODS (chemical, Reactants) Reactants()

	operator Substances ()

Public Member Functions inherited from bio::chemical::Structure
	Structure ()

virtual	~Structure ()

Public Member Functions inherited from bio::chemical::UnorderedStructureInterface
	UnorderedStructureInterface ()

virtual	~UnorderedStructureInterface ()

template<typename T >
T	Add (const T t)

template<typename T >
void	Clear ()

template<typename T >
Container *	GetAll ()

template<typename T >
const Container *	GetAll () const

template<typename T >
std::vector< T >	GetAllAsVector ()

template<typename T >
const std::vector< T >	GetAllAsVector () const

template<typename T >
unsigned long	GetCount () const

template<typename T >
unsigned int	GetNumMatching (const Container *other) const

template<typename T >
std::string	GetStringFrom (std::string separator=", ")

template<typename T >
bool	Has (T content) const

template<typename T >
bool	HasAll (const Container *contents) const

template<typename T >
void	Import (const std::vector< T > &other)

template<typename T >
void	Import (const UnorderedMotif< T > *other)

Code	ImportAll (const physical::Wave *other)

template<typename T >
T	Remove (const T t)

Public Member Functions inherited from bio::ThreadSafe
	ThreadSafe ()

	ThreadSafe (const ThreadSafe &toCopy)

virtual	~ThreadSafe ()

void	LockThread () const

void	UnlockThread () const

Public Member Functions inherited from bio::chemical::Atom
	Atom (const Atom &other)

virtual	~Atom ()

template<typename T >
T	As ()

template<typename T >
const T	As () const

template<typename T >
T	AsBonded ()

template<typename T >
const T	AsBonded () const

template<typename T >
T	AsBondedQuantum ()

template<typename T >
const T	AsBondedQuantum () const

virtual Code	Attenuate (const Wave *other)

	BIO_DISAMBIGUATE_ALL_CLASS_METHODS (physical, Atom) explicit Atom()

template<typename T >
bool	BreakBond (T toDisassociate, BondType type=bond_type::Unknown())

virtual Code	Disattenuate (const Wave *other)

template<typename T >
bool	FormBond (T toBond, BondType type=bond_type::Unknown())

Bonds *	GetAllBonds ()

const Bonds *	GetAllBonds () const

Wave *	GetBonded (Valence position)

const Wave *	GetBonded (Valence position) const

template<typename T >
Valence	GetBondPosition () const

Valence	GetBondPosition (AtomicNumber bondedId) const

Valence	GetBondPosition (Name typeName) const

template<typename T >
BondType	GetBondType () const

BondType	GetBondType (Valence position) const

template<typename T >
	operator T ()

virtual Code	Reify (physical::Symmetry *symmetry)

virtual physical::Symmetry *	Spin () const

Public Member Functions inherited from bio::physical::Class< Atom >
	Class (Atom object, Symmetry symmetry=NULL)

virtual	~Class ()

virtual Wave *	AsWave ()

virtual const Wave *	AsWave () const

virtual Wave *	Clone () const

Atom *	Convert (Wave *wave)

virtual	operator Atom * ()

virtual	operator Wave * ()

Public Member Functions inherited from bio::physical::Wave
	Wave (Symmetry *symmetry=NULL)

virtual	~Wave ()

virtual chemical::Atom *	AsAtom ()

virtual const chemical::Atom *	AsAtom () const

virtual Wave *	AsWave ()

virtual const Wave *	AsWave () const

virtual Code	Attenuate (const Wave *other)

virtual Wave *	Clone () const

virtual Wave *	Demodulate ()

virtual const Wave *	Demodulate () const

virtual Code	Disattenuate (const Wave *other)

virtual Properties	GetProperties () const

virtual Wave *	Modulate (Wave *signal)

virtual Wave *	operator* ()

virtual const Wave *	operator* () const

virtual Wave *	operator* (Wave *signal)

virtual void	operator+ (const Wave *other)

virtual void	operator- (const Wave *other)

virtual void	operator\| (Symmetry *symmetry)

virtual Code	Reify (Symmetry *symmetry)

virtual Symmetry *	Spin () const

Public Member Functions inherited from bio::chemical::LinearStructureInterface
	LinearStructureInterface ()

virtual	~LinearStructureInterface ()

template<typename T >
Emission	ForEach (ExcitationBase *excitation)

template<typename T >
T	GetById (StandardDimension id)

template<typename T >
const T	GetById (StandardDimension id) const

template<typename T >
T	GetByName (Name name)

template<typename T >
const T	GetByName (Name name) const

template<typename T >
T	GetOrCreateById (StandardDimension id)

template<typename T >
T	GetOrCreateByName (Name name)

template<typename T >
Code	Insert (T toAdd, const Position position=BOTTOM, const StandardDimension optionalPositionArg=0, const bool transferSubContents=false)

Public Member Functions inherited from bio::chemical::Class< Reactants >
	BIO_DISAMBIGUATE_ALL_CLASS_METHODS (physical, Reactants) Class(Reactants *object

Public Member Functions inherited from bio::physical::Class< T >
	Class (T object, Symmetry symmetry=NULL)

virtual	~Class ()

virtual Wave *	AsWave ()

virtual const Wave *	AsWave () const

virtual Wave *	Clone () const

T *	Convert (Wave *wave)

virtual	operator T* ()

virtual	operator Wave * ()

Public Member Functions inherited from bio::physical::Identifiable< StandardDimension >
	BIO_DISAMBIGUATE_ALL_CLASS_METHODS (physical, Identifiable< StandardDimension >) explicit Identifiable(Perspective< StandardDimension > *perspective

void	CloneIntoName (Name name)

Public Member Functions inherited from bio::physical::Observer< Perspective< StandardDimension > >
	Observer (const Observer &other)

	Observer (Perspective *perspective=NULL)

virtual	~Observer ()

virtual Perspective *	GetPerspective () const

virtual void	SetPerspective (Perspective *perspective)

Public Member Functions inherited from bio::physical::Class< Identifiable< StandardDimension > >
	Class (Identifiable< StandardDimension > object, Symmetry symmetry=NULL)

virtual	~Class ()

virtual Wave *	AsWave ()

virtual const Wave *	AsWave () const

virtual Wave *	Clone () const

Identifiable< StandardDimension > *	Convert (Wave *wave)

virtual	operator Identifiable< StandardDimension > * ()

virtual	operator Wave * ()

Public Member Functions inherited from bio::log::Writer
	Writer (Engine *logEngine, Filter logFilter)

virtual	~Writer ()

	BIO_DISAMBIGUATE_ALL_CLASS_METHODS (physical, Writer) Writer()

void	ExternalLog (Filter logFilter, Level level, const char *format,...) const

Engine *	GetLogEngine ()

const Engine *	GetLogEngine () const

bool	HasLogEngine () const

virtual void	SetLogEngine (Engine *logEngine)

Public Member Functions inherited from bio::physical::Filterable
	Filterable (Filter filter)

virtual	~Filterable ()

	BIO_DISAMBIGUATE_ALL_CLASS_METHODS (physical, Filterable) Filterable()

Filter	GetFilter () const

virtual void	InitializeImplementation (ByteStreams args)

virtual Code	Reify (Symmetry *symmetry)

virtual void	SetFilter (Filter filter)

virtual Symmetry *	Spin () const

Public Member Functions inherited from bio::physical::Class< Filterable >
	Class (Filterable object, Symmetry symmetry=NULL)

virtual	~Class ()

virtual Wave *	AsWave ()

virtual const Wave *	AsWave () const

virtual Wave *	Clone () const

Filterable *	Convert (Wave *wave)

virtual	operator Filterable * ()

virtual	operator Wave * ()

Public Member Functions inherited from bio::physical::Class< Writer >
	Class (Writer object, Symmetry symmetry=NULL)

virtual	~Class ()

virtual Wave *	AsWave ()

virtual const Wave *	AsWave () const

virtual Wave *	Clone () const

Writer *	Convert (Wave *wave)

virtual	operator Wave * ()

virtual	operator Writer * ()

Public Member Functions inherited from bio::chemical::LinearMotif< Substance * >
	LinearMotif (const Contents contents, physical::Perspective< StandardDimension > perspective=NULL)

	LinearMotif (const LinearMotif< Substance * > &toCopy)

	LinearMotif (physical::Perspective< StandardDimension > *perspective=NULL)

virtual	~LinearMotif ()

virtual Substance *	AddImplementation (Substance * content)

virtual Code	Attenuate (const physical::Wave *other)

	BIO_DISAMBIGUATE_REQUIRED_CLASS_METHODS (chemical, LinearMotif< Substance * >) BIO_DISAMBIGUATE_OPTIONAL_CLASS_METHODS(physical

virtual void	ClearImplementation ()

virtual Substance *	CreateImplementation (StandardDimension id)

virtual Code	Disattenuate (const physical::Wave *other)

virtual Emission	ForEachImplementation (ExcitationBase *excitation)

virtual Substance *	GetByIdImplementation (StandardDimension id)

virtual const Substance *	GetByIdImplementation (StandardDimension id) const

virtual Substance *	GetByNameImplementation (Name name)

virtual const Substance *	GetByNameImplementation (Name name) const

virtual Substance *	GetOrCreateByIdImplementation (StandardDimension id)

virtual Substance *	GetOrCreateByNameImplementation (Name name)

virtual std::string	GetStringFromImplementation (std::string separator=", ")

physical::Perspective< StandardDimension > *	GetStructuralPerspective ()

const physical::Perspective< StandardDimension > *	GetStructuralPerspective () const

virtual bool	HasImplementation (const Substance * &content) const

virtual void	ImportImplementation (const LinearMotif< Substance * > *other)

virtual Code	InsertImplementation (Substance * toAdd, const Position position=BOTTOM, const StandardDimension optionalPositionArg=0, const bool transferSubContents=false)

Public Member Functions inherited from bio::chemical::Elementary< LinearMotif< Substance * > >
	Elementary ()

	Elementary (const Properties properties)

virtual	~Elementary ()

void	RegisterProperties (const Properties properties)

Public Member Functions inherited from bio::chemical::Class< LinearMotif< Substance * > >
	BIO_DISAMBIGUATE_ALL_CLASS_METHODS (physical, LinearMotif< Substance * >) Class(LinearMotif< Substance * > *object

Public Member Functions inherited from bio::chemical::UnorderedMotif< Substance * >
	UnorderedMotif (const Contents *contents)

	UnorderedMotif (const UnorderedMotif< Substance * > *toCopy)

virtual	~UnorderedMotif ()

virtual Substance *	AddImplementation (const Substance * content)

	BIO_DISAMBIGUATE_ALL_CLASS_METHODS (chemical, UnorderedMotif< Substance * >) UnorderedMotif()

virtual void	ClearImplementation ()

virtual unsigned long	GetCountImplementation () const

virtual unsigned int	GetNumMatchingImplementation (const Container *other) const

virtual std::string	GetStringFromImplementation (std::string separator=", ")

virtual bool	HasAllImplementation (const Container *contents) const

virtual bool	HasImplementation (const Substance * content) const

virtual void	ImportImplementation (const UnorderedMotif< Substance * > *other)

virtual Substance *	RemoveImplementation (const Substance * content)

Public Member Functions inherited from bio::chemical::Class< UnorderedMotif< Substance * > >
	BIO_DISAMBIGUATE_ALL_CLASS_METHODS (physical, UnorderedMotif< Substance * >) Class(UnorderedMotif< Substance * > *object

Public Member Functions inherited from bio::chemical::AbstractMotif
	AbstractMotif ()

virtual	~AbstractMotif ()

virtual void	ClearImplementation ()

virtual Container *	GetAllImplementation ()

virtual const Container *	GetAllImplementation () const

virtual unsigned long	GetCountImplementation () const

virtual std::string	GetStringFromImplementation (std::string separator=", ")

virtual void	ImportImplementation (const void *other)

Additional Inherited Members
Public Types inherited from bio::physical::Identifiable< StandardDimension >
typedef StandardDimension	Id

typedef std::vector< Id >	Ids

Public Types inherited from bio::physical::Observer< Perspective< StandardDimension > >
typedef Perspective< StandardDimension >	Perspective

Public Types inherited from bio::chemical::LinearMotif< Substance * >
typedef physical::Line	Contents

Public Types inherited from bio::chemical::UnorderedMotif< Substance * >
typedef physical::Arrangement< Substance * >	Contents

Static Public Member Functions inherited from bio::physical::Wave
static Properties	GetResonanceBetween (const Wave *wave, const Properties &properties)

static Properties	GetResonanceBetween (const Wave wave1, const Wave wave2)

static Properties	GetResonanceBetween (ConstWaves waves)

Static Public Member Functions inherited from bio::chemical::LinearMotif< Substance * >
static LinearMotif< Substance * > Properties	GetClassProperties ()

Static Public Member Functions inherited from bio::chemical::AbstractMotif
static Properties	GetClassProperties ()

Public Attributes inherited from bio::chemical::Class< Reactants >
physical::Perspective< StandardDimension > Filter	filter

physical::Perspective< StandardDimension > *	perspective

Public Attributes inherited from bio::physical::Identifiable< StandardDimension >
Id	m_id

Public Attributes inherited from bio::chemical::LinearMotif< Substance * >
physical::Perspective< StandardDimension > *	m_perspective

Public Attributes inherited from bio::chemical::Class< LinearMotif< Substance * > >
physical::Perspective< StandardDimension > Filter	filter

physical::Perspective< StandardDimension > *	perspective

Public Attributes inherited from bio::chemical::Class< UnorderedMotif< Substance * > >
physical::Perspective< StandardDimension > Filter	filter

physical::Perspective< StandardDimension > *	perspective

Static Public Attributes inherited from bio::chemical::Elementary< LinearMotif< Substance * > >
static bool	hasRegistered

Protected Member Functions inherited from bio::chemical::Atom
virtual bool	BreakBondImplementation (Wave *toDisassociate, AtomicNumber id, BondType type)

virtual bool	FormBondImplementation (Wave *toBond, AtomicNumber id, BondType type)

Protected Member Functions inherited from bio::physical::Observer< Perspective< StandardDimension > >
virtual void	InitializeImplementation (ByteStreams args)

Protected Member Functions inherited from bio::VirtualBase
	VirtualBase ()

virtual	~VirtualBase ()

void	Initialize (ByteStream arg1)

void	Initialize (ByteStream arg1, ByteStream arg2)

void	Initialize (ByteStream arg1, ByteStream arg2, ByteStream arg3)

void	Initialize (ByteStreams args)

virtual void	InitializeImplementation (ByteStreams args)=0

Protected Member Functions inherited from bio::log::Writer
virtual void	InitializeImplementation (ByteStreams args)

void	Log (Level level, const char *format,...) const

Protected Attributes inherited from bio::chemical::Atom
Bonds	m_bonds

Protected Attributes inherited from bio::physical::Class< Atom >
Atom *	m_object

Protected Attributes inherited from bio::physical::Wave
Wave *	m_signal

Symmetry *	m_symmetry

Protected Attributes inherited from bio::physical::Class< T >
T *	m_object

Protected Attributes inherited from bio::VirtualBase
bool	m_hasBeenInitialized

Protected Attributes inherited from bio::physical::Class< Identifiable< StandardDimension > >
Identifiable< StandardDimension > *	m_object

Protected Attributes inherited from bio::physical::Filterable
Filter	m_filter

Protected Attributes inherited from bio::physical::Class< Filterable >
Filterable *	m_object

Protected Attributes inherited from bio::physical::Class< Writer >
Writer *	m_object

Protected Attributes inherited from bio::chemical::AbstractMotif
Container *	m_contents

Detailed Description

Reactants are a multitude of Substances, all combined into a single Wave. NOTE that a Reactant is a Substance, so Reactants may (but do not have to) contain Reactant*s. Reactants is intended to be the single input to a Reaction. In this way, a Reactants represents all the Reacting Substances coming together, making the job of Reaction then to pull them apart into the appropriate Products.

Definition at line 39 of file Reactants.h.

Constructor & Destructor Documentation

◆ Reactants()

bio::chemical::Reactants::Reactants ( Substances & substances )

Parameters

substances

Definition at line 27 of file Reactants.cpp.

    :
    chemical::Class< Reactants >(this)
{
 
}

◆ ~Reactants()

bio::chemical::Reactants::~Reactants ( )

virtual

Definition at line 48 of file Reactants.cpp.

{
 
}

Member Function Documentation

◆ BIO_DISAMBIGUATE_ALL_CLASS_METHODS()

bio::chemical::Reactants::BIO_DISAMBIGUATE_ALL_CLASS_METHODS	(	chemical	,
		Reactants
	)

Ensure virtual methods point to Class implementations.

◆ operator Substances()

bio::chemical::Reactants::operator Substances ( )

Returns: the Substances in *this.

Definition at line 53 of file Reactants.cpp.

{
    return GetAll< Substance* >()->AsVector< Substance* >();
}

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

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

Public Member Functions