Hormone.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) 2023 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 "bio/chemical/solution/Solute.h"
#include "bio/circulatory/common/Class.h"
#include "bio/circulatory/common/Types.h"
#include "bio/circulatory/macro/Macros.h"
#include "bio/circulatory/common/Filters.h"
#include "bio/common/wrapper/Pointer.h"
#include "bio/physical/Time.h"
#include <map>
 
namespace bio {
namespace circulatory {
 
class Hormone :
    public circulatory::Class< Hormone >,
    public chemical::Solute
{
public:
    BIO_DISAMBIGUATE_ALL_CLASS_METHODS(circulatory, Hormone)
 
    
    // _WITH_COMMON_CONSTRUCTOR (not the plain variant): the macro-generated
    // ctors — Hormone(), Hormone(Id), Hormone(Name), the path CortexBrainRuntime
    // builds through — MUST run CommonConstructor() so mValue/mMinValue/mMaxValue
    // are initialised. Without it those floats are raw and Clamp()'s
    // `if (mValue < mMinValue)` reads uninitialised memory (mira valgrind,
    // 2026-06-16). In-class initialisers would be cleaner but are C++11-only and
    // libbio also builds cpp98.
    BIO_DEFAULT_IDENTIFIABLE_CONSTRUCTORS_WITH_COMMON_CONSTRUCTOR(
        circulatory,
        Hormone,
        filter::Circulatory()
    )
 
    
    Hormone(
        Pointer< chemical::Substance > dissolvedSubstance,
        float initialValue = 0.0f
    );
 
    virtual ~Hormone();
 
    virtual float GetValue() const;
 
    virtual void SetValue(float value);
 
    virtual float GetMinValue() const;
 
    virtual void SetMinValue(float minValue);
 
    virtual float GetMaxValue() const;
 
    virtual void SetMaxValue(float maxValue);
 
    virtual bool AddRateChange(const Name& changeName, float ratePerSecond);
 
    virtual bool AddStimulusChange(const Name& changeName, float changeValue);
 
    virtual bool EnableRateChange(const Name& changeName);
 
    virtual bool DisableRateChange(const Name& changeName);
 
    virtual bool ApplyStimulus(const Name& changeName, unsigned int multiplier = 1);
 
    virtual void ApplyRateChanges(Timestamp deltaTimeMs);
 
    virtual Name GetHighestActiveChange() const;
 
    virtual bool IsRateChangeActive(const Name& changeName) const;
 
    virtual std::vector<Name> GetActiveRateChanges() const;
 
protected:
    typedef std::map<Name, float> Changes;
    
    float mValue;
    float mMinValue;
    float mMaxValue;
    
    Changes mRateChanges;        // name -> rate per second
    Changes mActiveRateChanges;  // name -> rate per second (subset of mRateChanges)
    Changes mStimulusChanges;    // name -> immediate change value
 
private:
    void Clamp();
    void CommonConstructor();
};
 
} //circulatory namespace
} //bio namespace