Axon.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 Axon:
    public neural::Class< Axon >,
    virtual public Neurite
{
public:
 
    BIO_DISAMBIGUATE_ALL_CLASS_METHODS(neural, Axon)
 
    BIO_DEFAULT_IDENTIFIABLE_CONSTRUCTORS_WITH_COMMON_CONSTRUCTOR(
        neural,
        Axon,
        filter::Neural()
    )
 
    void CommonConstructor();
 
    virtual ~Axon();
 
    virtual Code CacheProteins();
 
    virtual Code CreateDefaultProteins();
 
    virtual Code ProcessOutgoing();
 
    virtual void Update(Timestamp whenToPotentiate);
 
    virtual void Callback(Pointer< const molecular::Molecule > arg);
 
    virtual Timestamp GetTimeLastUpdated() const;
 
    virtual Milliseconds GetTimeout() const;
 
    virtual void SetTimeout(Milliseconds lastFor);
 
    virtual void ExtendTimeoutUntil(Timestamp timeToDepotentiate);
 
    virtual void DepotentiateSignal();
 
    Pointer< const Neuron > GetPresynapticNeuron() const;
 
    Name GetPresynapticName() const;
 
    Id GetPresynapticId() const;
 
protected:
    Pointer< const Neuron > mPresynapticNeuron;
 
    Pointer< molecular::Protein > mcProcessOutgoing;
    Pointer< molecular::Protein > mCallback;
    Pointer< molecular::Protein > mcDepotentiateSignal;
 
    Timestamp mLastUpdated;
 
    Milliseconds mTimeout;
};
 
} // neural namespace
} // bio namespace