uhd::cal::power_container Class Reference

#include <uhd/cal/power_container.hpp>

Inheritance diagram for uhd::cal::power_container:

Public Types
typedef boost::shared_ptr< power_container >	sptr
Public Types inherited from uhd::cal::cal_container< std::vector< double >, double >
typedef std::map< std::vector< double >, double >	container_t
typedef boost::archive::text_iarchive	iarchive_type
typedef boost::archive::text_oarchive	oarchive_type
Public Types inherited from uhd::cal::base_container
typedef std::map< std::string, std::string >	metadata_t
typedef boost::shared_ptr< base_container >	sptr

Public Member Functions
virtual double	get (const std::vector< double > &args)=0
virtual void	add (const double output, const std::vector< double > &args)=0
virtual void	add_metadata (const metadata_t &data)=0
virtual const metadata_t &	get_metadata ()=0

Static Public Member Functions
static sptr	make ()

Additional Inherited Members
Protected Member Functions inherited from uhd::cal::cal_container< std::vector< double >, double >
virtual void	serialize (iarchive_type &ar, const unsigned int)=0
virtual void	serialize (oarchive_type &ar, const unsigned int)=0

Member Typedef Documentation

sptr

typedef boost::shared_ptr<power_container> uhd::cal::power_container::sptr

Member Function Documentation

add()

virtual void uhd::cal::power_container::add ( const double  output, const std::vector< double > &  args  )

pure virtual

Add a data point to the container. This function records a mapping R^n -> R between an input vector and output scalar. For example, a mapping might be (power level, frequency, temperature) -> gain.

Parameters

output	the output of the data point mapping
args	input values

Implements uhd::cal::cal_container< std::vector< double >, double >.

add_metadata()

virtual void uhd::cal::power_container::add_metadata ( const metadata_t &  data )

pure virtual

Associate some metadata with the container.

Parameters

data	a map of metadata (string -> string).

Implements uhd::cal::cal_container< std::vector< double >, double >.

get()

virtual double uhd::cal::power_container::get ( const std::vector< double > &  args )

pure virtual

Get the mapping from an input to an output from the calibration container.

Parameters

args	input values

Returns

the output of the mapping (a scalar value)

Exceptions

uhd::assertion_error

if the number of input values are incorrect for the container type

Implements uhd::cal::cal_container< std::vector< double >, double >.

get_metadata()

virtual const metadata_t& uhd::cal::power_container::get_metadata ( )

pure virtual

Retrieve metadata from the container.

Returns

map of metadata.

Implements uhd::cal::cal_container< std::vector< double >, double >.

make()

static sptr uhd::cal::power_container::make ( )

static

Create a container for data related to power calibration.

Returns

shared pointer to the container

---

The documentation for this class was generated from the following file:

• include/uhd/cal/power_container.hpp