Synapse.h

Go to the documentation of this file.

/*
 * This file is a part of the Biology project by eons LLC. <BR />
 * Biology (aka Develop Biology) is a framework for approaching software <br />
 * development from a natural sciences perspective. <br />
 *
 * Copyright (C) 2022 Séon O'Shannon & eons LLC <BR />
 *
 * This program is free software: you can redistribute it and/or modify <br />
 * it under the terms of the GNU Affero General Public License as <br />
 * published by the Free Software Foundation, either version 3 of the <br />
 * License, or (at your option) any later version. <br />
 *
 * This program is distributed in the hope that it will be useful, <br />
 * but WITHOUT ANY WARRANTY; without even the implied warranty of <br />
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the <br />
 * GNU Affero General Public License for more details. <br />
 *
 * You should have received a copy of the GNU Affero General Public License <br />
 * along with this program.  If not, see <https://www.gnu.org/licenses/>. <br />
 */
 
#pragma once
 
#include "Dendrite.h"
#include "Axon.h"
#include "bio/common/wrapper/Pointer.h"
 
namespace bio {
namespace neural {
 
class Neuron;
 
struct SynapseDetachReport
{
    bool removedFromPresynaptic;
    bool presynapticSlotWasOwning;
    Code presynapticCode;
    bool removedFromPostsynaptic;
    bool postsynapticSlotWasOwning;
    Code postsynapticCode;
 
    SynapseDetachReport();
};
 
class Synapse :
    public neural::Class< Synapse >,
    public Dendrite,
    public Axon
{
public:
    BIO_DISAMBIGUATE_ALL_CLASS_METHODS(neural, Synapse)
 
    BIO_DEFAULT_IDENTIFIABLE_CONSTRUCTORS_WITH_COMMON_CONSTRUCTOR(
        neural,
        Synapse,
        filter::Neural()
    )
 
    void CommonConstructor();
 
    virtual ~Synapse();
 
    virtual Code CacheProteins();
 
    virtual Code CreateDefaultProteins();
 
    virtual void Update(Timestamp whenToPotentiate);
 
    
    Pointer< Synapse > ConfigureFor(
        Pointer< const Neuron > presynapticNeuron,
        Pointer< Neuron > postsynapticNeuron
    ) const;
 
    void ClearPresynapticEndpoint();
 
    void ClearPostsynapticEndpoint();
 
    void ClearAllEndpointsNoDelete();
 
    SynapseDetachReport DetachTopologyNoDelete(
        bool touchPresynaptic,
        bool touchPostsynaptic
    );
 
    SynapseDetachReport DetachTopologyNoDelete();
 
    bool IsTopologyDetached() const;
 
    void DisconnectAndDelete();
 
 
    virtual void AdditionalConfiguration(
        Pointer< const Neuron > presynapticNeuron,
        Pointer< Neuron > postsynapticNeuron
    );
 
    virtual bool ShouldBePotentiated() const;
 
    virtual bool ShouldBeDepotentiated() const;
 
    virtual void ExtendTimeoutUntil(Timestamp timeToDepotentiate);
 
protected:
    Pointer< molecular::Protein > mcAdditionalConfiguration;
};
 
} //neural namespace
} //bio namespace