An analog analog source that contains a value constrained to a finite range (typically in [0, 1]). More...

#include <PqCore.h>

Inheritance diagram for pq::AnalogSource:

[legend]

Collaboration diagram for pq::AnalogSource:

[legend]

Public Member Functions
	AnalogSource (Engine &engine=Engine::primary())
	Constructor.

	AnalogSource (float initialValue, Engine &engine=Engine::primary())

virtual float	get ()
	Returns value in [0, 1].

virtual float	mapTo (float toLow, float toHigh)
	Maps value to new range.

virtual void	clearEvents ()

float	seconds () const
	Returns engine time in seconds.

uint32_t	milliSeconds () const
	Returns engine time in milliseconds.

uint64_t	microSeconds () const
	Returns engine time in microseconds.

unsigned long	nSteps () const
	Returns number of engine steps.

float	sampleRate () const
	Returns engine sample rate.

float	samplePeriod () const
	Returns enginesample period.

	operator float ()
	Object can be used directly to access its value.

virtual float	put (float value)
	Pushes value into the unit.

	operator bool ()
	Operator that allows usage in conditional expressions.

Static Public Member Functions
static bool	analogToDigital (float f)
	Converts analog (float) value to digital (bool) value.

static float	digitalToAnalog (bool b)
	Converts digital (bool) value to analog (float) value.

Protected Member Functions
virtual void	begin ()

virtual void	step ()

virtual bool	eventTriggered (EventType eventType)
	Returns true iff an event of a certain type has been triggered.

virtual void	onEvent (EventCallback callback, EventType eventType)
	Registers event callback.

Engine *	engine () const
	Returns the engine that owns this unit.

Protected Attributes
float	_value

Detailed Description

An analog analog source that contains a value constrained to a finite range (typically in [0, 1]).

It is the responsibility of the subclass's programmer to make sure the value stays within range OR to update the mapTo() function accordingly.

Member Function Documentation

◆ eventTriggered()

virtual bool pq::Unit::eventTriggered ( EventType eventType )

inlineprotectedvirtualinherited

Returns true iff an event of a certain type has been triggered.

Reimplemented in pq::AbstractWave, pq::Alarm, pq::Metronome, pq::PeakDetector, pq::DigitalSource, pq::Ramp, pq::StreamIn, and pq::TimeSliceField< COUNT >.

◆ get()

virtual float pq::AnalogSource::get ( )

inlinevirtual

Returns value in [0, 1].

Reimplemented from pq::Chainable.

Reimplemented in pq::AbstractWave.

◆ mapTo()

virtual float pq::AnalogSource::mapTo	(	float	toLow,
		float	toHigh
	)

inlinevirtual

Maps value to new range.

Reimplemented from pq::Chainable.

Reimplemented in pq::Normalizer, pq::StreamIn, and pq::StreamOut.

◆ put()

virtual float pq::Chainable::put ( float value )

inlinevirtualinherited

Pushes value into the unit.

Parameters

value the value sent to the unit

Returns: the new value of the unit

Reimplemented in pq::Chronometer, pq::MinMaxScaler, pq::Normalizer, pq::PeakDetector, pq::DigitalUnit, pq::AnalogOut, pq::AbstractServoOut, pq::Ramp, pq::Smoother, pq::StreamOut, pq::PivotField, and pq::TimeSliceField< COUNT >.

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

/home/tats/Documents/workspace/Plaquette/src/PqCore.h

Public Member Functions

Static Public Member Functions