rrdMultiFile module

The rrdMultiFile Javascript module implements a set of classes that can be used to combine several RRDFile objects into one. They all implement the same interface as RRDFile.

Overview

The main class in this module is RRDFileSum. Given a list of similar RRDFile objects, it creates a new object that behaves like a RRDFile object where the input shave been summed up.

Class RRDFileSum

This is the main class of the package. It is also the only class the user ever needs to explicitly instantiate.

The RRDFileSum constructor has two argument:

A list of similar RRDFile objects.
They must all have the same DSes and the same RRAs.
An options object - If defined, it can contain any of the following:
- treat_undefined_as_zero - This value defines how to treat undefined values. If true (or undefined), they are counted as zeros and the sum will always succeed. If it is false, any undefined value in one of the input objects will result in the sum being marked as undefined.
For backwards compatibility, a boolean value is intrpreted as treat_undefined_as_zero

This class implements the same interface as RRDFile.

Internal classes

Class RRDRRASum

This class implements the same interface as RRDRRA.

This module is part of the javascriptRRD package hosted at http://javascriptrrd.sourceforge.net.
It is licensed under the MIT license.