rclcpp  master
C++ ROS Client Library API
Public Member Functions | Static Public Member Functions | List of all members
rclcpp::parameter::ParameterVariant Class Reference

#include <parameter.hpp>

Public Member Functions

 ParameterVariant ()
 
 ParameterVariant (const std::string &name, const bool bool_value)
 
 ParameterVariant (const std::string &name, const int int_value)
 
 ParameterVariant (const std::string &name, const int64_t int_value)
 
 ParameterVariant (const std::string &name, const float double_value)
 
 ParameterVariant (const std::string &name, const double double_value)
 
 ParameterVariant (const std::string &name, const std::string &string_value)
 
 ParameterVariant (const std::string &name, const char *string_value)
 
 ParameterVariant (const std::string &name, const std::vector< uint8_t > &bytes_value)
 
ParameterType get_type () const
 
std::string get_type_name () const
 
const std::string & get_name () const
 
rcl_interfaces::msg::ParameterValue get_parameter_value () const
 
template<ParameterType type>
std::enable_if< type==ParameterType::PARAMETER_INTEGER, int64_t >::type get_value () const
 
template<ParameterType type>
std::enable_if< type==ParameterType::PARAMETER_DOUBLE, double >::type get_value () const
 
template<ParameterType type>
std::enable_if< type==ParameterType::PARAMETER_STRING, const std::string & >::type get_value () const
 
template<ParameterType type>
std::enable_if< type==ParameterType::PARAMETER_BOOL, bool >::type get_value () const
 
template<ParameterType type>
std::enable_if< type==ParameterType::PARAMETER_BYTES, const std::vector< uint8_t > & >::type get_value () const
 
template<typename type >
std::enable_if< std::is_integral< type >::value &&!std::is_same< type, bool >::value, int64_t >::type get_value () const
 
template<typename type >
std::enable_if< std::is_floating_point< type >::value, double >::type get_value () const
 
template<typename type >
std::enable_if< std::is_convertible< type, std::string >::value, const std::string & >::type get_value () const
 
template<typename type >
std::enable_if< std::is_same< type, bool >::value, bool >::type get_value () const
 
template<typename type >
std::enable_if< std::is_convertible< type, const std::vector< uint8_t > & >::value, const std::vector< uint8_t > & >::type get_value () const
 
int64_t as_int () const
 
double as_double () const
 
const std::string & as_string () const
 
bool as_bool () const
 
const std::vector< uint8_t > & as_bytes () const
 
rcl_interfaces::msg::Parameter to_parameter ()
 
std::string value_to_string () const
 

Static Public Member Functions

static ParameterVariant from_parameter (const rcl_interfaces::msg::Parameter &parameter)
 

Constructor & Destructor Documentation

◆ ParameterVariant() [1/9]

rclcpp::parameter::ParameterVariant::ParameterVariant ( )

◆ ParameterVariant() [2/9]

rclcpp::parameter::ParameterVariant::ParameterVariant ( const std::string &  name,
const bool  bool_value 
)
explicit

◆ ParameterVariant() [3/9]

rclcpp::parameter::ParameterVariant::ParameterVariant ( const std::string &  name,
const int  int_value 
)
explicit

◆ ParameterVariant() [4/9]

rclcpp::parameter::ParameterVariant::ParameterVariant ( const std::string &  name,
const int64_t  int_value 
)
explicit

◆ ParameterVariant() [5/9]

rclcpp::parameter::ParameterVariant::ParameterVariant ( const std::string &  name,
const float  double_value 
)
explicit

◆ ParameterVariant() [6/9]

rclcpp::parameter::ParameterVariant::ParameterVariant ( const std::string &  name,
const double  double_value 
)
explicit

◆ ParameterVariant() [7/9]

rclcpp::parameter::ParameterVariant::ParameterVariant ( const std::string &  name,
const std::string &  string_value 
)
explicit

◆ ParameterVariant() [8/9]

