Class representing a graph definition. More...

#include <>>

Public Member Functions
	RRDGraphDefinition (const char name, RRDDefinition rrd_def, const char title, const char vertical_label, std::vector< RRDGraphDataDefinition > &def, std::vector< RRDGraphElement * > &elements, time_t start=-600, time_t end=-10, unsigned int step=10, unsigned int update_interval=10, bool slope_mode=false)
	Constructor.
	RRDGraphDefinition (const RRDGraphDefinition &other)
	Copy constructor.
	~RRDGraphDefinition ()
	Destructor.
void	set_filename (const char *filename)
	Set filename.
const char **	get_argv (size_t &argc) const
	Get argument array and size.
const char *	get_name () const
	Get graph definition name.
const RRDDefinition *	get_rrd_def () const
	Get RRD definition.
time_t	get_start () const
	Get start time.
time_t	get_end () const
	Get end time.
unsigned int	get_step () const
	Get step size.
const char *	get_title () const
	Get title.
const char *	get_vertical_label () const
	Get vertical label.
const unsigned int	get_update_interval () const
	Get update interval.
const bool	get_slope_mode () const
	Get slope moe.
const std::vector < RRDGraphDataDefinition > &	get_defs () const
	Get definitions.
const std::vector < RRDGraphElement * > &	get_elements () const
	Get graph elements.
unsigned int	get_width () const
	Get line width.
const std::vector< const char * >	get_fonts () const
	Get fonts.
const char *	get_filename () const
	Get filename.

Detailed Description

Class representing a graph definition.

This graph definition is used to generate all required parameters to create a graph from an RRD.

Author:: Tim Niemueller

Definition at line 313 of file rrd_descriptions.h.

Constructor & Destructor Documentation

fawkes::RRDGraphDefinition::RRDGraphDefinition	(	const char *	name,
		RRDDefinition *	rrd_def,
		const char *	title,
		const char *	vertical_label,
		std::vector< RRDGraphDataDefinition > &	def,
		std::vector< RRDGraphElement * > &	elements,
		time_t	start = `-600`,
		time_t	end = `-10`,
		unsigned int	step = `10`,
		unsigned int	update_interval = `10`,
		bool	slope_mode = `false`
	)

Constructor.

Parameters:

name	name of this graph definition, used internally, name must be unique among all registered graphs.
rrd_def	pointer to definition of the RRD to graph
start	time from where to start graphing. Maybe an absolute time or a negative number for relative times, e.g. "-300" for 5 minutes back from now.
end	time where to end graphing. Maybe an absolute time or a negative number for relative times, e.g. "-300" for 5 minutes back from now.
step	step size in seconds
title	Graph title to print on top of graph
vertical_label	string printed rotated by 90° counter-clockwise besides the vertical axis. Usually should carry description of the Y axis units.
update_interval	The interval at which the graph should be generated.
slope_mode	true to enable slope mode when graphing
def	data definitions for the graph
elements	elements to print in the graph. This graph definition takes ownership of the graph elemenets and will delete them in its dtor.

Definition at line 817 of file rrd_descriptions.cpp.

References fawkes::StringConversions::to_string().

fawkes::RRDGraphDefinition::RRDGraphDefinition ( const RRDGraphDefinition & other )

Copy constructor.

Parameters:

other instance to copy

Definition at line 848 of file rrd_descriptions.cpp.

References fawkes::StringConversions::to_string().

fawkes::RRDGraphDefinition::~RRDGraphDefinition ( )

Destructor.

Definition at line 873 of file rrd_descriptions.cpp.

Member Function Documentation

const char ** fawkes::RRDGraphDefinition::get_argv ( size_t & argc ) const

Get argument array and size.

Parameters:

argc	upon completion contains the number of arguments in the return value.

Returns:: argument array suitable for rrd_create_v().

Definition at line 914 of file rrd_descriptions.cpp.

const std::vector<RRDGraphDataDefinition>& fawkes::RRDGraphDefinition::get_defs ( ) const

inline

Get definitions.

Returns:: definitions

Definition at line 348 of file rrd_descriptions.h.

const std::vector<RRDGraphElement *>& fawkes::RRDGraphDefinition::get_elements ( ) const

inline

Get graph elements.

Returns:: graph elements

Definition at line 350 of file rrd_descriptions.h.

time_t fawkes::RRDGraphDefinition::get_end ( ) const

inline

Get end time.

Returns:: end time

Definition at line 336 of file rrd_descriptions.h.

const char* fawkes::RRDGraphDefinition::get_filename ( ) const

inline

Get filename.

Returns:: filename

Definition at line 357 of file rrd_descriptions.h.

const std::vector<const char *> fawkes::RRDGraphDefinition::get_fonts ( ) const

inline

Get fonts.

Returns:: fonts

Definition at line 355 of file rrd_descriptions.h.

const char* fawkes::RRDGraphDefinition::get_name ( void ) const

inline

Get graph definition name.

Returns:: graph definition name

Definition at line 330 of file rrd_descriptions.h.

Referenced by RRDThread::add_graph().

const RRDDefinition* fawkes::RRDGraphDefinition::get_rrd_def ( ) const

inline

Get RRD definition.

Returns:: RRD definition

Definition at line 332 of file rrd_descriptions.h.

const bool fawkes::RRDGraphDefinition::get_slope_mode ( ) const

inline

Get slope moe.

Returns:: slope mode

Definition at line 346 of file rrd_descriptions.h.

time_t fawkes::RRDGraphDefinition::get_start ( ) const

inline

Get start time.

Returns:: start time

Definition at line 334 of file rrd_descriptions.h.

unsigned int fawkes::RRDGraphDefinition::get_step ( ) const

inline

Get step size.

Returns:: step size

Definition at line 338 of file rrd_descriptions.h.

const char* fawkes::RRDGraphDefinition::get_title ( ) const

inline

Get title.

Returns:: tile

Definition at line 340 of file rrd_descriptions.h.

const unsigned int fawkes::RRDGraphDefinition::get_update_interval ( ) const

inline

Get update interval.

Returns:: update interval

Definition at line 344 of file rrd_descriptions.h.

const char* fawkes::RRDGraphDefinition::get_vertical_label ( ) const

inline

Get vertical label.

Returns:: vertical label

Definition at line 342 of file rrd_descriptions.h.

unsigned int fawkes::RRDGraphDefinition::get_width ( ) const

inline

Get line width.

Returns:: line width.

Definition at line 353 of file rrd_descriptions.h.

void fawkes::RRDGraphDefinition::set_filename ( const char * filename )

Set filename.

This can be done only once. Do not do this manually, rather let the RRDManager handle this!

Parameters:

filename new filename, should be absolute, otherwise considered relative to current working directory.

Definition at line 899 of file rrd_descriptions.cpp.

References fawkes::RRDDefinition::get_name().

Referenced by RRDThread::add_graph().

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

src/plugins/rrd/aspect/rrd_descriptions.h
src/plugins/rrd/aspect/rrd_descriptions.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation