DendriteProtein.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) 2022 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 "CallerDependentProtein.h"
#include "bio/common/wrapper/Pointer.h"
 
namespace bio {
namespace neural {
 
template <class DENDRITE_TYPE, class POSTSYNAPTIC_NEURON_TYPE>
class DendriteProtein:
    public molecular::Class< DendriteProtein< DENDRITE_TYPE, POSTSYNAPTIC_NEURON_TYPE > >,
    virtual public CallerDependentProtein< DENDRITE_TYPE >
{
public:
    
    BIO_DISAMBIGUATE_ALL_CLASS_METHODS(molecular, BIO_SINGLE_ARG(DendriteProtein< DENDRITE_TYPE, POSTSYNAPTIC_NEURON_TYPE >))
 
    BIO_DEFAULT_IDENTIFIABLE_CONSTRUCTORS(
        molecular,
        DendriteProtein,
        filter::Neural()
    )
    
    virtual Code RecruitChaperones(Pointer< molecular::Vesicle > environment)
    {
        return CallerDependentProtein< DENDRITE_TYPE >::RecruitChaperones(environment);
    }
 
    virtual Code Fold()
    {
        Code ret = CallerDependentProtein< DENDRITE_TYPE >::Fold();
        mPostsynapticNeuron = ChemicalCast< Pointer< POSTSYNAPTIC_NEURON_TYPE > >(this->mCaller->GetPostsynapticNeuron());
        BIO_SANITIZE_AT_SAFETY_LEVEL_1(mPostsynapticNeuron, , return code::GeneralFailure())
        return ret;
    }
    
    virtual Pointer< DENDRITE_TYPE > ResolveCaller(Pointer< molecular::Vesicle > context)
    {
        Pointer< DENDRITE_TYPE > caller = CallerDependentProtein< DENDRITE_TYPE >::ResolveCaller(context);
        if (caller)
        {
            mPostsynapticNeuron = ChemicalCast< Pointer< POSTSYNAPTIC_NEURON_TYPE > >(caller->GetPostsynapticNeuron());
        }
        return caller;
    }
 
    Pointer< DENDRITE_TYPE > ResolveDendriteLocal(
        Pointer< molecular::Vesicle > context,
        Pointer< POSTSYNAPTIC_NEURON_TYPE >& postsynapticNeuron) const
    {
        Pointer< DENDRITE_TYPE > caller = CallerDependentProtein< DENDRITE_TYPE >::ResolveCallerLocal(context);
        if (caller)
        {
            postsynapticNeuron = ChemicalCast< Pointer< POSTSYNAPTIC_NEURON_TYPE > >(caller->GetPostsynapticNeuron());
        }
        return caller;
    }
 
protected:
    // Pointer< POSTSYNAPTIC_NEURON_TYPE > rather than a raw pointer: the
    // macro-generated ctors do NOT zero this member, so it was UNINITIALIZED
    // on construction. Pointer< T >'s default ctor NULL-inits on cpp98 AND
    // cpp20 (no NSDMI), is a same-size raw-pointer stand-in, and lets the
    // LEVEL_1 guard above reliably catch an unresolved postsynaptic neuron
    // instead of dereferencing garbage in Activate(NULL).
    Pointer< POSTSYNAPTIC_NEURON_TYPE > mPostsynapticNeuron;
};
 
} // namespace neural
} // namespace bio