Impulse.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 "bio/neural/common/Types.h"
#include "bio/neural/common/FiringConditions.h"
#include "bio/neural/macro/Macros.h"
#include "bio/molecular/Protein.h"
#include "bio/chemical/common/Class.h"
#include "bio/common/wrapper/Pointer.h"
 
namespace bio {
namespace neural {
 
class Impulse:
    public chemical::Class< Impulse >
{
public:
 
    BIO_DISAMBIGUATE_ALL_CLASS_METHODS(chemical, Impulse)
 
    
    Impulse(
        FiringCondition trigger = firing_condition::None(),
        Name impulseName = "",
        Pointer< Neuron > caller = NULL,
        bool shouldBeActive = true
    );
 
    virtual ~Impulse();
 
    FiringCondition GetTrigger() const;
 
    Pointer< molecular::Protein > GetImpulseProtein();
 
    void SetCaller(Pointer< Neuron > caller);
 
    bool Send();
 
protected:
    FiringCondition mTrigger;
    Pointer< molecular::Protein > mImpulse;
    Pointer< Neuron > mCaller;
    bool mShouldBeActive;
};
 
typedef Arrangement< Impulse > Impulses;
 
} //neural namespace
} //bio namespace