pq::DigitalOut Class Reference

A generic class representing a simple digital output. More...

#include <PqOutputs.h>

Inheritance diagram for pq::DigitalOut:

Collaboration diagram for pq::DigitalOut:

Public Member Functions
	DigitalOut (uint8_t pin, Engine &engine=Engine::primary())
	Constructor with default mode DIRECT.
	DigitalOut (uint8_t pin, uint8_t mode, Engine &engine=Engine::primary())
	Constructor.
virtual void	mode (uint8_t mode)
	Changes the mode of the component.
void	write (bool value)
	Directly writes value to the pin (bypasses mode and engine).
void	write (float value)
	Directly writes value in [0, 1] to the pin (bypasses mode and engine).
void	rawWrite (int value)
	Directly writes HIGH or LOW value to the pin (bypasses mode and engine).
virtual bool	isOn ()
	Returns true iff the input is "on".
virtual bool	putOn (bool value)
	Pushes value into the unit.
virtual bool	rose ()
	Returns true if the value rose.
virtual bool	fell ()
	Returns true if the value fell.
virtual bool	changed ()
	Returns true if the value changed.
virtual bool	toggle ()
	Switches between on and off.
virtual int8_t	changeState ()
	Difference between current and previous value of the unit.
virtual void	onRise (EventCallback callback)
	Registers event callback on rise event.
virtual void	onFall (EventCallback callback)
	Registers event callback on fall event.
virtual void	onChange (EventCallback callback)
	Registers event callback on change event.
virtual bool	isOff ()
	Returns true iff the input is "off".
virtual int	getInt ()
	Returns value as integer (0 or 1).
virtual float	get ()
	Returns value as float (either 0.0 or 1.0).
virtual bool	on ()
	Sets output to "on" (ie. true, 1).
virtual bool	off ()
	Sets output to "off" (ie. false, 0).
virtual float	put (float value)
	Pushes value into the unit.
virtual float	mapTo (float toLow, float toHigh)
	Maps value to new range.
	operator bool ()
	Operator that allows usage in conditional expressions.
	operator float ()
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.
uint8_t	pin () const
	Returns the pin this component is attached to.
uint8_t	mode () const
	Returns the mode of the component.

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 void	_init ()
void	_updateChangeState ()
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
bool	_onValue: 1
bool	_prevOnValue: 1
int8_t	_changeState: 2
uint8_t	_data: 4
uint8_t	_pin
uint8_t	_mode

Detailed Description

A generic class representing a simple digital output.

Constructor & Destructor Documentation

DigitalOut() [1/2]

pq::DigitalOut::DigitalOut	(	uint8_t	pin,
		Engine &	engine = Engine::primary()
	)

Constructor with default mode DIRECT.

Parameters

pin	the pin number

DigitalOut() [2/2]

pq::DigitalOut::DigitalOut	(	uint8_t	pin,
		uint8_t	mode,
		Engine &	engine = Engine::primary()
	)

Constructor.

Parameters

pin	the pin number
mode	the mode (DIRECT or INVERTED)

Member Function Documentation

begin()

void pq::DigitalOut::begin ( )

protectedvirtual

Reimplemented from pq::Unit.

eventTriggered()

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

inlineprotectedvirtualinherited

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

Reimplemented from pq::Unit.

Reimplemented in pq::Alarm.

get()

virtual float pq::DigitalUnit::get ( )

inlinevirtualinherited

Returns value as float (either 0.0 or 1.0).

Reimplemented from pq::Chainable.

isOn()

virtual bool pq::DigitalSource::isOn ( )

inlinevirtualinherited

Returns true iff the input is "on".

Reimplemented from pq::DigitalUnit.

mapTo()

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

inlinevirtualinherited

Maps value to new range.

Reimplemented from pq::Chainable.

mode()

void pq::DigitalOut::mode ( uint8_t  mode )

virtual

Changes the mode of the component.

Reimplemented from pq::PinConfig.

put()

virtual float pq::DigitalUnit::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 from pq::Chainable.

Reimplemented in pq::PeakDetector.

putOn()

virtual bool pq::DigitalSource::putOn ( bool  value )

inlinevirtualinherited

Pushes value into the unit.

Parameters

value

the value sent to the unit

Returns

the new value of the unit

Reimplemented from pq::DigitalUnit.

step()

void pq::DigitalOut::step ( )

protectedvirtual

Reimplemented from pq::Unit.

---

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

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