semf::app::FrequencyIn Class Reference

Class for measuring the frequency on a capture input. More...

#include <frequencyin.h>

Inheritance diagram for semf::app::FrequencyIn:

Collaboration diagram for semf::app::FrequencyIn:

Public Member Functions
virtual	~FrequencyIn ()=default
virtual void	start ()=0
virtual void	stop ()=0
virtual void	reset ()=0
virtual uint32_t	periodTicks () const =0
	Returns the measured ticks of a signal period (directly after capturing it and emitted dataAvailable signal). More...
virtual uint32_t	periodInMs () const =0
	Returns the measured time in milliseconds of 2 successive captured signals. More...
virtual uint32_t	frequency () const =0
	Returns the measured frequency. More...

Public Attributes
Signal	dataAvailable

Detailed Description

Class for measuring the frequency on a capture input.

Definition at line 24 of file frequencyin.h.

Constructor & Destructor Documentation

~FrequencyIn()

virtual semf::app::FrequencyIn::~FrequencyIn ( )

virtualdefault

Member Function Documentation

frequency()

virtual uint32_t semf::app::FrequencyIn::frequency ( ) const

pure virtual

Returns the measured frequency.

Warning

For this method, the ticks per second must be set correctly.

Returns

The measured frequency.

See also

setTickPerSecond()

Implemented in semf::FrequencyIn.

periodInMs()

virtual uint32_t semf::app::FrequencyIn::periodInMs ( ) const

pure virtual

Returns the measured time in milliseconds of 2 successive captured signals.

Warning

For using this method, the ticks per second must set correctly.

Returns

The measured time in milliseconds.

See also

setTickPerSecond()

Implemented in semf::FrequencyIn.

periodTicks()

virtual uint32_t semf::app::FrequencyIn::periodTicks ( ) const

pure virtual

Returns the measured ticks of a signal period (directly after capturing it and emitted dataAvailable signal).

Returns

The measured ticks of a signal period.

Implemented in semf::FrequencyIn.

reset()

virtual void semf::app::FrequencyIn::reset ( )

pure virtual

Reset the last measured period (counter).

Implemented in semf::FrequencyIn.

start()

virtual void semf::app::FrequencyIn::start ( )

pure virtual

Start reading the input frequency.

Implemented in semf::FrequencyIn.

stop()

virtual void semf::app::FrequencyIn::stop ( )

pure virtual

Stop reading the input frequency.

Implemented in semf::FrequencyIn.

Member Data Documentation

dataAvailable

Signal semf::app::FrequencyIn::dataAvailable

Signal is emitted after a new frequency information is available.

Definition at line 57 of file frequencyin.h.