#include <Excitation.h>

Inheritance diagram for bio::chemical::ExcitationWithArgument< WAVE, RETURN, ARGUMENT >:

Collaboration diagram for bio::chemical::ExcitationWithArgument< WAVE, RETURN, ARGUMENT >:

Public Member Functions
virtual	~ExcitationWithArgument ()

	BIO_DISAMBIGUATE_ALL_CLASS_METHODS (physical, BIO_SINGLE_ARG(ExcitationWithArgument< WAVE, RETURN, ARGUMENT >)) ExcitationWithArgument(RETURN(WAVE

virtual void	CallDown (physical::Wave wave, ByteStream ret) const

virtual void	EditArg (uint8_t position, ByteStream &newVal)

virtual Properties	GetProperties () const

RETURN	operator() (WAVE *wave) const

Public Member Functions inherited from bio::chemical::ExcitationBase
virtual	~ExcitationBase ()

	BIO_DISAMBIGUATE_ALL_CLASS_METHODS (physical, ExcitationBase) ExcitationBase()

virtual void	CallDown (physical::Wave wave, ByteStream ret) const

virtual void	EditArg (uint8_t position, ByteStream &newVal)

virtual Properties	GetProperties () const

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

virtual	~Class ()

virtual Wave *	AsWave ()

virtual const Wave *	AsWave () const

virtual Wave *	Clone () const

ExcitationBase *	Convert (Wave *wave)

virtual	operator ExcitationBase * ()

virtual	operator Wave * ()

Public Member Functions inherited from bio::physical::Wave
	Wave (Symmetry *symmetry=NULL)

virtual	~Wave ()

virtual chemical::Atom *	AsAtom ()

virtual const chemical::Atom *	AsAtom () const

virtual Wave *	AsWave ()

virtual const Wave *	AsWave () const

virtual Code	Attenuate (const Wave *other)

virtual Wave *	Clone () const

virtual Wave *	Demodulate ()

virtual const Wave *	Demodulate () const

virtual Code	Disattenuate (const Wave *other)

virtual Properties	GetProperties () const

virtual Wave *	Modulate (Wave *signal)

virtual Wave *	operator* ()

virtual const Wave *	operator* () const

virtual Wave *	operator* (Wave *signal)

virtual void	operator+ (const Wave *other)

virtual void	operator- (const Wave *other)

virtual void	operator\| (Symmetry *symmetry)

virtual Code	Reify (Symmetry *symmetry)

virtual Symmetry *	Spin () const

Public Member Functions inherited from bio::physical::Class< ExcitationWithArgument< WAVE, RETURN, ARGUMENT > >
	Class (ExcitationWithArgument< WAVE, RETURN, ARGUMENT > object, Symmetry symmetry=NULL)

virtual	~Class ()

virtual Wave *	AsWave ()

virtual const Wave *	AsWave () const

virtual Wave *	Clone () const

ExcitationWithArgument< WAVE, RETURN, ARGUMENT > *	Convert (Wave *wave)

virtual	operator ExcitationWithArgument< WAVE, RETURN, ARGUMENT > * ()

virtual	operator Wave * ()

Protected Attributes
ARGUMENT	m_arg

RETURN(WAVE::*	m_function )(ARGUMENT)

Protected Attributes inherited from bio::physical::Class< ExcitationBase >
ExcitationBase *	m_object

Protected Attributes inherited from bio::physical::Wave
Wave *	m_signal

Symmetry *	m_symmetry

Protected Attributes inherited from bio::physical::Class< ExcitationWithArgument< WAVE, RETURN, ARGUMENT > >
ExcitationWithArgument< WAVE, RETURN, ARGUMENT > *	m_object

Additional Inherited Members
Static Public Member Functions inherited from bio::chemical::ExcitationBase
static Properties	GetClassProperties ()

Static Public Member Functions inherited from bio::physical::Wave
static Properties	GetResonanceBetween (const Wave *wave, const Properties &properties)

static Properties	GetResonanceBetween (const Wave wave1, const Wave wave2)

static Properties	GetResonanceBetween (ConstWaves waves)

Detailed Description

template<class WAVE, typename RETURN, typename ARGUMENT>
class bio::chemical::ExcitationWithArgument< WAVE, RETURN, ARGUMENT >

See ExcitationBase for docs

Template Parameters

WAVE
RETURN
ARGUMENT

Definition at line 291 of file Excitation.h.

Constructor & Destructor Documentation

◆ ~ExcitationWithArgument()

template<class WAVE , typename RETURN , typename ARGUMENT >

virtual bio::chemical::ExcitationWithArgument< WAVE, RETURN, ARGUMENT >::~ExcitationWithArgument ( )

inlinevirtual

Definition at line 321 of file Excitation.h.

    {
 
    }

Member Function Documentation

◆ BIO_DISAMBIGUATE_ALL_CLASS_METHODS()

template<class WAVE , typename RETURN , typename ARGUMENT >

bio::chemical::ExcitationWithArgument< WAVE, RETURN, ARGUMENT >::BIO_DISAMBIGUATE_ALL_CLASS_METHODS	(	physical	,
		BIO_SINGLE_ARG(ExcitationWithArgument< WAVE, RETURN, ARGUMENT >)
	)

inline

Ensure virtual methods point to Class implementations.

Definition at line 300 of file Excitation.h.

        :
        physical::Class< ExcitationWithArgument< WAVE, RETURN, ARGUMENT > >(this),
        m_function(function),
        m_arg(arg)
    {
    }

◆ CallDown()

template<class WAVE , typename RETURN , typename ARGUMENT >

virtual void bio::chemical::ExcitationWithArgument< WAVE, RETURN, ARGUMENT >::CallDown	(	physical::Wave *	wave,
		ByteStream *	ret
	)		const

inlinevirtual

Override of ExcitationBase; see above.

Reimplemented from bio::chemical::ExcitationBase.

Definition at line 368 of file Excitation.h.

    {
        ret->Set(this->operator()(ForceCast< WAVE* >(wave)));
    }

References bio::ByteStream::Set().

◆ EditArg()

template<class WAVE , typename RETURN , typename ARGUMENT >

virtual void bio::chemical::ExcitationWithArgument< WAVE, RETURN, ARGUMENT >::EditArg	(	uint8_t	position,
		ByteStream &	newVal
	)

inlinevirtual

Creating a new and proper Excitation is preferred to Editing Arguments; however, we support the latter nonetheless.

Parameters

position
newVal

Reimplemented from bio::chemical::ExcitationBase.

Definition at line 346 of file Excitation.h.

    {
        BIO_SANITIZE(position,
            return,);
        m_arg = newVal;
    }

References BIO_SANITIZE, and bio::chemical::ExcitationWithArgument< WAVE, RETURN, ARGUMENT >::m_arg.

◆ GetProperties()

template<class WAVE , typename RETURN , typename ARGUMENT >

virtual Properties bio::chemical::ExcitationWithArgument< WAVE, RETURN, ARGUMENT >::GetProperties ( ) const

inlinevirtual

Override of Wave method. See that class for details. Ensures *this will Resonate with WAVEs by stealing their Properties from the PeriodicTable.

Returns: {whatever Properties WAVE has, property::Excitatory()}

Reimplemented from bio::chemical::ExcitationBase.

Definition at line 331 of file Excitation.h.

    {
        Properties ret = PeriodicTable::Instance().GetPropertiesOf< WAVE >();
        ret.insert(
            ret.end(),
            ExcitationBase::GetClassProperties().begin(),
            ExcitationBase::GetClassProperties().end());
        return ret;
    }

References bio::chemical::ExcitationBase::GetClassProperties(), and bio::Properties.

◆ operator()()

template<class WAVE , typename RETURN , typename ARGUMENT >

RETURN bio::chemical::ExcitationWithArgument< WAVE, RETURN, ARGUMENT >::operator() ( WAVE * wave ) const

inline

Parameters

wave	the caller of m_function.

Returns: RETURN, whatever that is for *this; the result of calling m_function from wave.

Definition at line 360 of file Excitation.h.

    {
        return (wave->*m_function)(m_arg);
    }

References bio::chemical::ExcitationWithArgument< WAVE, RETURN, ARGUMENT >::m_arg, and bio::chemical::ExcitationWithArgument< WAVE, RETURN, ARGUMENT >::m_function.

Member Data Documentation

◆ m_arg

template<class WAVE , typename RETURN , typename ARGUMENT >

ARGUMENT bio::chemical::ExcitationWithArgument< WAVE, RETURN, ARGUMENT >::m_arg

protected

Definition at line 379 of file Excitation.h.

Referenced by bio::chemical::ExcitationWithArgument< WAVE, RETURN, ARGUMENT >::EditArg(), and bio::chemical::ExcitationWithArgument< WAVE, RETURN, ARGUMENT >::operator()().

◆ m_function

template<class WAVE , typename RETURN , typename ARGUMENT >

RETURN(WAVE::* bio::chemical::ExcitationWithArgument< WAVE, RETURN, ARGUMENT >::m_function) (ARGUMENT)

protected

Definition at line 377 of file Excitation.h.

Referenced by bio::chemical::ExcitationWithArgument< WAVE, RETURN, ARGUMENT >::operator()().

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

/home/eons/git/biology/lib_bio/inc/bio/chemical/reaction/Excitation.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~ExcitationWithArgument()

Member Function Documentation

◆ BIO_DISAMBIGUATE_ALL_CLASS_METHODS()

◆ CallDown()

◆ EditArg()

◆ GetProperties()

◆ operator()()

Member Data Documentation

◆ m_arg

◆ m_function