anna::DelayMeter< _TimeUnit > Class Template Reference

#include <DelayMeter.hpp>

Public Member Functions
	DelayMeter ()
	DelayMeter (const DelayMeter &other)
void	setControlPoint ()
void	setControlPoint (const _TimeUnit &timestamp)
void	setTopReference (const _TimeUnit &topReference)
void	clearTopReference ()
void	clear ()
_TimeUnit	getValue () const
_TimeUnit	getValue (const _TimeUnit &now) const
const _TimeUnit &	getNow () const
DelayMeter &	operator= (const DelayMeter &other)
bool	operator> (const _TimeUnit &left) const
bool	operator< (const _TimeUnit &left) const
std::string	asString () const
std::string	asDebugString (const char *whatis) const

Detailed Description

template<class _TimeUnit>
class anna::DelayMeter< _TimeUnit >

Facilita la medicion de los tiempos empleados las distintas partes de nuestra aplicacion.

Permite calcular tiempos acumulados como tiempos individuales. Por ejemplo:

#include <anna/core/DelayMeter.hpp>

void foo () {
   DelayMeter <_TimeUnit> meter;

   goo ();
   _TimeUnit gooTime = meter.getValue ();

   hoo ();
   _TimeUnit goohooTime = meter.setControlPoint ();

   joo ();
   _TimeUnit jooTime = meter.getValue ();
}

Dónde _TimeUnit podria ser anna::Second, anna::Millisecond, anna::Microsecond

Constructor & Destructor Documentation

DelayMeter() [1/2]

template<class _TimeUnit >

anna::DelayMeter< _TimeUnit >::DelayMeter ( )

inline

Constructor Inicializa la cuenta de temporizacion.

{ a_timestamp = _TimeUnit::getTime(); }

DelayMeter() [2/2]

template<class _TimeUnit >

anna::DelayMeter< _TimeUnit >::DelayMeter ( const DelayMeter< _TimeUnit > &  other )

inline

Constructor copia. Copia la cuenta de utilizacion de la instancia recibida como parametro.

Parameters

other

Instancia de la copiar los parametros para calcular el tiempo transcurrido.

: a_timestamp(other.a_timestamp), a_topReference(other.a_topReference) { ;}

Member Function Documentation

asDebugString()

template<class _TimeUnit >

std::string anna::DelayMeter< _TimeUnit >::asDebugString ( const char *  whatis ) const

inline

Devuelve la cadena de depuración de esta instancia.

Parameters

whatis

Texto con el nombre lógico de esta instancia.

Returns

la cadena de depuración de esta instancia.

                                                    {
    std::string result(whatis);
    result += " { TopReference: ";
    result += a_topReference.asString();
    result += " | TimeStamp: ";
    result += a_timestamp.asString();
    result += " | Now: ";
    result += a_now.asString();
    return result += " }";
  }

asString()

template<class _TimeUnit >

std::string anna::DelayMeter< _TimeUnit >::asString ( void  ) const

inline

Devuelve la cadena que muestra el tiempo medido por esta instancia.

Returns

la cadena que muestra el tiempo medido por esta instancia.

{ return getValue().asString(); }

Here is the call graph for this function:

clear()

template<class _TimeUnit >

void anna::DelayMeter< _TimeUnit >::clear ( )

inline

Inicializa el valor del punto de referencia.

{ a_timestamp = 0; }

clearTopReference()

template<class _TimeUnit >

void anna::DelayMeter< _TimeUnit >::clearTopReference ( )

inline

Elimina el punto de referencia temporal.

{ a_topReference = _TimeUnit(0); }

getNow()

template<class _TimeUnit >

const _TimeUnit& anna::DelayMeter< _TimeUnit >::getNow ( ) const

inline

Devuelve el tiempo que se usó como referencia al calcular el retardo en getValue

Returns

El tiempo que se usó como referencia al calcular el retardo en getValue

{ return a_now; }

getValue() [1/2]

template<class _TimeUnit >

_TimeUnit anna::DelayMeter< _TimeUnit >::getValue ( ) const

inline

Devuelve el número de milisegundos transcurridos desde la última vez que inicializamos la cuenta de temporización. Si se ha establecido un punto de referencia mediante setTopReference, devolverá la diferencia entre el el punto de control y la referencia, en otro caso, devolverá la diferencia entre el punto de control y el momento actual.

Returns

El número de milisegundos transcurridos desde la última vez que inicializamos la cuenta de temporizacion.

Warning

