#include <Impulse.h>

Inheritance diagram for bio::neural::Impulse:

[legend]

Collaboration diagram for bio::neural::Impulse:

[legend]

Public Member Functions
	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 ()

Public Member Functions inherited from bio::chemical::Class< Impulse >
virtual Pointer< ::bio::physical::Wave >	Clone () const

Pointer< ::bio::physical::Wave >	AsWave ()

Pointer< const ::bio::physical::Wave >	AsWave () const

	operator Pointer< ::bio::physical::Wave > ()

virtual Pointer< ::bio::physical::Wave >	Modulate (Pointer< ::bio::physical::Wave > signal)

virtual Pointer< ::bio::physical::Wave >	Demodulate ()

virtual Pointer< const ::bio::physical::Wave >	Demodulate () const

virtual Pointer< ::bio::physical::Wave >	Superpose (const ::bio::physical::ConstWaves &displacement, Pointer< ::bio::physical::Interference > pattern)

virtual bool	Superpose (Pointer< const ::bio::physical::Wave > displacement, Pointer< ::bio::physical::Interference > pattern)

	Class (Pointer< Impulse > object, Filter filter=filter::Default(), SymmetryType symmetryType=symmetry_type::Object())

	Class (Pointer< Impulse > object, const Name &name, Filter filter=filter::Default(), SymmetryType symmetryType=symmetry_type::Object())

	Class (Pointer< Impulse > object, const Id &id, Filter filter=filter::Default(), SymmetryType symmetryType=symmetry_type::Object())

	Class (const Class &other)

virtual	~Class ()

virtual bool	RegisterProperties (const Properties &properties)

virtual Properties	GetProperties () const

virtual Pointer< Atom >	AsAtom ()

virtual Pointer< const Atom >	AsAtom () const

virtual Code	Attenuate (Pointer< const physical::Wave > other)

virtual Code	Disattenuate (Pointer< const physical::Wave > other)

Public Member Functions inherited from bio::physical::Class< T >
	Class (Pointer< T > object, Pointer< Symmetry > symmetry=NULL)

	Class (Pointer< T > object, SymmetryFactory symmetryFactory)

	Class (const Class &other)

virtual Pointer< T >	GetWaveObject ()

virtual Pointer< const T >	GetWaveObject () const

virtual	operator T& ()

virtual	operator const T & () const

Pointer< Wave >	AsWave ()

Pointer< const Wave >	AsWave () const

virtual	operator Pointer< Wave > ()

Public Member Functions inherited from bio::physical::Wave
	Wave (Pointer< Symmetry > symmetry=NULL)

	Wave (const Wave &other)

Wave &	operator= (const Wave &other)

virtual	~Wave ()

Pointer< const Symmetry >	GetSymmetry () const

virtual bool	Superpose (Pointer< const Wave > displacement, Pointer< Interference > pattern)

virtual Pointer< Wave >	Superpose (const ConstWaves &displacement, Pointer< Interference > pattern)

virtual Pointer< Wave >	Modulate (Pointer< Wave > signal)

Pointer< Wave >	AsWave ()

Pointer< const Wave >	AsWave () const

virtual void	operator\| (Pointer< Symmetry > symmetry)

virtual Pointer< Wave >	operator* (Pointer< Wave > signal)

virtual Pointer< Wave >	operator* ()

virtual Pointer< const Wave >	operator* () const

virtual void	operator+ (Pointer< const Wave > other)

virtual void	operator- (Pointer< const Wave > other)

uint16_t	GetTypeId () const

void	SetTypeId (uint16_t typeId)

Public Member Functions inherited from bio::physical::Identifiable< Id >
	Identifiable (Pointer< Perspective< Id > > perspective=NULL)

	Identifiable (const Name &name, Pointer< Perspective< Id > > perspective=NULL)

	Identifiable (Identifier id, Pointer< Perspective< Id > > perspective=NULL)

	Identifiable (const Identifiable &other)

virtual	~Identifiable ()

virtual	operator Id () const

virtual bool	operator== (const Identifier id) const

virtual bool	operator== (const Name &name) const

virtual bool	operator== (const Identifiable< Id > &other) const

virtual Name	GetName () const

virtual Identifier	GetId () const

virtual bool	SetName (const Name &name)

virtual bool	SetId (Identifier id)

virtual bool	IsName (const Name &name) const

virtual bool	IsNameInsensitive (const Name &name) const

virtual bool	IsId (Identifier id) const

virtual void	SetPerspective (Pointer< Perspective< Id > > perspective)

Public Member Functions inherited from bio::physical::Observer< PERSPECTIVE >
	Observer (Pointer< Perspective > perspective=NULL)

	Observer (const Observer &other)

virtual	~Observer ()

virtual void	SetPerspective (Pointer< Perspective > perspective)

virtual Pointer< Perspective >	GetPerspective () const

Public Member Functions inherited from bio::log::Writer
	Writer ()

	Writer (Filter logFilter)

virtual	~Writer ()

virtual Pointer< const Writer >	AsLogWriter () const

bool	IsEnabled (LogLevel level) const

virtual void	Log (LogLevel level, const char *format, va_list args) const

Public Member Functions inherited from bio::physical::Class< Writer >
	Class (Pointer< Writer > object, Pointer< Symmetry > symmetry=NULL)

	Class (Pointer< Writer > object, SymmetryFactory symmetryFactory)

	Class (const Class &other)

virtual Pointer< Writer >	GetWaveObject ()

virtual Pointer< const Writer >	GetWaveObject () const

virtual	operator Writer & ()

virtual	operator const Writer & () const

Pointer< Wave >	AsWave ()

Pointer< const Wave >	AsWave () const

virtual	operator Pointer< Wave > ()

Public Member Functions inherited from bio::physical::Filterable
	Filterable ()

	Filterable (Filter filter)

virtual	~Filterable ()

virtual void	InitializeImplementation (ByteStreams &args)

virtual void	SetFilter (Filter filter)

Filter	GetFilter () const

virtual Pointer< const Symmetry >	Spin () const

virtual Code	Reify (Pointer< const Symmetry > symmetry)

Public Member Functions inherited from bio::physical::Class< Filterable >
	Class (Pointer< Filterable > object, Pointer< Symmetry > symmetry=NULL)

	Class (Pointer< Filterable > object, SymmetryFactory symmetryFactory)

	Class (const Class &other)

virtual Pointer< Filterable >	GetWaveObject ()

virtual Pointer< const Filterable >	GetWaveObject () const

virtual	operator Filterable & ()

virtual	operator const Filterable & () const

Pointer< Wave >	AsWave ()

Pointer< const Wave >	AsWave () const

virtual	operator Pointer< Wave > ()

Public Member Functions inherited from bio::chemical::Atom
	Atom ()

	Atom (const Atom &other)

virtual	~Atom ()

void	CloneBondsFrom (const Atom &other, BondClonePolicy policy=&Atom::DefaultBondClonePolicy)

virtual Pointer< const physical::Symmetry >	Spin () const

virtual Code	Reify (Pointer< const physical::Symmetry > symmetry)

Pointer< physical::Wave >	GetBonded (Valence position)

Pointer< const physical::Wave >	GetBonded (Valence position) const

Pointer< const physical::Wave >	ResolveBondedForReadById (AtomicNumber bondId) const

Pointer< physical::Wave >	ResolveBondedForWriteById (AtomicNumber bondId)

template<typename T >
Cow< T >	AsBonded () const

template<typename T >
Pointer< T >	AsBondedQuantum () const

template<typename T >
atom_detail::AsResultType< T, type::IsWaveImplementation< typenametype::RemovePointer< T >::Type >::sValue >::Type	As () const

template<typename T >
	operator T () const

template<typename T >
Valence	FormBond (T toBond, BondType type=bond_type::Unknown())

template<typename T >
bool	BreakBond (T toDisassociate, BondType type=bond_type::Unknown())

Valence	GetBondPosition (AtomicNumber bondedId) const

Valence	GetBondPosition (const Name &typeName) const

Valence	GetBondPositionLocked (AtomicNumber bondedId) const

template<typename T >
Valence	GetBondPosition () const

BondType	GetBondType (Valence position) const

template<typename T >
BondType	GetBondType () const

Pointer< Bonds >	GetAllBonds ()

Pointer< const Bonds >	GetAllBonds () const

void	ForEachBond (BondVisitor visitor, void *context=NULL) const

void	ForEachBondMutable (BondMutator mutator, void *context=NULL)

virtual Valence	FormBondImplementation (Pointer< physical::Wave > toBond, AtomicNumber id, BondType type)

Valence	FormBondImplementation (Pointer< physical::Wave > toBond, AtomicNumber id, BondType type, bool ownsBonded)

Valence	FormBondImplementationLocked (Pointer< physical::Wave > toBond, AtomicNumber id, BondType type, bool ownsBonded)

virtual bool	BreakBondImplementation (AtomicNumber id, BondType type)

bool	BreakBondImplementationLocked (AtomicNumber id, BondType type)

Public Member Functions inherited from bio::physical::Class< Atom >
	Class (Pointer< Atom > object, Pointer< Symmetry > symmetry=NULL)

	Class (Pointer< Atom > object, SymmetryFactory symmetryFactory)

	Class (const Class &other)

virtual Pointer< Atom >	GetWaveObject ()

virtual Pointer< const Atom >	GetWaveObject () const

virtual	operator Atom & ()

virtual	operator const Atom & () const

Pointer< Wave >	AsWave ()

Pointer< const Wave >	AsWave () const

virtual	operator Pointer< Wave > ()

Public Member Functions inherited from bio::ThreadSafe
	ThreadSafe ()

	ThreadSafe (const ThreadSafe &toCopy)

ThreadSafe &	operator= (const ThreadSafe &toCopy)

	~ThreadSafe ()

void	LockThread () const

void	UnlockThread () const

void	LockMutexShared () const

void	UnlockMutexShared () const

Protected Attributes
FiringCondition	mTrigger

Pointer< molecular::Protein >	mImpulse

Pointer< Neuron >	mCaller

bool	mShouldBeActive

Protected Attributes inherited from bio::physical::Class< T >
Pointer< T >	mObject

Protected Attributes inherited from bio::physical::Wave
LazyPointer< Symmetry >	mSymmetry

bool	mHasSignal

uint16_t	mTypeId

Protected Attributes inherited from bio::VirtualBase
bool	mHasBeenInitialized

Protected Attributes inherited from bio::physical::Class< Writer >
Pointer< Writer >	mObject

Protected Attributes inherited from bio::physical::Filterable
Filter	mFilter

Protected Attributes inherited from bio::physical::Class< Filterable >
Pointer< Filterable >	mObject

Protected Attributes inherited from bio::chemical::Atom
Bonds	mBonds

::std::map< AtomicNumber, Valence >	mBondIndex

Arrangement< Pointer< const physical::Wave > >	mBackflowPreventer

Protected Attributes inherited from bio::physical::Class< Atom >
Pointer< Atom >	mObject

Additional Inherited Members
Public Types inherited from bio::physical::Identifiable< Id >
typedef Id	Identifier

typedef Arrangement< Identifier >	Ids

Public Types inherited from bio::physical::Observer< PERSPECTIVE >
typedef PERSPECTIVE	Perspective

Public Types inherited from bio::chemical::Atom
typedef BondCloneAction(*	BondClonePolicy) (const Bond &bond)

typedef void(*	BondVisitor) (const Bond &bond, void *context)

typedef BondCloneAction(*	BondMutator) (Bond &bond, void *context)

Static Public Member Functions inherited from bio::physical::Class< T >
static Pointer< T >	Convert (Pointer< Wave > wave)

Static Public Member Functions inherited from bio::physical::Wave
static Properties	GetResonanceBetween (ConstWaves waves)

static Properties	GetResonanceBetween (Pointer< const Wave > wave1, Pointer< const Wave > wave2)

static Properties	GetResonanceBetween (Pointer< const Wave > wave, const Properties &properties)

Static Public Member Functions inherited from bio::log::Writer
static void	Log (Pointer< const Writer > writer, LogLevel level, const char *format,...)

static bool	ShouldLog (Pointer< const Writer > writer, LogLevel level)

Static Public Member Functions inherited from bio::physical::Class< Writer >
static Pointer< Writer >	Convert (Pointer< Wave > wave)

Static Public Member Functions inherited from bio::physical::Class< Filterable >
static Pointer< Filterable >	Convert (Pointer< Wave > wave)

Static Public Member Functions inherited from bio::chemical::Atom
static BondCloneAction	DefaultBondClonePolicy (const Bond &bond)

template<typename T >
static AtomicNumber	GetBondId ()

Static Public Member Functions inherited from bio::physical::Class< Atom >
static Pointer< Atom >	Convert (Pointer< Wave > wave)

Protected Types inherited from bio::physical::Identifiable< Id >
typedef Id	Identifier

typedef Arrangement< Identifier >	Ids

Protected Types inherited from bio::physical::Observer< PERSPECTIVE >
typedef PERSPECTIVE	Perspective

Protected Types inherited from bio::chemical::Atom
typedef BondCloneAction(*	BondClonePolicy) (const Bond &bond)

typedef void(*	BondVisitor) (const Bond &bond, void *context)

typedef BondCloneAction(*	BondMutator) (Bond &bond, void *context)

Protected Member Functions inherited from bio::chemical::Elementary< T >
void	RegisterType ()

	Elementary (const Properties properties)

	Elementary ()

virtual	~Elementary ()

Protected Member Functions inherited from bio::physical::Identifiable< Id >
virtual void	InitializeImplementation (ByteStreams &args)

friend::std::ostream &	operator<< (std::ostream &out, const Identifiable< Id > &t)

	Identifiable (Pointer< Perspective< Id > > perspective=NULL)

	Identifiable (const Name &name, Pointer< Perspective< Id > > perspective=NULL)

	Identifiable (Identifier id, Pointer< Perspective< Id > > perspective=NULL)

	Identifiable (const Identifiable &other)

virtual	~Identifiable ()

virtual	operator Id () const

virtual bool	operator== (const Identifier id) const

virtual bool	operator== (const Name &name) const

virtual bool	operator== (const Identifiable< Id > &other) const

virtual Name	GetName () const

virtual Identifier	GetId () const

virtual bool	SetName (const Name &name)

virtual bool	SetId (Identifier id)

virtual bool	IsName (const Name &name) const

virtual bool	IsNameInsensitive (const Name &name) const

virtual bool	IsId (Identifier id) const

virtual void	SetPerspective (Pointer< Perspective< Id > > perspective)

Protected Member Functions inherited from bio::physical::Observer< PERSPECTIVE >
	Observer (Pointer< Perspective > perspective=NULL)

	Observer (const Observer &other)

virtual	~Observer ()

virtual void	SetPerspective (Pointer< Perspective > perspective)

virtual Pointer< Perspective >	GetPerspective () const

Protected Member Functions inherited from bio::VirtualBase
	VirtualBase ()

virtual	~VirtualBase ()

void	Initialize (ByteStreams &args)

void	Initialize (ByteStream arg1)

void	Initialize (ByteStream arg1, ByteStream arg2)

void	Initialize (ByteStream arg1, ByteStream arg2, ByteStream arg3)

Protected Member Functions inherited from bio::log::Writer
	Writer ()

	Writer (Filter logFilter)

virtual	~Writer ()

virtual Pointer< const Writer >	AsLogWriter () const

bool	IsEnabled (LogLevel level) const

virtual void	Log (LogLevel level, const char *format, va_list args) const

Protected Member Functions inherited from bio::physical::Class< Writer >
	Class (Pointer< Writer > object, Pointer< Symmetry > symmetry=NULL)

	Class (Pointer< Writer > object, SymmetryFactory symmetryFactory)

	Class (const Class &other)

virtual Pointer< Writer >	GetWaveObject ()

virtual Pointer< const Writer >	GetWaveObject () const

virtual	operator Writer & ()

virtual	operator const Writer & () const

Pointer< Wave >	AsWave ()

Pointer< const Wave >	AsWave () const

virtual	operator Pointer< Wave > ()

Protected Member Functions inherited from bio::physical::Filterable
	Filterable ()

	Filterable (Filter filter)

virtual	~Filterable ()

virtual void	InitializeImplementation (ByteStreams &args)

virtual void	SetFilter (Filter filter)

Filter	GetFilter () const

virtual Pointer< const Symmetry >	Spin () const

virtual Code	Reify (Pointer< const Symmetry > symmetry)

Protected Member Functions inherited from bio::physical::Class< Filterable >
	Class (Pointer< Filterable > object, Pointer< Symmetry > symmetry=NULL)

	Class (Pointer< Filterable > object, SymmetryFactory symmetryFactory)

	Class (const Class &other)

virtual Pointer< Filterable >	GetWaveObject ()

virtual Pointer< const Filterable >	GetWaveObject () const

virtual	operator Filterable & ()

virtual	operator const Filterable & () const

Pointer< Wave >	AsWave ()

Pointer< const Wave >	AsWave () const

virtual	operator Pointer< Wave > ()

Protected Member Functions inherited from bio::chemical::Atom
void	IndexBond (AtomicNumber bondedId, Valence position)

void	UnindexBond (AtomicNumber bondedId)

	Atom ()

	Atom (const Atom &other)

virtual	~Atom ()

void	CloneBondsFrom (const Atom &other, BondClonePolicy policy=&Atom::DefaultBondClonePolicy)

virtual Pointer< const physical::Symmetry >	Spin () const

virtual Code	Reify (Pointer< const physical::Symmetry > symmetry)

Pointer< physical::Wave >	GetBonded (Valence position)

Pointer< const physical::Wave >	GetBonded (Valence position) const

Pointer< const physical::Wave >	ResolveBondedForReadById (AtomicNumber bondId) const

Pointer< physical::Wave >	ResolveBondedForWriteById (AtomicNumber bondId)

template<typename T >
Cow< T >	AsBonded () const

template<typename T >
Pointer< T >	AsBondedQuantum () const

template<typename T >
atom_detail::AsResultType< T, type::IsWaveImplementation< typenametype::RemovePointer< T >::Type >::sValue >::Type	As () const

template<typename T >
	operator T () const

template<typename T >
Valence	FormBond (T toBond, BondType type=bond_type::Unknown())

template<typename T >
bool	BreakBond (T toDisassociate, BondType type=bond_type::Unknown())

Valence	GetBondPosition (AtomicNumber bondedId) const

Valence	GetBondPosition (const Name &typeName) const

Valence	GetBondPositionLocked (AtomicNumber bondedId) const

template<typename T >
Valence	GetBondPosition () const

BondType	GetBondType (Valence position) const

template<typename T >
BondType	GetBondType () const

Pointer< Bonds >	GetAllBonds ()

Pointer< const Bonds >	GetAllBonds () const

void	ForEachBond (BondVisitor visitor, void *context=NULL) const

void	ForEachBondMutable (BondMutator mutator, void *context=NULL)

virtual Valence	FormBondImplementation (Pointer< physical::Wave > toBond, AtomicNumber id, BondType type)

Valence	FormBondImplementation (Pointer< physical::Wave > toBond, AtomicNumber id, BondType type, bool ownsBonded)

Valence	FormBondImplementationLocked (Pointer< physical::Wave > toBond, AtomicNumber id, BondType type, bool ownsBonded)

virtual bool	BreakBondImplementation (AtomicNumber id, BondType type)

bool	BreakBondImplementationLocked (AtomicNumber id, BondType type)

