anna::timex::Clock Class Reference

#include <Clock.hpp>

Inheritance diagram for anna::timex::Clock:

Collaboration diagram for anna::timex::Clock:

Public Member Functions
	Clock (const char *name, const Millisecond &timeout)
std::string	asString () const
virtual bool	tick () noexcept(false)=0
Public Member Functions inherited from anna::timex::TimeEvent
virtual	~TimeEvent ()
Id	getId () const
const Millisecond &	getTimeout () const
const TimeEventObserver *	getObserver () const
void	setId (const Id id)
void	setTimeout (const Millisecond &timeout)
void	setObserver (TimeEventObserver *observer)
bool	isActive () const

Additional Inherited Members
Public Types inherited from anna::timex::TimeEvent
typedef anna::ptrnumber	Id
Protected Member Functions inherited from anna::timex::TimeEvent
	TimeEvent ()
	TimeEvent (const Id id, const Millisecond &timeout)
virtual void	stop () noexcept(false)

Detailed Description

Clase base para los relojes. Se activa de forma periodica cada getTimeout milisegundos.

See also

Timer

Constructor & Destructor Documentation

Clock()

anna::timex::Clock::Clock	(	const char *	name,
		const Millisecond &	timeout
	)

Constructor

Parameters

name	Nombre logico de este reloj.
timeout	Periodo de activacion indicado en milisegundos.

Member Function Documentation

asString()

std::string anna::timex::Clock::asString ( void  ) const

inlinevirtual

Devuelve una cadena con la informacion referente a este reloj.

Returns

Una cadena con la informacion referenta a este reloj.

Reimplemented from anna::timex::TimeEvent.

  {
    std::string msg("Clock { ");
    msg += TimeEvent::asString();
    msg += " | Name: ";
    msg += a_name;
    return msg += " }";
  }

Here is the call graph for this function:

tick()

virtual bool anna::timex::Clock::tick ( )

pure virtualnoexcept

Metodo a reimplementar para establecer las acciones que se ejecutaran cada vez que expire el tiempo asociado al reloj.

Returns

true si el reloj desea continuar recibiendo los pulsos periodicamente o false en otro caso.

Implemented in anna::testing::TestClock.

---

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

• /tmp/anna/include/anna/timex/Clock.hpp