UHD 003.003.001

include/uhd/utils/props.hpp

Go to the documentation of this file.
00001 //
00002 // Copyright 2010-2011 Ettus Research LLC
00003 //
00004 // This program is free software: you can redistribute it and/or modify
00005 // it under the terms of the GNU General Public License as published by
00006 // the Free Software Foundation, either version 3 of the License, or
00007 // (at your option) any later version.
00008 //
00009 // This program is distributed in the hope that it will be useful,
00010 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00011 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00012 // GNU General Public License for more details.
00013 //
00014 // You should have received a copy of the GNU General Public License
00015 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
00016 //
00017 
00018 #ifndef INCLUDED_UHD_UTILS_PROPS_HPP
00019 #define INCLUDED_UHD_UTILS_PROPS_HPP
00020 
00021 #include <uhd/config.hpp>
00022 #include <uhd/wax.hpp>
00023 #include <uhd/exception.hpp>
00024 #include <vector>
00025 #include <string>
00026 
00027 namespace uhd{
00028 
00030     typedef std::vector<std::string> prop_names_t;
00031 
00036     struct UHD_API named_prop_t{
00037         const wax::obj key;
00038         const std::string name;
00039 
00041         template<typename T> inline T as(void){
00042             return key.as<T>();
00043         }
00044 
00053         static named_prop_t extract(
00054             const wax::obj &key, const std::string &name = ""
00055         );
00056 
00062         named_prop_t(const wax::obj &key, const std::string &name);
00063     };
00064 
00069     #define UHD_THROW_PROP_GET_ERROR() \
00070         throw uhd::key_error(UHD_THROW_SITE_INFO("cannot get this property"))
00071 
00076     #define UHD_THROW_PROP_SET_ERROR() \
00077         throw uhd::key_error(UHD_THROW_SITE_INFO("cannot set this property"))
00078 
00079 } //namespace uhd
00080 
00081 #endif /* INCLUDED_UHD_UTILS_PROPS_HPP */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines