#include <Potential.h>

Inheritance diagram for bio::neural::Potential:

[legend]

Collaboration diagram for bio::neural::Potential:

[legend]

Public Member Functions
	BIO_DEFAULT_IDENTIFIABLE_CONSTRUCTORS_WITH_COMMON_CONSTRUCTOR (chemical, Potential, filter::Neural()) virtual ~Potential()

virtual unsigned int	GetPotential () const

virtual void	SetPotential (unsigned int potential)

virtual void	IncrementPotential ()

virtual void	DecrementPotential ()

virtual bool	ShouldReset () const

virtual void	SetReset (bool should)

virtual Pointer< molecular::Protein >	GetResetProtein ()

virtual void	SetResetProtein (Pointer< molecular::Protein > protein)

virtual void	SetEnvironment (Pointer< StemCell > environment)

virtual Code	Reset ()

virtual double	GetPotentialF () const

virtual void	SetPotentialF (double potential)

virtual void	IncrementPotentialF (double delta)

virtual unsigned int	GetInfluences () const

virtual void	SetInfluences (unsigned int influences)

virtual void	IncrementInfluence ()

virtual void	DecrementInfluence ()

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

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

Public Member Functions inherited from bio::chemical::Class< Potential >
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< Potential > object, Filter filter=filter::Default(), SymmetryType symmetryType=symmetry_type::Object())

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

	Class (Pointer< Potential > 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

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)

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

Public Member Functions inherited from bio::chemical::EnvironmentDependent< StemCell >
	EnvironmentDependent (EnvironmentPointer environment=NULL)

virtual	~EnvironmentDependent ()

virtual EnvironmentPointer	GetEnvironment ()

virtual const EnvironmentPointer	GetEnvironment () const

virtual void	SetEnvironment (EnvironmentPointer environment)

Protected Member Functions
void	CommonConstructor ()

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

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)

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

Protected Attributes
double	mValue

unsigned int	mInfluences

bool	mShouldReset

Pointer< molecular::Protein >	mResetProtein

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

Protected Attributes inherited from bio::chemical::EnvironmentDependent< StemCell >
EnvironmentPointer	mEnvironment

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)

Public Types inherited from bio::chemical::EnvironmentDependent< StemCell >
typedef type::RemovePointer< StemCell >::Type	EnvironmentType

typedef Pointer< EnvironmentType >	EnvironmentPointer

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)

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

Potentials expose the mutable state a StemCell uses for a named feature.
Implementations decide how that state is represented: a scalar voltage, an SDR, a hormone-gated value, or another plasmid-provided model.

This class intentionally owns the identity and environment surface. Cells store Pointer< Potential > values in their motifs so plasmids can swap implementations without changing StemCell or Neuron.

Member Function Documentation

◆ BIO_DEFAULT_IDENTIFIABLE_CONSTRUCTORS_WITH_COMMON_CONSTRUCTOR()

bio::neural::Potential::BIO_DEFAULT_IDENTIFIABLE_CONSTRUCTORS_WITH_COMMON_CONSTRUCTOR	(	chemical	,
		Potential	,
		filter::Neural()
	)

Disambiguate all class methods.

◆ CommonConstructor()

void bio::neural::Potential::CommonConstructor ( )

protected

Initializes the storage shared by all constructors: mValue=0.0, mInfluences=0, mShouldReset=false, mResetProtein=NULL.

◆ DecrementInfluence()

void bio::neural::Potential::DecrementInfluence ( )

virtual

Retire one influence driving *this (–mInfluences, floored at 0).

◆ DecrementPotential()

void bio::neural::Potential::DecrementPotential ( )

virtual

Decrement the numeric view of *this.

◆ GetInfluences()

unsigned int bio::neural::Potential::GetInfluences ( ) const

virtual

Influence count. Appended after the graded virtuals to keep the vtable layout ABI-stable. The influence count is INDEPENDENT of the graded value: potentiation/depotentiation drive it (lib/bio Neuron::PotentiateDendrite / DepotentiateDendrite, and plasmid equivalents), and Reset() fires only when the count reaches 0. This mirrors b2b_api's Aspect, whose value and its contributor COUNT are separate (NeuronImpl::CheckForReset).

Returns: the number of active influences currently driving *this.

◆ GetPotential()

unsigned int bio::neural::Potential::GetPotential ( ) const

virtual

Returns: the current numeric view of *this. Non-scalar implementations may derive this from their native representation.

◆ GetPotentialF()

double bio::neural::Potential::GetPotentialF ( ) const

virtual

Graded (real-valued) accessors. Declared last on purpose: appending the new virtuals keeps the polymorphic vtable layout ABI-stable, so existing slot indices (and any plasmid subclass compiled against the prior header) are undisturbed. The concrete base now stores the graded value directly, so callers that opt into sub-unit drive touch these slots; integer-only callers inherit the rounded bridging defaults.

Returns: the graded (real-valued) view of *this. The concrete base stores the graded value natively and returns it; integer-only callers see it rounded through GetPotential().

◆ GetResetProtein()

Pointer< molecular::Protein > bio::neural::Potential::GetResetProtein ( )

virtual

Returns: the Protein that implements *this Reset, when any.

◆ IncrementInfluence()

void bio::neural::Potential::IncrementInfluence ( )

virtual

Register a new influence driving *this (++mInfluences).

◆ IncrementPotential()

void bio::neural::Potential::IncrementPotential ( )

virtual

Increment the numeric view of *this.

◆ IncrementPotentialF()

void bio::neural::Potential::IncrementPotentialF ( double delta )

virtual

Increment the graded view of *this by a (possibly sub-unit) amount.

Parameters

delta the amount to add to the graded value.

◆ Reify()

Code bio::neural::Potential::Reify ( Pointer< const physical::Symmetry > symmetry )

virtual

Required method from Wave. See that class for details.
Reconstructs *this from the given Symmetry: defers to the parent Reify, then restores the persistent scalar via SetPotential().

Parameters

symmetry

Reimplemented from bio::physical::Wave.

◆ Reset()

Code bio::neural::Potential::Reset ( )

virtual

Reset this Potential when its influence count has fallen to 0.
Mirrors the b2b_api Aspect reset: the reset Protein fires only when no influence is currently driving *this (mInfluences == 0), separating the graded value from the reset-gating count.

Returns: Success() if *this was reset.

◆ SetEnvironment()

void bio::neural::Potential::SetEnvironment ( Pointer< StemCell > environment )

virtual

Will RecruitChaperones for & Fold the Protein that implements *this Reset.

Parameters

environment the StemCell* that *this is dependent on.

◆ SetInfluences()

void bio::neural::Potential::SetInfluences ( unsigned int influences )

virtual

Set the number of active influences driving *this.

Parameters

influences the new influence count.

◆ SetPotential()

void bio::neural::Potential::SetPotential ( unsigned int potential )

virtual

Set the numeric view of *this.

Parameters

potential the new potential value.

◆ SetPotentialF()

void bio::neural::Potential::SetPotentialF ( double potential )

virtual

Set the graded (real-valued) view of *this. Integer implementations round to the nearest unsigned value (clamped at 0); graded implementations store the value exactly.

Parameters

potential the new graded potential value.

◆ SetReset()

void bio::neural::Potential::SetReset ( bool should )

virtual

Set whether or not *this should be reset.

Parameters

should whether or not *this should be reset.

◆ SetResetProtein()

void bio::neural::Potential::SetResetProtein ( Pointer< molecular::Protein > protein )

virtual

Set the Protein that implements *this Reset.

Parameters

protein the Protein that implements *this Reset.

◆ ShouldReset()

bool bio::neural::Potential::ShouldReset ( ) const

virtual

Returns: whether or not *this should be reset.

◆ Spin()

Pointer< const physical::Symmetry > bio::neural::Potential::Spin ( ) const

virtual

Required method from Wave. See that class for details.
Records the persistent scalar (GetPotential()) into the Symmetry value before deferring to the parent (chemical::Class / Atom) Spin.

Returns: a Symmetrical image of *this.

Reimplemented from bio::physical::Wave.

Member Data Documentation

◆ mInfluences

unsigned int bio::neural::Potential::mInfluences

protected

The number of active influences driving *this. Independent of mValue; gates Reset().

◆ mResetProtein

Pointer< molecular::Protein > bio::neural::Potential::mResetProtein

protected

The Protein Activated to reset *this.

◆ mShouldReset

bool bio::neural::Potential::mShouldReset

protected

Whether *this is permitted to reset when its influence count hits 0.

◆ mValue

double bio::neural::Potential::mValue

protected

The graded (real-valued) value of *this. The integer Potential API is a rounded, floor-at-zero view onto this double.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ BIO_DEFAULT_IDENTIFIABLE_CONSTRUCTORS_WITH_COMMON_CONSTRUCTOR()

◆ CommonConstructor()

◆ DecrementInfluence()

◆ DecrementPotential()

◆ GetInfluences()

◆ GetPotential()

◆ GetPotentialF()

◆ GetResetProtein()

◆ IncrementInfluence()

◆ IncrementPotential()

◆ IncrementPotentialF()

◆ Reify()

◆ Reset()

◆ SetEnvironment()

◆ SetInfluences()

◆ SetPotential()

◆ SetPotentialF()

◆ SetReset()

◆ SetResetProtein()

◆ ShouldReset()

◆ Spin()

Member Data Documentation

◆ mInfluences

◆ mResetProtein

◆ mShouldReset

◆ mValue