IceMX::Metrics Class Reference

The base class for metrics. More...

#include <Ice/Ice.h>

Inheritance diagram for IceMX::Metrics:

Collaboration diagram for IceMX::Metrics:

Public Member Functions
std::tuple< const ::std::string &, const long long int &, const int &, const long long int &, const int & >	ice_tuple () const
	Obtains a tuple containing all of the value's data members. More...
	Metrics ()=default
	Metrics (const ::std::string &id, long long int total, int current, long long int totalLifetime, int failures)
	One-shot constructor to initialize all data members. More...
	Metrics (const Metrics &)=default
	Metrics (Metrics &&)=default
Metrics &	operator= (const Metrics &)=default
Metrics &	operator= (Metrics &&)=default
virtual	~Metrics ()

Static Public Member Functions
static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID of this value. More...

Public Attributes
int	current = 0
	The number of objects currently observed by this metrics. More...
int	failures = 0
	The number of failures observed. More...
::std::string	id
	The metrics identifier. More...
long long int	total = 0LL
	The total number of objects observed by this metrics. More...
long long int	totalLifetime = 0LL
	The sum of the lifetime of each observed objects. More...

Detailed Description

The base class for metrics.

A metrics object represents a collection of measurements associated to a given a system.

Constructor & Destructor Documentation

~Metrics()

virtual IceMX::Metrics::~Metrics ( )

virtual

Metrics() [1/4]

IceMX::Metrics::Metrics ( )

default

Metrics() [2/4]

IceMX::Metrics::Metrics ( const Metrics &  )

default

Metrics() [3/4]

IceMX::Metrics::Metrics ( Metrics &&  )

default

Metrics() [4/4]

IceMX::Metrics::Metrics ( const ::std::string &  id, long long int  total, int  current, long long int  totalLifetime, int  failures  )

inline

One-shot constructor to initialize all data members.

Parameters

id	The metrics identifier.
total	The total number of objects observed by this metrics.
current	The number of objects currently observed by this metrics.
totalLifetime	The sum of the lifetime of each observed objects.
failures	The number of failures observed.

Member Function Documentation

ice_staticId()

static const ::std::string& IceMX::Metrics::ice_staticId ( )

static

Obtains the Slice type ID of this value.

Returns

The fully-scoped type ID.

ice_tuple()

std::tuple<const ::std::string&, const long long int&, const int&, const long long int&, const int&> IceMX::Metrics::ice_tuple ( ) const

inline

Obtains a tuple containing all of the value's data members.

Returns

The data members in a tuple.

operator=() [1/2]

Metrics& IceMX::Metrics::operator= ( const Metrics &  )

default

operator=() [2/2]

Metrics& IceMX::Metrics::operator= ( Metrics &&  )

default

Member Data Documentation

current

int IceMX::Metrics::current = 0

The number of objects currently observed by this metrics.

failures

int IceMX::Metrics::failures = 0

The number of failures observed.

id

::std::string IceMX::Metrics::id

The metrics identifier.

total

long long int IceMX::Metrics::total = 0LL

The total number of objects observed by this metrics.

This includes the number of currently observed objects and the number of objects observed in the past.

totalLifetime

long long int IceMX::Metrics::totalLifetime = 0LL

The sum of the lifetime of each observed objects.

This does not include the lifetime of objects which are currently observed, only the objects observed in the past.

---

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

• generated/cpp11/x64/Release/Ice/Metrics.h