Dendrite.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 "Neurite.h"
#include "bio/common/wrapper/Pointer.h"
 
namespace bio {
namespace neural {
 
class Dendrite:
    public neural::Class< Dendrite >,
    virtual public Neurite
{
public:
 
    BIO_DISAMBIGUATE_ALL_CLASS_METHODS(neural, Dendrite)
 
    BIO_DEFAULT_IDENTIFIABLE_CONSTRUCTORS_WITH_COMMON_CONSTRUCTOR(
        neural,
        Dendrite,
        filter::Neural()
    )
 
    void CommonConstructor();
 
    virtual ~Dendrite();
 
    virtual Code CacheProteins();
 
    virtual Code CreateDefaultProteins();
 
    virtual Timestamp PrepareForPotentiation(Timestamp whenToPotentiate);
 
    virtual void PrepareForDepotentiation();
 
    virtual Code ProcessPotentiation();
 
    virtual Code ProcessDepotentiation();
 
    virtual Code PostPotentiation();
 
    virtual Code PostDepotentiation();
 
    virtual bool ShouldBePotentiated() const;
 
    virtual bool ShouldBeDepotentiated() const;
 
    virtual void ReReady();
 
    virtual Timestamp GetTimeToAdd() const;
 
    Pointer< Neuron > GetPostsynapticNeuron();
 
    Pointer< const Neuron > GetPostsynapticNeuron() const;
 
    Name GetPostsynapticName() const;
 
    Id GetPostsynapticId() const;
 
protected:
    Pointer< Neuron > mPostsynapticNeuron;
 
    Pointer< molecular::Protein > mcPrepareForPotentiation;
    Pointer< molecular::Protein > mcProcessPotentiation;
    Pointer< molecular::Protein > mcPostPotentiation;
 
    Pointer< molecular::Protein > mcPrepareForDepotentiation;
    Pointer< molecular::Protein > mcProcessDepotentiation;
    Pointer< molecular::Protein > mcPostDepotentiation;
 
    Pointer< molecular::Protein > mcReReady;
 
    Timestamp mPotentiateAt;
    Timestamp mLastPotentiated;
 
    Id mPostsynapticNeuronId;
 
 
    virtual void NoLongerReady();
 
public:
 
    virtual void Potentiated();
 
    virtual void Depotentiated();
 
};
 
} // neural namespace
} // bio namespace