Individual metric description. More...
#include <metric_description.hpp>
Public Member Functions | |
| metric_description (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)) | |
| Constructor. More... | |
| operator pmDesc () const | |
| Operator for implicit cast to pmDesc. More... | |
Public Attributes | |
| std::string | metric_name |
| This metric's name. More... | |
| atom_type_type | type |
| This metric's atom type. More... | |
| semantic_type | semantic |
| This metric's PCP semantic. More... | |
| pmUnits | units |
| This metric's PCP units. More... | |
| instance_domain * | domain |
| Optional instance domain for this metric. More... | |
| std::string | short_description |
| This metric's short description. More... | |
| std::string | verbose_description |
| This metric's verbose description. More... | |
| void *const | opaque |
| Opaque value to track with this metric. More... | |
| metric_flags | flags |
| Optional flags for this metric. More... | |
Detailed Description
Individual metric description.
Definition at line 56 of file metric_description.hpp.
Constructor & Destructor Documentation
◆ metric_description()
|
inline |
Constructor.
- Parameters
-
metric_name Metric name. type Atom type. semantic PCP semantic. units PCP units. domain Optional instance domain. short_description Short description. verbose_description Verbose description. opaque Opaque value to track. flags Optional metric flags.
Definition at line 80 of file metric_description.hpp.
Referenced by pcp::metric_cluster::operator()().
Member Function Documentation
◆ operator pmDesc()
|
inline |
Operator for implicit cast to pmDesc.
This operator allows this object to be used wherever PCP functions require a pmDesc instance.
- Returns
- A pmDesc struct representing this metric description.
Definition at line 110 of file metric_description.hpp.
Member Data Documentation
◆ domain
| instance_domain* pcp::metric_description::domain |
Optional instance domain for this metric.
Definition at line 61 of file metric_description.hpp.
Referenced by pcp::pmda::initialize_pmda(), and pcp::pmda::set_callbacks().
◆ flags
| metric_flags pcp::metric_description::flags |
Optional flags for this metric.
Definition at line 65 of file metric_description.hpp.
Referenced by pcp::pmda::on_store().
◆ metric_name
| std::string pcp::metric_description::metric_name |
This metric's name.
Definition at line 57 of file metric_description.hpp.
Referenced by pcp::pmda::set_callbacks().
◆ opaque
| void* const pcp::metric_description::opaque |
Opaque value to track with this metric.
Definition at line 64 of file metric_description.hpp.
Referenced by pcp::pmda::initialize_pmda().
◆ semantic
| semantic_type pcp::metric_description::semantic |
This metric's PCP semantic.
Definition at line 59 of file metric_description.hpp.
Referenced by operator pmDesc().
◆ short_description
| std::string pcp::metric_description::short_description |
This metric's short description.
Definition at line 62 of file metric_description.hpp.
Referenced by pcp::pmda::on_text().
◆ type
| atom_type_type pcp::metric_description::type |
This metric's atom type.
Definition at line 58 of file metric_description.hpp.
Referenced by pcp::pmda::on_fetch_callback(), pcp::pmda::on_store(), and operator pmDesc().
◆ units
| pmUnits pcp::metric_description::units |
This metric's PCP units.
Definition at line 60 of file metric_description.hpp.
Referenced by operator pmDesc().
◆ verbose_description
| std::string pcp::metric_description::verbose_description |
This metric's verbose description.
Definition at line 63 of file metric_description.hpp.
Referenced by pcp::pmda::on_text().
The documentation for this struct was generated from the following file:
