#include <ThreadedPeriodic.h>

Inheritance diagram for bio::physical::ThreadedPeriodic:

Collaboration diagram for bio::physical::ThreadedPeriodic:

Public Member Functions
virtual	~ThreadedPeriodic ()

	BIO_DISAMBIGUATE_ALL_CLASS_METHODS (physical, ThreadedPeriodic) ThreadedPeriodic(TimeUS interval

virtual bool	Work ()

Public Member Functions inherited from bio::physical::Periodic
	Periodic (TimeUS interval=GetDefaultInterval())

virtual	~Periodic ()

	BIO_DISAMBIGUATE_ALL_CLASS_METHODS (physical, Periodic) static TimeUS GetDefaultInterval()

virtual void	CheckIn ()

TimeUS	GetInterval () const

float	GetIntervalInSeconds () const

virtual Properties	GetProperties () const

Timestamp	GetTimeLastPeaked () const

virtual void	InitializeImplementation (ByteStreams args)

virtual Code	Peak ()

virtual Code	Reify (Symmetry *symmetry)

virtual void	SetInterval (TimeUS interval)

virtual void	SetLastPeakTimestamp (Timestamp lastPeak)

virtual Symmetry *	Spin () const

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

virtual	~Class ()

virtual Wave *	AsWave ()

virtual const Wave *	AsWave () const

virtual Wave *	Clone () const

Periodic *	Convert (Wave *wave)

virtual	operator Periodic * ()

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::Threaded
	Threaded ()

virtual	~Threaded ()

virtual ThreadId	GetThreadId ()

virtual bool	IsRunning ()

virtual void	Sleep (TimeUS us)

virtual bool	Start ()

virtual bool	Stop ()

virtual bool	Work ()

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

	ThreadSafe (const ThreadSafe &toCopy)

virtual	~ThreadSafe ()

void	LockThread () const

void	UnlockThread () const

Additional Inherited Members
Public Types inherited from bio::Threaded
typedef pid_t	ThreadId

Static Public Member Functions inherited from bio::physical::Periodic
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)

Static Public Member Functions inherited from bio::Threaded
static ThreadId	InvalidThreadId ()

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

Protected Member Functions inherited from bio::Threaded
virtual void	RequestStop ()

Static Protected Member Functions inherited from bio::Threaded
static void *	Worker (void *arg)

Protected Attributes inherited from bio::physical::Periodic
TimeUS	m_interval

Timestamp	m_lastPeakTimestamp

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

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

Symmetry *	m_symmetry

Protected Attributes inherited from bio::VirtualBase
bool	m_hasBeenInitialized

Protected Attributes inherited from bio::Threaded
bool	m_created

ThreadId	m_id

bool	m_running

bool	m_stopRequested

Detailed Description

A ThreadedPeriodic is simply an Periodic that vibrates in its own thread. See Periodic.h & Threaded.h for more info.

Definition at line 34 of file ThreadedPeriodic.h.

Constructor & Destructor Documentation

◆ ~ThreadedPeriodic()

bio::physical::ThreadedPeriodic::~ThreadedPeriodic ( )

virtual

Definition at line 35 of file ThreadedPeriodic.cpp.

36{

37}

Member Function Documentation

◆ BIO_DISAMBIGUATE_ALL_CLASS_METHODS()

bio::physical::ThreadedPeriodic::BIO_DISAMBIGUATE_ALL_CLASS_METHODS	(	physical	,
		ThreadedPeriodic
	)

Ensure virtual methods point to Class implementations.

◆ Work()

bool bio::physical::ThreadedPeriodic::Work ( )

virtual

Calls Peak() then sleeps.

Reimplemented from bio::Threaded.

Definition at line 39 of file ThreadedPeriodic.cpp.

{
    Timestamp now = GetCurrentTimestamp();
    Peak();
    LockThread();
    SetLastPeakTimestamp(now);
    UnlockThread();
    Threaded::Work();
    Sleep(GetInterval());
    return true;
}

References bio::physical::GetCurrentTimestamp().

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

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