dict.hpp

Go to the documentation of this file.

//
// Copyright 2010-2011,2015 Ettus Research LLC
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//

#ifndef INCLUDED_UHD_TYPES_DICT_HPP
#define INCLUDED_UHD_TYPES_DICT_HPP

#include <uhd/config.hpp>
#include <list>
#include <map>
#include <vector>

namespace uhd {

template <typename Key, typename Val> class dict
{
public:
    dict(void);

    template <typename InputIterator> dict(InputIterator first, InputIterator last);

    std::size_t size(void) const;

    std::vector<Key> keys(void) const;

    std::vector<Val> vals(void) const;

    bool has_key(const Key& key) const;

    const Val& get(const Key& key, const Val& other) const;

    const Val& get(const Key& key) const;

    void set(const Key& key, const Val& val);

    const Val& operator[](const Key& key) const;

    Val& operator[](const Key& key);

    bool operator==(const dict<Key, Val>& other) const;

    bool operator!=(const dict<Key, Val>& other) const;

    Val pop(const Key& key);

    void update(const dict<Key, Val>& new_dict, bool fail_on_conflict = true);

    operator std::map<Key, Val>() const;

private:
    typedef std::pair<Key, Val> pair_t;
    std::list<pair_t> _map; // private container
};

} // namespace uhd

#include <uhd/types/dict.ipp>

#endif /* INCLUDED_UHD_TYPES_DICT_HPP */