rclcpp::parameter::ParameterVariant::ParameterVariant ( const std::string &  name,
const char *  string_value 
)
explicit

◆ ParameterVariant() [9/9]

rclcpp::parameter::ParameterVariant::ParameterVariant ( const std::string &  name,
const std::vector< uint8_t > &  bytes_value 
)
explicit

Member Function Documentation

◆ get_type()

ParameterType rclcpp::parameter::ParameterVariant::get_type ( ) const

◆ get_type_name()

std::string rclcpp::parameter::ParameterVariant::get_type_name ( ) const

◆ get_name()

const std::string& rclcpp::parameter::ParameterVariant::get_name ( ) const

◆ get_parameter_value()

rcl_interfaces::msg::ParameterValue rclcpp::parameter::ParameterVariant::get_parameter_value ( ) const

◆ get_value() [1/10]

template<ParameterType type>
std::enable_if<type == ParameterType::PARAMETER_INTEGER, int64_t>::type rclcpp::parameter::ParameterVariant::get_value ( ) const
inline

◆ get_value() [2/10]

template<ParameterType type>
std::enable_if<type == ParameterType::PARAMETER_DOUBLE, double>::type rclcpp::parameter::ParameterVariant::get_value ( ) const
inline

◆ get_value() [3/10]

template<ParameterType type>
std::enable_if<type == ParameterType::PARAMETER_STRING, const std::string &>::type rclcpp::parameter::ParameterVariant::get_value ( ) const
inline

◆ get_value() [4/10]

template<ParameterType type>
std::enable_if<type == ParameterType::PARAMETER_BOOL, bool>::type rclcpp::parameter::ParameterVariant::get_value ( ) const
inline

◆ get_value() [5/10]

template<ParameterType type>
std::enable_if< type == ParameterType::PARAMETER_BYTES, const std::vector<uint8_t> &>::type rclcpp::parameter::ParameterVariant::get_value ( ) const
inline

◆ get_value() [6/10]

template<typename type >
std::enable_if< std::is_integral<type>::value && !std::is_same<type, bool>::value, int64_t>::type rclcpp::parameter::ParameterVariant::get_value ( ) const
inline

◆ get_value() [7/10]

template<typename type >
std::enable_if<std::is_floating_point<type>::value, double>::type rclcpp::parameter::ParameterVariant::get_value ( ) const
inline

◆ get_value() [8/10]

template<typename type >
std::enable_if<std::is_convertible<type, std::string>::value, const std::string &>::type rclcpp::parameter::ParameterVariant::get_value ( ) const
inline

◆ get_value() [9/10]

template<typename type >
std::enable_if<std::is_same<type, bool>::value, bool>::type rclcpp::parameter::ParameterVariant::get_value ( ) const
inline

◆ get_value() [10/10]

template<typename type >
std::enable_if< std::is_convertible< type, const std::vector<uint8_t> &>::value, const std::vector<uint8_t> &>::type rclcpp::parameter::ParameterVariant::get_value ( ) const
inline

◆ as_int()

int64_t rclcpp::parameter::ParameterVariant::as_int ( ) const

◆ as_double()

double rclcpp::parameter::ParameterVariant::as_double ( ) const

◆ as_string()

const std::string& rclcpp::parameter::ParameterVariant::as_string ( ) const

◆ as_bool()

bool rclcpp::parameter::ParameterVariant::as_bool ( ) const

◆ as_bytes()

const std::vector<uint8_t>& rclcpp::parameter::ParameterVariant::as_bytes ( ) const

◆ from_parameter()

static ParameterVariant rclcpp::parameter::ParameterVariant::from_parameter ( const rcl_interfaces::msg::Parameter &  parameter)
static

◆ to_parameter()

rcl_interfaces::msg::Parameter rclcpp::parameter::ParameterVariant::to_parameter ( )

◆ value_to_string()

std::string rclcpp::parameter::ParameterVariant::value_to_string ( ) const

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