Fawkes API
Fawkes Development Version
|
RRD Archive description. More...
#include <>>
Public Types | |
enum | ConsolidationFunction { AVERAGE, MIN, MAX, LAST } |
Consolidation function type. More... | |
Public Member Functions | |
RRDArchive (ConsolidationFunction cf, float xff, unsigned int steps, unsigned int rows) | |
Constructor. More... | |
RRDArchive (const RRDArchive &rra) | |
Copy constructor. More... | |
~RRDArchive () | |
Destructor. More... | |
const char * | to_string () const |
Get string representation. More... | |
RRDArchive & | operator= (const RRDArchive &rra) |
Assignment operator. More... | |
ConsolidationFunction | get_cf () const |
Get consolidation function type. More... | |
float | get_xff () const |
Get xfiles factor. More... | |
unsigned int | get_steps () const |
Get number of steps. More... | |
unsigned int | get_rows () const |
Get number of rows. More... | |
Static Public Member Functions | |
static const char * | cf_to_string (ConsolidationFunction cf) |
Convert consolidation function type to string. More... | |
RRD Archive description.
Definition at line 86 of file rrd_descriptions.h.
Consolidation function type.
Enumerator | |
---|---|
AVERAGE | Averaging consolidation function. |
MIN | Minimum consolidation function. |
MAX | Maximum consolidation function. |
LAST | Last value consolidation function. |
Definition at line 90 of file rrd_descriptions.h.
fawkes::RRDArchive::RRDArchive | ( | ConsolidationFunction | cf, |
float | xff, | ||
unsigned int | steps, | ||
unsigned int | rows | ||
) |
Constructor.
cf | consolidation function |
xff | The xfiles factor defines what part of a consolidation interval may be made up from UNKNOWN data while the consolidated value is still regarded as known. It is given as the ratio of allowed UNKNOWN PDPs to the number of PDPs in the interval. Thus, it ranges from 0 to 1 (exclusive). |
steps | defines how many of these primary data points are used to build a consolidated data point which then goes into the archive. |
rows | defines how many generations of data values are kept in an RRA. Obviously, this has to be greater than zero. |
Definition at line 179 of file rrd_descriptions.cpp.
fawkes::RRDArchive::RRDArchive | ( | const RRDArchive & | rra | ) |
Copy constructor.
rra | instance to copy |
Definition at line 189 of file rrd_descriptions.cpp.
fawkes::RRDArchive::~RRDArchive | ( | ) |
Destructor.
Definition at line 197 of file rrd_descriptions.cpp.
|
static |
Convert consolidation function type to string.
cf | consolidation function type |
cf
, suitable for RRA lines. Definition at line 246 of file rrd_descriptions.cpp.
References LAST, MAX, and MIN.
Referenced by fawkes::RRDGraphDataDefinition::to_string(), and fawkes::RRDGraphGPrint::to_string().
|
inline |
Get consolidation function type.
Definition at line 108 of file rrd_descriptions.h.
|
inline |
|
inline |
|
inline |
RRDArchive & fawkes::RRDArchive::operator= | ( | const RRDArchive & | rra | ) |
Assignment operator.
rra | instance to copy from |
Definition at line 207 of file rrd_descriptions.cpp.
const char * fawkes::RRDArchive::to_string | ( | ) | const |
Get string representation.
Definition at line 222 of file rrd_descriptions.cpp.