pq::StreamOut Class Reference

Stream/serial output. Number of digits of precision is configurable. More...

#include <StreamOut.h>

Inheritance diagram for pq::StreamOut:

Collaboration diagram for pq::StreamOut:

Public Member Functions
	StreamOut (Engine &engine=Engine::primary())
	Default constructor.
	StreamOut (Stream &stream, Engine &engine=Engine::primary())
	Constructor.
virtual float	mapTo (float toLow, float toHigh)
	Maps value to new range.
virtual float	put (float value)
	Pushes value into the unit.
virtual void	precision (uint8_t digits)
	Sets precision of the output.
virtual float	get ()
	Returns value in [0, 1].
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.
	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
uint8_t	_digits
Stream *	_stream
float	_value

Detailed Description

Stream/serial output. Number of digits of precision is configurable.

Constructor & Destructor Documentation

StreamOut() [1/2]

pq::StreamOut::StreamOut

(

Engine &

engine = Engine::primary()

)

Default constructor.

Parameters

engine

the engine running this unit

StreamOut() [2/2]

pq::StreamOut::StreamOut	(	Stream &	stream,
		Engine &	engine = Engine::primary()
	)

Constructor.

Parameters

stream	a reference to a Stream object
engine	the engine running this unit

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

inlinevirtualinherited

Returns value in [0, 1].

Reimplemented from pq::Chainable.

Reimplemented in pq::AbstractWave.

mapTo()

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

inlinevirtual

Maps value to new range.

Reimplemented from pq::AnalogSource.

precision()

void pq::StreamOut::precision ( uint8_t  digits )

virtual

Sets precision of the output.

Parameters

digits

the number of digits to show after decimal point

put()

float pq::StreamOut::put ( float  value )

virtual

Pushes value into the unit.

Parameters

value

the value sent to the unit

Returns

the new value of the unit

Reimplemented from pq::Chainable.

---

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

• /home/tats/Documents/workspace/Plaquette/src/StreamOut.h
• /home/tats/Documents/workspace/Plaquette/src/StreamOut.cpp