Fawkes API  Fawkes Development Version
fawkes::RRDGraphDataDefinition Class Reference

Represent data definition in graph arguments. More...

#include <>>

Public Member Functions

 RRDGraphDataDefinition (const char *name, RRDArchive::ConsolidationFunction cf, const RRDDefinition *rrd_def, const char *ds_name=NULL)
 DEF constructor. More...
 
 RRDGraphDataDefinition (const char *name, const char *rpn_expression)
 CDEF constructor. More...
 
 RRDGraphDataDefinition (const RRDGraphDataDefinition &other)
 Copy constructor. More...
 
 ~RRDGraphDataDefinition ()
 Destructor. More...
 
RRDGraphDataDefinitionoperator= (const RRDGraphDataDefinition &rra)
 Assignment operator. More...
 
const char * to_string () const
 Create string representation. More...
 
const char * get_name () const
 Get name. More...
 
const RRDDefinitionget_rrd_def () const
 Get RRD definition. More...
 
const char * get_ds_name () const
 Get data source name. More...
 
const char * get_rpn_expression () const
 Get RPN expression. More...
 
RRDArchive::ConsolidationFunction get_cf () const
 Get consolidation function type. More...
 

Detailed Description

Represent data definition in graph arguments.

Author
Tim Niemueller Currently supports only DEF and CDEF definitions.

Definition at line 175 of file rrd_descriptions.h.

Constructor & Destructor Documentation

◆ RRDGraphDataDefinition() [1/3]

fawkes::RRDGraphDataDefinition::RRDGraphDataDefinition ( const char *  name,
RRDArchive::ConsolidationFunction  cf,
const RRDDefinition rrd_def,
const char *  ds_name = NULL 
)

DEF constructor.

Parameters
namename of the graph data source
cfconsolidation function to apply if needed
rrd_defRRD definition to use
ds_namedata source name in RRD, rrd_def will be queried for the data source. If ds_name is NULL, name will be used as the data source name.

Definition at line 452 of file rrd_descriptions.cpp.

◆ RRDGraphDataDefinition() [2/3]

fawkes::RRDGraphDataDefinition::RRDGraphDataDefinition ( const char *  name,
const char *  rpn_expression 
)

CDEF constructor.

Parameters
namename of the graph data source
rpn_expressionRPN expression

Definition at line 467 of file rrd_descriptions.cpp.

◆ RRDGraphDataDefinition() [3/3]

fawkes::RRDGraphDataDefinition::RRDGraphDataDefinition ( const RRDGraphDataDefinition other)

Copy constructor.

Parameters
otherinstance to clone

Definition at line 479 of file rrd_descriptions.cpp.

◆ ~RRDGraphDataDefinition()

fawkes::RRDGraphDataDefinition::~RRDGraphDataDefinition ( )

Destructor.

Definition at line 489 of file rrd_descriptions.cpp.

Member Function Documentation

◆ get_cf()

RRDArchive::ConsolidationFunction fawkes::RRDGraphDataDefinition::get_cf ( ) const
inline

Get consolidation function type.

Returns
consolidation function type

Definition at line 196 of file rrd_descriptions.h.

◆ get_ds_name()

const char* fawkes::RRDGraphDataDefinition::get_ds_name ( ) const
inline

Get data source name.

Returns
data source name

Definition at line 192 of file rrd_descriptions.h.

◆ get_name()

const char* fawkes::RRDGraphDataDefinition::get_name ( void  ) const
inline

Get name.

Returns
name

Definition at line 188 of file rrd_descriptions.h.

◆ get_rpn_expression()

const char* fawkes::RRDGraphDataDefinition::get_rpn_expression ( ) const
inline

Get RPN expression.

Returns
RPN expression

Definition at line 194 of file rrd_descriptions.h.

◆ get_rrd_def()

const RRDDefinition* fawkes::RRDGraphDataDefinition::get_rrd_def ( ) const
inline

Get RRD definition.

Returns
RRD definition

Definition at line 190 of file rrd_descriptions.h.

◆ operator=()

RRDGraphDataDefinition & fawkes::RRDGraphDataDefinition::operator= ( const RRDGraphDataDefinition other)

Assignment operator.

Parameters
otherinstance to copy from
Returns
reference to this instance

Definition at line 502 of file rrd_descriptions.cpp.

◆ to_string()

const char * fawkes::RRDGraphDataDefinition::to_string ( ) const

Create string representation.

Returns
string representation suitable for rrd_graph_v().

Definition at line 525 of file rrd_descriptions.cpp.

References fawkes::RRDArchive::cf_to_string(), fawkes::RRDDefinition::find_ds_index(), fawkes::RRDDefinition::get_ds(), and fawkes::RRDDefinition::get_filename().


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