Protected Member Functions inherited from bio::physical::Class< Atom >
	Class (Pointer< Atom > object, Pointer< Symmetry > symmetry=NULL)

	Class (Pointer< Atom > object, SymmetryFactory symmetryFactory)

	Class (const Class &other)

virtual Pointer< Atom >	GetWaveObject ()

virtual Pointer< const Atom >	GetWaveObject () const

virtual	operator Atom & ()

virtual	operator const Atom & () const

Pointer< Wave >	AsWave ()

Pointer< const Wave >	AsWave () const

virtual	operator Pointer< Wave > ()

Protected Member Functions inherited from bio::ThreadSafe
	ThreadSafe ()

	ThreadSafe (const ThreadSafe &toCopy)

ThreadSafe &	operator= (const ThreadSafe &toCopy)

	~ThreadSafe ()

void	LockThread () const

void	UnlockThread () const

void	LockMutexShared () const

void	UnlockMutexShared () const

Static Protected Member Functions inherited from bio::log::Writer
static void	Log (Pointer< const Writer > writer, LogLevel level, const char *format,...)

static bool	ShouldLog (Pointer< const Writer > writer, LogLevel level)

Static Protected Member Functions inherited from bio::physical::Class< Writer >
static Pointer< Writer >	Convert (Pointer< Wave > wave)

Static Protected Member Functions inherited from bio::physical::Class< Filterable >
static Pointer< Filterable >	Convert (Pointer< Wave > wave)

Static Protected Member Functions inherited from bio::chemical::Atom
static BondCloneAction	DefaultBondClonePolicy (const Bond &bond)

template<typename T >
static AtomicNumber	GetBondId ()

Static Protected Member Functions inherited from bio::physical::Class< Atom >
static Pointer< Atom >	Convert (Pointer< Wave > wave)

Detailed Description

Firing Condition Impulses are simple function pointer wrappers that allow different functions to be called upon different triggers.
firing_condition::Impulses can be enabled/disabled for ease of use.
firing_condition::Impulses should specify the RETURN value for their caller, DetermineAndCallImpulseTriggers(), via the bool shouldBeActive.
Impulses use Name instead of Id as they need to be created before Proteins can be added to them.

Constructor & Destructor Documentation

◆ Impulse()

bio::neural::Impulse::Impulse	(	FiringCondition	trigger = `firing_condition::None()`,
		Name	impulseName = `""`,
		Pointer< Neuron >	caller = `NULL`,
		bool	shouldBeActive = `true`
	)

Disambiguate all class methods.

Parameters

trigger
impulseName
caller
shouldBeActive

◆ ~Impulse()

bio::neural::Impulse::~Impulse ( )

virtual

Member Function Documentation

◆ GetImpulseProtein()

Pointer< molecular::Protein > bio::neural::Impulse::GetImpulseProtein ( )

Returns: the Protein that implements *this Impulse

◆ GetTrigger()

FiringCondition bio::neural::Impulse::GetTrigger ( ) const

Returns: the FiringCondition that triggers *this Impulse

◆ Send()

bool bio::neural::Impulse::Send ( )

Returns: whether or not the caller should be active.

◆ SetCaller()

void bio::neural::Impulse::SetCaller ( Pointer< Neuron > caller )

Parameters

caller the Neuron that triggered *this Impulse.

Member Data Documentation

◆ mCaller

Pointer< Neuron > bio::neural::Impulse::mCaller

protected

◆ mImpulse

Pointer< molecular::Protein > bio::neural::Impulse::mImpulse

protected

◆ mShouldBeActive

bool bio::neural::Impulse::mShouldBeActive

protected

◆ mTrigger

FiringCondition bio::neural::Impulse::mTrigger

protected

The documentation for this class was generated from the following files:

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Impulse()

◆ ~Impulse()

Member Function Documentation

◆ GetImpulseProtein()

◆ GetTrigger()

◆ Send()

◆ SetCaller()

Member Data Documentation

◆ mCaller

◆ mImpulse

◆ mShouldBeActive

◆ mTrigger