Potential.h

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) 2026 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/>.
 */
 
#pragma once
 
#include <cstddef>
 
#include "bio/chemical/EnvironmentDependent.h"
#include "bio/chemical/common/Class.h"
#include "bio/molecular/Protein.h"
#include "bio/neural/common/Filters.h"
#include "bio/neural/common/Types.h"
#include "bio/neural/macro/Macros.h"
#include "bio/common/wrapper/Pointer.h"
 
namespace bio {
namespace neural {
 
class StemCell;
 
class Potential:
    public chemical::Class< Potential >,
    public chemical::EnvironmentDependent< StemCell >
{
public:
    BIO_DISAMBIGUATE_ALL_CLASS_METHODS(chemical, Potential)
 
    BIO_DEFAULT_IDENTIFIABLE_CONSTRUCTORS_WITH_COMMON_CONSTRUCTOR(chemical,
        Potential,
        filter::Neural())
 
    virtual ~Potential();
 
    virtual unsigned int GetPotential() const;
 
    virtual void SetPotential(unsigned int potential);
 
    virtual void IncrementPotential();
 
    virtual void DecrementPotential();
 
    virtual bool ShouldReset() const;
 
    virtual void SetReset(bool should);
 
    virtual Pointer< molecular::Protein > GetResetProtein();
 
    virtual void SetResetProtein(Pointer< molecular::Protein > protein);
 
    virtual void SetEnvironment(Pointer< StemCell > environment);
 
    virtual Code Reset();
 
    virtual double GetPotentialF() const;
 
    virtual void SetPotentialF(double potential);
 
    virtual void IncrementPotentialF(double delta);
 
    virtual unsigned int GetInfluences() const;
 
    virtual void SetInfluences(unsigned int influences);
 
    virtual void IncrementInfluence();
 
    virtual void DecrementInfluence();
 
    virtual Pointer< const physical::Symmetry > Spin() const;
 
    virtual Code Reify(Pointer< const physical::Symmetry > symmetry);
 
protected:
    void CommonConstructor();
 
    double mValue;
 
    unsigned int mInfluences;
 
    bool mShouldReset;
 
    Pointer< molecular::Protein > mResetProtein;
};
 
} //neural namespace
} //bio namespace