props.hpp

Go to the documentation of this file.

//
// Copyright 2010-2011 Ettus Research LLC
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
//

#ifndef INCLUDED_UHD_UTILS_PROPS_HPP
#define INCLUDED_UHD_UTILS_PROPS_HPP

#include <uhd/config.hpp>
#include <uhd/wax.hpp>
#include <uhd/exception.hpp>
#include <vector>
#include <string>

namespace uhd{

    typedef std::vector<std::string> prop_names_t;

    struct UHD_API named_prop_t{
        const wax::obj key;
        const std::string name;

        template<typename T> inline T as(void){
            return key.as<T>();
        }

        static named_prop_t extract(
            const wax::obj &key, const std::string &name = ""
        );

        named_prop_t(const wax::obj &key, const std::string &name);
    };

    #define UHD_THROW_PROP_GET_ERROR() \
        throw uhd::key_error(UHD_THROW_SITE_INFO("cannot get this property"))

    #define UHD_THROW_PROP_SET_ERROR() \
        throw uhd::key_error(UHD_THROW_SITE_INFO("cannot set this property"))

} //namespace uhd

#endif /* INCLUDED_UHD_UTILS_PROPS_HPP */