observation.h

Go to the documentation of this file.

// Copyright (C) 2015 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
#ifndef OBSERVATION_H
#define OBSERVATION_H
 
#include <cc/data.h>
#include <exceptions/exceptions.h>
#include <boost/shared_ptr.hpp>
#include <boost/date_time/time_duration.hpp>
#include <boost/date_time/posix_time/posix_time_types.hpp>
#include <list>
#include <stdint.h>
 
namespace isc {
namespace stats {
 
class InvalidStatType : public Exception {
public:
    InvalidStatType(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) {}
};
 
typedef boost::posix_time::time_duration StatsDuration;
 
 
typedef std::pair<int64_t, boost::posix_time::ptime> IntegerSample;
 
typedef std::pair<double, boost::posix_time::ptime> FloatSample;
 
typedef std::pair<StatsDuration, boost::posix_time::ptime> DurationSample;
 
typedef std::pair<std::string, boost::posix_time::ptime> StringSample;
 
 
class Observation {
 public:
 
    enum Type {
        STAT_INTEGER, 
        STAT_FLOAT,   
        STAT_DURATION,
        STAT_STRING   
    };
 
    Observation(const std::string& name, const int64_t value);
 
    Observation(const std::string& name, const double value);
 
    Observation(const std::string& name, const StatsDuration& value);
 
    Observation(const std::string& name, const std::string& value);
 
    void setValue(const int64_t value);
 
    void setValue(const double value);
 
    void setValue(const StatsDuration& value);
 
    void setValue(const std::string& value);
 
    void addValue(const int64_t value);
 
    void addValue(const double value);
 
    void addValue(const StatsDuration& value);
 
    void addValue(const std::string& value);
 
    void reset();
 
    Type getType() const {
        return (type_);
    }
 
    IntegerSample getInteger() const;
 
    FloatSample getFloat() const;
 
    DurationSample getDuration() const;
 
    StringSample getString() const;
 
    isc::data::ConstElementPtr getJSON() const;
 
    static std::string typeToText(Type type);
 
    std::string getName() const {
        return (name_);
    }
 
private:
    template<typename SampleType, typename StorageType>
    void setValueInternal(SampleType value, StorageType& storage,
                          Type exp_type);
 
    template<typename SampleType, typename Storage>
    SampleType getValueInternal(Storage& storage, Type exp_type) const;
 
    std::string name_;
 
    Type type_;
 
 
    std::list<IntegerSample> integer_samples_;
 
    std::list<FloatSample> float_samples_;
 
    std::list<DurationSample> duration_samples_;
 
    std::list<StringSample> string_samples_;
};
 
typedef boost::shared_ptr<Observation> ObservationPtr;
 
};
};
 
#endif // OBSERVATION_H