#include <Class.h>

Inheritance diagram for bio::cellular::PeakCarrierWave:

Collaboration diagram for bio::cellular::PeakCarrierWave:

Public Member Functions
	PeakCarrierWave ()

virtual	~PeakCarrierWave ()

virtual Properties	GetProperties () const

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

Protected Member Functions
	BIO_EXCITATION_CLASS (physical::Periodic, Code) m_peakExcitation

Additional Inherited Members
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)

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

Symmetry *	m_symmetry

Detailed Description

The PeakCarrierWave will propagate Peak Excitations to all LinearMotifs

Definition at line 34 of file Class.h.

Constructor & Destructor Documentation

◆ PeakCarrierWave()

bio::cellular::PeakCarrierWave::PeakCarrierWave ( )

inline

Definition at line 38 of file Class.h.

        :
        m_peakExcitation(&physical::Periodic::Peak)
    {
        Modulate(m_peakExcitation);
    }

References bio::physical::Wave::Modulate().

◆ ~PeakCarrierWave()

virtual bio::cellular::PeakCarrierWave::~PeakCarrierWave ( )

inlinevirtual

Definition at line 45 of file Class.h.

46 {

47 }

Member Function Documentation

◆ BIO_EXCITATION_CLASS()

bio::cellular::PeakCarrierWave::BIO_EXCITATION_CLASS	(	physical::Periodic	,
		Code
	)

protected

◆ GetProperties()

virtual Properties bio::cellular::PeakCarrierWave::GetProperties ( ) const

inlinevirtual

Waves, depending on their behavior, can have different Properties. GetProperties can be used for determining how to downcast *this. The Properties returned dictate what a Wave can do and / or what can be done with one. If we treat Properties as fourier components of a waveform, we could restate GetProperties as GetPeriodicComponents. In this context, "what a wave can do" and "what can be done with a wave" can be expressed as "which systems resonate with the wave in question" or "which systems have comparable periodic components", which is true here as well: when 2 Waves have the same Properties (i.e. Resonate with each other) they can be treated the same in some regard (perhaps they are "numeric" and can be "added") and when 2 waves have comparable properties, they can interact with each other. It is up to you and other users of this framework to determine which Properties to use where. This is your space, so make use of it when you feel it's appropriate. NOTE: Waves do not actually have m_properties. This method MUST be implemented by children in order to work. If using any chemical::Class or beyond, this method will be implemented for you. See chemical/Class.h for more info.

Returns: the Properties of *this (empty vector unless overridden).

Reimplemented from bio::physical::Wave.

Definition at line 49 of file Class.h.

    {
        Properties ret = chemical::AbstractMotif::GetClassProperties();
        ret.push_back(property::Linear());
        return ret;
    }

References bio::chemical::AbstractMotif::GetClassProperties(), bio::property::Linear(), and bio::Properties.

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

/home/eons/git/biology/lib_bio/inc/bio/cellular/common/Class.h

Public Member Functions

Protected Member Functions