labeled_value.h

Go to the documentation of this file.

// Copyright (C) 2013-2024 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 LABELED_VALUE_H
#define LABELED_VALUE_H
 
#include <exceptions/exceptions.h>
 
#include <boost/shared_ptr.hpp>
#include <ostream>
#include <string>
#include <map>
 
 
namespace isc {
namespace util {
 
class LabeledValueError : public isc::Exception {
public:
    LabeledValueError(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) { }
};
 
class LabeledValue {
public:
 
    LabeledValue(const int value, const std::string& label);
 
    virtual ~LabeledValue();
 
    int getValue() const;
 
    std::string getLabel() const;
 
    bool operator==(const LabeledValue& other) const;
 
    bool operator!=(const LabeledValue& other) const;
 
    bool operator<(const LabeledValue& other) const;
 
private:
    int value_;
 
    std::string label_;
};
 
std::ostream& operator<<(std::ostream& os, const LabeledValue& vlp);
 
typedef boost::shared_ptr<LabeledValue> LabeledValuePtr;
 
typedef std::map<unsigned int, LabeledValuePtr> LabeledValueMap;
 
 
class LabeledValueSet {
public:
    static const char* UNDEFINED_LABEL;
 
    LabeledValueSet();
 
    virtual ~LabeledValueSet();
 
    void add(LabeledValuePtr entry);
 
    void add(const int value, const std::string& label);
 
    const LabeledValuePtr& get(int value);
 
    bool isDefined(const int value) const;
 
    std::string getLabel(const int value) const;
 
private:
    LabeledValueMap map_;
};
 
} // namespace isc::util
} // namespace isc
#endif