bio::physical::Filterable Class Reference

#include <Filterable.h>

Inheritance diagram for bio::physical::Filterable:

Collaboration diagram for bio::physical::Filterable:

Public Member Functions
	Filterable (Filter filter)
virtual	~Filterable ()
	BIO_DISAMBIGUATE_ALL_CLASS_METHODS (physical, Filterable) Filterable()
Filter	GetFilter () const
virtual void	InitializeImplementation (ByteStreams args)
virtual Code	Reify (Symmetry *symmetry)
virtual void	SetFilter (Filter filter)
virtual Symmetry *	Spin () const
Public Member Functions inherited from bio::physical::Class< Filterable >
	Class (Filterable *object, Symmetry *symmetry=NULL)
virtual	~Class ()
virtual Wave *	AsWave ()
virtual const Wave *	AsWave () const
virtual Wave *	Clone () const
Filterable *	Convert (Wave *wave)
virtual	operator Filterable * ()
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

Protected Attributes
Filter	m_filter
Protected Attributes inherited from bio::physical::Class< Filterable >
Filterable *	m_object
Protected Attributes inherited from bio::physical::Wave
Wave *	m_signal
Symmetry *	m_symmetry
Protected Attributes inherited from bio::VirtualBase
bool	m_hasBeenInitialized

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 Member Functions inherited from bio::VirtualBase
	VirtualBase ()
virtual	~VirtualBase ()
void	Initialize (ByteStream arg1)
void	Initialize (ByteStream arg1, ByteStream arg2)
void	Initialize (ByteStream arg1, ByteStream arg2, ByteStream arg3)
void	Initialize (ByteStreams args)
virtual void	InitializeImplementation (ByteStreams args)=0

Detailed Description

Filterable objects have a Filter. NOTE: Filterable objects only use a single Filter at a time. See log::Writer for example usage.

Definition at line 38 of file Filterable.h.

Constructor & Destructor Documentation

Filterable()

bio::physical::Filterable::Filterable

(

Filter

filter

)

Parameters

filter

Definition at line 31 of file Filterable.cpp.

    :
    Class(
        this,
        new Symmetry(
            "m_filter",
            symmetry_type::DefineVariable())),
    m_filter(filter::Default())
{
}

~Filterable()

bio::physical::Filterable::~Filterable ( )

virtual

Definition at line 54 of file Filterable.cpp.

{
}

Member Function Documentation

BIO_DISAMBIGUATE_ALL_CLASS_METHODS()

bio::physical::Filterable::BIO_DISAMBIGUATE_ALL_CLASS_METHODS	(	physical	,
		Filterable
	)

Ensure virtual methods point to Class implementations.

GetFilter()

Filter bio::physical::Filterable::GetFilter

(

)

const

Returns

the Filter used by *this.

Definition at line 63 of file Filterable.cpp.

{
    return m_filter;
}

References m_filter.

InitializeImplementation()

void bio::physical::Filterable::InitializeImplementation ( ByteStreams  args )

virtual

VirtualBase required method. See that class for details (in common/)

Parameters

args

Implements bio::VirtualBase.

Reimplemented in bio::log::Writer.

Definition at line 82 of file Filterable.cpp.

{
    BIO_SANITIZE(args.size() == 1 && args[0].Is(m_filter), ,
        return);
    m_filter = args[0];
}

References BIO_SANITIZE, and m_filter.

Reify()

Code bio::physical::Filterable::Reify ( Symmetry *  symmetry )

virtual

Required method from Wave. See that class for details. Reconstruct *this from the given Symmetry.

Parameters

symmetry

Reimplemented from bio::physical::Wave.

Reimplemented in bio::molecular::Molecule, and bio::molecular::Surface.

Definition at line 74 of file Filterable.cpp.

{
    BIO_SANITIZE(symmetry, ,
        return code::BadArgument1());
    m_filter = symmetry->GetValue();
    return code::Success();
}

References bio::code::BadArgument1(), BIO_SANITIZE, bio::physical::Symmetry::GetValue(), m_filter, and bio::code::Success().

SetFilter()

void bio::physical::Filterable::SetFilter ( Filter  filter )

virtual

Set the filter for *this. Overload this to propagate Filter changes to own classes, etc.

Parameters

filter

Definition at line 58 of file Filterable.cpp.

{
    m_filter = filter;
}

References m_filter.

Spin()

Symmetry * bio::physical::Filterable::Spin ( ) const

virtual

Required method from Wave. See that class for details.

Returns

a Symmetrical image of *this

Reimplemented from bio::physical::Wave.

Reimplemented in bio::molecular::Molecule, and bio::molecular::Surface.

Definition at line 68 of file Filterable.cpp.

{
    m_symmetry->AccessValue()->Set(m_filter);
    return Wave::Spin();
}

References bio::physical::Symmetry::AccessValue(), m_filter, bio::physical::Wave::m_symmetry, bio::ByteStream::Set(), and bio::physical::Wave::Spin().

Member Data Documentation

m_filter

Filter bio::physical::Filterable::m_filter

protected

Definition at line 98 of file Filterable.h.

Referenced by GetFilter(), InitializeImplementation(), bio::log::Writer::Log(), Reify(), SetFilter(), and Spin().

---

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

• /home/eons/git/biology/lib_bio/inc/bio/physical/Filterable.h
• /home/eons/git/biology/lib_bio/src/physical/Filterable.cpp