Si detecta algun fallo devolvera 0.

                             {
    a_now = (a_topReference == _TimeUnit(0)) ? _TimeUnit::getTime() : a_topReference;
    return (a_now > a_timestamp) ? (a_now - a_timestamp) : _TimeUnit(0);
  }

getValue() [2/2]

template<class _TimeUnit >

_TimeUnit anna::DelayMeter< _TimeUnit >::getValue ( const _TimeUnit &  now ) const

inline

Devuelve el número de milisegundos transcurridos desde la última vez que inicializamos la cuenta de temporización. Si se ha establecido un punto de referencia mediante setTopReference, devolverá la diferencia entre el el punto de control y la referencia, en otro caso, devolverá la diferencia entre el punto de control y el momento actual.

Parameters

now	Valor temporal tomado como referencia.

Returns

El número de milisegundos transcurridos desde la última vez que inicializamos la cuenta de temporizacion.

Warning

Si detecta algun fallo devolvera 0.

                                                 {
    return ((a_now = now) > a_timestamp) ? (a_now - a_timestamp) : _TimeUnit(0);
  }

operator<()

template<class _TimeUnit >

bool anna::DelayMeter< _TimeUnit >::operator< ( const _TimeUnit &  left ) const

inline

Compara el retardo acumulado por esta instancia con el valor recibido.

Parameters

left	Valor numérico con el comparar.

Returns

true si el retardo acumulado es mayor que el parámetro recibido o false en otro caso.

{ return getValue() < left; }

Here is the call graph for this function:

operator=()

template<class _TimeUnit >

DelayMeter& anna::DelayMeter< _TimeUnit >::operator= ( const DelayMeter< _TimeUnit > &  other )

inline

Operador copia.

Parameters

other

Instancia de la que copiar.

{ a_timestamp = other.a_timestamp; a_topReference = other.a_topReference; return *this; }

operator>()

template<class _TimeUnit >

bool anna::DelayMeter< _TimeUnit >::operator> ( const _TimeUnit &  left ) const

inline

Compara el retardo acumulado por esta instancia con el valor recibido.

Parameters

left	Valor numérico con el comparar.

Returns

true si el retardo acumulado es mayor que el parámetro recibido o false en otro caso.

{ return getValue() > left; }

Here is the call graph for this function:

setControlPoint() [1/2]

template<class _TimeUnit >

void anna::DelayMeter< _TimeUnit >::setControlPoint ( )

inline

Inicializa la cuenta de temporizacion. Este metodo es invocado automaticamente desde el contructor la clase por lo que si vamos usar esta instancia para tomar un unica medida no es necesario invocarlo.

Warning

Elimina el punto de referencia temporal que puediera haberse establecido con setTopReference.

Returns

El número de milisegundos transcurridos desde la última vez que inicializamos la cuenta de temporizacion.

                         {
    a_timestamp = _TimeUnit::getTime();
    clearTopReference();
  }

Here is the call graph for this function:

setControlPoint() [2/2]

template<class _TimeUnit >

void anna::DelayMeter< _TimeUnit >::setControlPoint ( const _TimeUnit &  timestamp )

inline

Inicializa la cuenta de temporizacion. Este metodo es invocado automaticamente desde el contructor la clase por lo que si vamos usar esta instancia para tomar un unica medida no es necesario invocarlo.

Warning

Elimina el punto de referencia temporal que puediera haberse establecido con setTopReference.

Returns

El número de milisegundos transcurridos desde la última vez que inicializamos la cuenta de temporizacion.

Parameters

timestamp

Valor de referencia a establecer.

                                                   {
    a_timestamp = timestamp;
    clearTopReference();
  }

Here is the call graph for this function:

setTopReference()

template<class _TimeUnit >

void anna::DelayMeter< _TimeUnit >::setTopReference ( const _TimeUnit &  topReference )

inline

Se da la posiblidad de establecer un punto de referencia temporal de forma que cuando se invoque a DelayMeter::getValue, el calculo de la diferencia de tiempo no se hará entre la marca de tiempo y el tiempo actual, sino la marca de tiempo y ésta marca de referencia.

Esta funcionalidad ha sido requerida para medir el tiempo de ejecución "real" de tareas que se ejecutan dentro de un thread. Ya que puede pasar un tiempo indeterminado desde que se termina la tarea MT (momento en el que se establecerá la marca de tiempo) y el núcleo y demás partes pueden tener conocimiento de que esa tarea ha sido finalidad.

{ a_topReference = topReference; }

---

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

• /tmp/anna/include/anna/core/util/DelayMeter.hpp