pcp::metrics_description Class Reference

Collection of clusters of metric descriptions. More...

#include <metric_description.hpp>

Inheritance diagram for pcp::metrics_description:

Collaboration diagram for pcp::metrics_description:

Public Member Functions
	metrics_description ()
	Default constructor. More...
metrics_description &	operator() (const cluster_id_type cluster_id, const std::string &cluster_name=std::string())
	Cluster insertion functor. More...
metrics_description &	operator() (const item_id_type item_id, const std::string &metric_name, const atom_type_type type, const semantic_type semantic, const pmUnits &units, const metric_flags flags, instance_domain *const domain=NULL, const std::string &short_description=std::string(), const std::string &verbose_description=std::string(), void *const opaque=NULL)
	Metric description insertion functor. More...
metrics_description &	operator() (const item_id_type item_id, const std::string &metric_name, const atom_type_type type, const semantic_type semantic, const pmUnits &units, instance_domain *const domain, const metric_flags flags, const std::string &short_description=std::string(), const std::string &verbose_description=std::string(), void *const opaque=NULL)
	Metric description insertion functor. More...
metrics_description &	operator() (const item_id_type item_id, const std::string &metric_name, const atom_type_type type, const semantic_type semantic, const pmUnits &units, instance_domain *const domain=NULL, const std::string &short_description=std::string(), const std::string &verbose_description=std::string(), void *const opaque=NULL, const metric_flags flags=static_cast< metric_flags >(0))
	Metric description insertion functor. More...

Detailed Description

Collection of clusters of metric descriptions.

Definition at line 275 of file metric_description.hpp.

Constructor & Destructor Documentation

metrics_description()

pcp::metrics_description::metrics_description ( )

inlineexplicit

Default constructor.

Constructs an empty metrics_description class - ie one with no metric clusters yet.

Definition at line 285 of file metric_description.hpp.

Member Function Documentation

operator()() [1/4]

metrics_description& pcp::metrics_description::operator() ( const cluster_id_type  cluster_id, const std::string &  cluster_name = std::string()  )

inline

Cluster insertion functor.

This functor inserts a new empty metric cluster into this object. It also records the insertion iterator so that future calls to any of the metric insertion functors add metrics to the new cluster inserted by this function.

Parameters

cluster_id	ID of the new cluster to insert.
cluster_name	Optional name of the cluster to insert.

Returns

A reference to this metrics_description object.

Definition at line 305 of file metric_description.hpp.

operator()() [2/4]

metrics_description& pcp::metrics_description::operator() ( const item_id_type  item_id, const std::string &  metric_name, const atom_type_type  type, const semantic_type  semantic, const pmUnits &  units, const metric_flags  flags, instance_domain *const  domain = NULL, const std::string &  short_description = std::string(), const std::string &  verbose_description = std::string(), void *const  opaque = NULL  )

inline

Metric description insertion functor.

This functor inserts a metric description in the most recently inserted cluster.

The cluster insertion function must be called at least once prior to calling this, or any of the other metric description insertion functors, otherwise an exception will be throw.

Parameters

item_id	Metric ID.
metric_name	Metric name.
type	Metric atom type.
semantic	PCP metric semantic.
units	PCP metric units.
flags	Optional metric flags.
domain	Optional metric instance domain.
short_description	Short metric description.
verbose_description	Verbose metric description.
opaque	Optional opaque pointer to track.

Exceptions

pcp::exception

If no metric cluster has been inserted yet.

Returns

A reference to this metrics_description object.

Definition at line 338 of file metric_description.hpp.

operator()() [3/4]

metrics_description& pcp::metrics_description::operator() ( const item_id_type  item_id, const std::string &  metric_name, const atom_type_type  type, const semantic_type  semantic, const pmUnits &  units, instance_domain *const  domain, const metric_flags  flags, const std::string &  short_description = std::string(), const std::string &  verbose_description = std::string(), void *const  opaque = NULL  )

inline

Metric description insertion functor.

This functor inserts a metric description in the most recently inserted cluster.

The cluster insertion function must be called at least once prior to calling this, or any of the other metric description insertion functors, otherwise an exception will be throw.

Parameters

item_id	Metric ID.
metric_name	Metric name.
type	Metric atom type.
semantic	PCP metric semantic.
units	PCP metric units.
domain	Optional metric instance domain.
flags	Optional metric flags.
short_description	Short metric description.
verbose_description	Verbose metric description.
opaque	Optional opaque pointer to track.

Exceptions

pcp::exception

If no metric cluster has been inserted yet.

Returns

A reference to this metrics_description object.

Definition at line 383 of file metric_description.hpp.

operator()() [4/4]

metrics_description& pcp::metrics_description::operator() ( const item_id_type  item_id, const std::string &  metric_name, const atom_type_type  type, const semantic_type  semantic, const pmUnits &  units, instance_domain *const  domain = NULL, const std::string &  short_description = std::string(), const std::string &  verbose_description = std::string(), void *const  opaque = NULL, const metric_flags  flags = static_cast<metric_flags>(0)  )

inline

Metric description insertion functor.

This functor inserts a metric description in the most recently inserted cluster.

The cluster insertion function must be called at least once prior to calling this, or any of the other metric description insertion functors, otherwise an exception will be throw.

Parameters

item_id	Metric ID.
metric_name	Metric name.
type	Metric atom type.
semantic	PCP metric semantic.
units	PCP metric units.
domain	Optional metric instance domain.
short_description	Short metric description.
verbose_description	Verbose metric description.
opaque	Optional opaque pointer to track.
flags	Optional metric flags.

Exceptions

pcp::exception

If no metric cluster has been inserted yet.

Returns

A reference to this metrics_description object.

Definition at line 428 of file metric_description.hpp.

---

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

• metric_description.hpp