CallerDependentProtein.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 "bio/neural/common/Filters.h"
#include "bio/molecular/Protein.h"
#include "bio/common/wrapper/Pointer.h"
 
namespace bio {
namespace neural {
 
template < class CALLER >
class CallerDependentProtein :
    public molecular::Class< CallerDependentProtein< CALLER > >,
    public molecular::Protein
{
public:
 
    BIO_DISAMBIGUATE_ALL_CLASS_METHODS(molecular, CallerDependentProtein< CALLER >)
 
    BIO_DEFAULT_IDENTIFIABLE_CONSTRUCTORS(
        molecular,
        CallerDependentProtein,
        filter::Neural()
    )
    
    virtual Code RecruitChaperones(Pointer< molecular::Vesicle > environment)
    {
        BIO_SANITIZE(environment, , return code::GeneralFailure())
            mCaller = ChemicalCast< Pointer< CALLER > >(environment);
        BIO_SANITIZE_AT_SAFETY_LEVEL_1(mCaller, , return code::GeneralFailure())
        
        return molecular::Protein::RecruitChaperones(environment);
    }
 
    virtual Code Fold()
    {
        return molecular::Protein::Fold();
    }
    
protected:
 
    virtual Pointer< CALLER > ResolveCaller(Pointer< molecular::Vesicle > context)
    {
        if (context)
        {
            Pointer< CALLER > perCall = ChemicalCast< Pointer< CALLER > >(context);
            if (perCall)
            {
                mCaller = perCall;
            }
        }
        return mCaller;
    }
 
    Pointer< CALLER > ResolveCallerLocal(Pointer< molecular::Vesicle > context) const
    {
        if (context)
        {
            Pointer< CALLER > perCall = ChemicalCast< Pointer< CALLER > >(context);
            if (perCall)
            {
                return perCall;
            }
        }
        return mCaller;
    }
 
    // Pointer< CALLER > rather than a raw CALLER*: BIO_DEFAULT_IDENTIFIABLE_-
    // CONSTRUCTORS does NOT zero this member, so a raw pointer was left
    // UNINITIALIZED on construction. Pointer< T >'s default ctor NULL-inits
    // (cpp98 AND cpp20, no NSDMI needed) and is a same-size, behavior-identical
    // raw-pointer stand-in, so the LEVEL_1 guard above reliably catches an
    // unresolved caller instead of dereferencing garbage in Activate(NULL).
    Pointer< CALLER > mCaller;
};
 
} // namespace neural
} // namespace bio