anna::oam::CounterScope Class Reference

#include <CounterScope.hpp>

Inheritance diagram for anna::oam::CounterScope:

Collaboration diagram for anna::oam::CounterScope:

Public Member Functions
	~CounterScope ()
const std::string &	getName () const
const int	getId () const
void	create (const int counter, const char *name) noexcept(false)
std::string	asString () const
xml::Node *	asXML (xml::Node *parent) const noexcept(false)
U64	getAccValue (const int counter) const noexcept(false)
int	resetAccValues () noexcept(false)
Public Member Functions inherited from anna::Mutex
	Mutex (const Mode::_v mode=Mode::Recursive)
virtual	~Mutex ()
virtual void	lock () noexcept(false)
virtual void	unlock ()
bool	trylock () noexcept(false)
	operator const pthread_mutex_t * () const

Static Public Attributes
static const int	MaxCounter = 1000

Protected Member Functions
Counter::type_t	increment (const int counter, const Counter::type_t value) noexcept(false)
Counter::type_t	assign (const int counter, const Counter::type_t value) noexcept(false)
Counter::type_t	getValue (const int counter) const noexcept(false)
const Counter *	getCounter (const int counter) const noexcept(false)
Protected Member Functions inherited from anna::Safe
	Safe ()

Friends
class	Safe
class	Handler
class	Module

Detailed Description

Ámbito de contadores. Contiene un grupo logico de contadores.

Constructor & Destructor Documentation

~CounterScope()

anna::oam::CounterScope::~CounterScope

(

)

Destructor.

Member Function Documentation

assign()

Counter::type_t anna::oam::CounterScope::assign ( const int  counter, const Counter::type_t  value  )

protectednoexcept

Establece el valor del contador recibido como parámetro.

Warning

La invocación a este método deberá hacerse sobre una sección crítica que proteja a este ámbito.

Returns

El valor actual del contador.

asString()

std::string anna::oam::CounterScope::asString

(

)

const

Devuelve una cadena con la informacion relevante de este objeto.

Returns

Una cadena con la informacion relevante de este objeto.

asXML()

xml::Node* anna::oam::CounterScope::asXML ( xml::Node *  parent ) const

noexcept

Devuelve la información relevante de esta instancia en un documento XML.

Returns

la información relevante de esta instancia en un documento XML.

create()

void anna::oam::CounterScope::create ( const int  counter, const char *  name  )

noexcept

Crea un nuevo contador.

Parameters

counter	Numero logico del contador a crear. Debera ser menor de MaxCounter.
name	Nombre logico del ambito.

getAccValue()

U64 anna::oam::CounterScope::getAccValue ( const int  counter ) const

noexcept

Devuelve el valor actual acumulado del contador pasado como parámetro.

Parameters

counter

Identificador del contedor cuyo valor acumulado queremos obtener.

getCounter()

const Counter* anna::oam::CounterScope::getCounter ( const int  counter ) const

protectednoexcept

Devuelve la instancia del contador. Puede ser NULL.

Returns

la instancia del contador.

getId()

const int anna::oam::CounterScope::getId ( ) const

inline

Devuelve el identificador del ambito

Returns

El identificador del ambito.

{ return a_id; }

getName()

const std::string& anna::oam::CounterScope::getName ( ) const

inline

Devuelve el nombre logico del contador, que coincidira con el indicado a la hora de crear el contador mediante el metodo CounterScope::create.

Returns

El nombre logico del contador.

{ return a_name; }

getValue()

Counter::type_t anna::oam::CounterScope::getValue ( const int  counter ) const

protectednoexcept

Devuelve el valor actual del contador pasado como parámetro.

Parameters

counter

Identificador del contedor cuyo valor queremos obtener.

increment()

Counter::type_t anna::oam::CounterScope::increment ( const int  counter, const Counter::type_t  value  )

protectednoexcept

Incrementa el contador recibido como parámetro.

Warning

La invocación a este método deberá hacerse sobre una sección crítica que proteja a este ámbito.

Returns

El valor actual del contador.

resetAccValues()

int anna::oam::CounterScope::resetAccValues ( )

noexcept

Resetea los valores acumulados totales de los contadores incluidos en el ámbito.

Returns

Numero de contadores afectados que tenian un acumulado no nulo.

Friends And Related Function Documentation

Handler

friend class Handler

friend

Module

friend class Module

friend

Safe

friend class Safe

friend

Member Data Documentation

MaxCounter

const int anna::oam::CounterScope::MaxCounter = 1000

static

Numero maximo de contador por cada ambito

---

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

• /tmp/anna/include/anna/core/oam/CounterScope.hpp