stamped_value.h

Go to the documentation of this file.

// Copyright (C) 2018-2019 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 STAMPED_VALUE_H
#define STAMPED_VALUE_H

#include <cc/data.h>
#include <cc/stamped_element.h>
#include <boost/multi_index/hashed_index.hpp>
#include <boost/multi_index/mem_fun.hpp>
#include <boost/multi_index/ordered_index.hpp>
#include <boost/multi_index_container.hpp>
#include <boost/shared_ptr.hpp>
#include <cstdint>
#include <string>

namespace isc {
namespace data {

class StampedValue;

typedef boost::shared_ptr<StampedValue> StampedValuePtr;

class StampedValue : public StampedElement {
public:

    StampedValue(const std::string& name);

    StampedValue(const std::string& name, const ElementPtr& value);

    StampedValue(const std::string& name, const std::string& value);

    static StampedValuePtr create(const std::string& name);

    static StampedValuePtr create(const std::string& name,
                                  const ElementPtr& value);

    static StampedValuePtr create(const std::string& name,
                                  const std::string& value);

    static StampedValuePtr create(const std::string& name,
                                  const std::string& value,
                                  Element::types type);

    int getType() const;

    std::string getName() const {
        return (name_);
    }

    std::string getValue() const;

    bool amNull() const {
        return (!value_);
    }

    int64_t getIntegerValue() const;

    bool getBoolValue() const;

    double getDoubleValue() const;

    ConstElementPtr getElementValue() const {
        return (value_);
    }

private:

    void validateConstruct() const;

    void validateAccess(Element::types type) const;

    std::string name_;

    ElementPtr value_;
};



struct StampedValueNameIndexTag { };

struct StampedValueModificationTimeIndexTag { };

typedef boost::multi_index_container<
    StampedValuePtr,
    boost::multi_index::indexed_by<
        // Index used to access value by name.
        boost::multi_index::hashed_non_unique<
            boost::multi_index::tag<StampedValueNameIndexTag>,
            boost::multi_index::const_mem_fun<
                StampedValue,
                std::string,
                &StampedValue::getName
            >
        >,

        // Index used to access value by modification time.
        boost::multi_index::ordered_non_unique<
            boost::multi_index::tag<StampedValueModificationTimeIndexTag>,
            boost::multi_index::const_mem_fun<
                BaseStampedElement,
                boost::posix_time::ptime,
                &BaseStampedElement::getModificationTime
            >
        >
    >
> StampedValueCollection;


} // end of namespace isc::data
} // end of namespace isc

#endif