Reaction.cpp

Go to the documentation of this file.

/*
 * This file is a part of the Biology project by eons LLC.
 * Biology (aka Develop Biology) is a framework for approaching software
 * development from a natural sciences perspective.
 *
 * Copyright (C) 2021 Séon O'Shannon & eons LLC
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#include "bio/chemical/reaction/Reaction.h"
#include "bio/chemical/reaction/Reactant.h"
#include "bio/chemical/common/Codes.h"
#include "bio/chemical/common/Filters.h"
 
namespace bio {
namespace chemical {
 
Reaction::Reaction(
    Name name,
    const Reactants* reactants
)
    :
    chemical::Class< Reaction >(
        this,
        name,
        &ReactionPerspective::Instance(),
        filter::Chemical(),
        symmetry_type::Operation()),
    m_requiredReactants(*reactants)
{
}
 
void Reaction::Require(Reactant* reactant)
{
    m_requiredReactants.Add< Substance* >(reactant);
}
 
void Reaction::Require(
    Name typeName,
    const Substance* substance
)
{
    Require(
        new Reactant(
            typeName,
            substance
        ));
}
 
void Reaction::Require(
    Name typeName,
    const UnorderedMotif< Property >::Contents* properties,
    const UnorderedMotif< State >::Contents* states
)
{
    Require(
        new Reactant(
            typeName,
            properties,
            states
        ));
}
 
 
bool Reaction::ReactantsMeetRequirements(const Reactants* toCheck) const
{
    return toCheck->HasAll< Substance* >(m_requiredReactants.GetAll< Substance* >());
}
 
/*static*/ const Reaction* Reaction::Initiate(StandardDimension id)
{
    BIO_SANITIZE_WITH_CACHE(ReactionPerspective::Instance().GetTypeFromIdAs< Reaction* >(id),
        return *(Cast< const Reaction** >(RESULT)),
        return NULL);
}
 
Products Reaction::operator()(Reactants* reactants) const
{
    //Always level 2, even if the user wants more (i.e. never less).
    BIO_SANITIZE_AT_SAFETY_LEVEL_2(ReactantsMeetRequirements(reactants),
        return Process(reactants),
        return code::FailedReaction());
}
 
} //chemical namespace
} //bio namespace