CStringHelper Namespace Reference

Namespace containing C sequence handling functions. More...

Functions
std::string	convert_to_std_string (void *str)
	Convert a rosidl_runtime_c__String into std::string.
std::vector< std::string >	convert_to_std_vector_string (void *str_array, size_t size)
	Convert a rosidl_runtime_c__String into a vector of std::string.
std::vector< std::string >	convert_sequence_to_std_vector_string (void *str_seq)
	Convert a rosidl_runtime_c__String__Sequence into a vector of std::string.
std::u16string	convert_to_std_u16string (void *str)
	Convert a rosidl_runtime_c__U16String into std::u16string.
std::vector< std::u16string >	convert_to_std_vector_u16string (void *str_array, size_t size)
	Convert a rosidl_runtime_c__U16String into a vector of std::u16string.
std::vector< std::u16string >	convert_sequence_to_std_vector_u16string (void *str_seq)
	Convert a rosidl_runtime_c__U16String__Sequence into a vector of std::u16string.
void	assign_string (std::string str, void *field)
	Assing to a rosidl_runtime_c__String the value contained in a std::string.
void	assign_vector_string (std::vector< std::string > cpp_string_vector, void *str_array, size_t size)
	Assing to a rosidl_runtime_c__String the value contained in a vector of std::string.
void	assign_vector_string_to_sequence (std::vector< std::string > cpp_string_vector, void *str_seq)
	Assing to a rosidl_runtime_c__String__Sequence the value contained in a vector of std::string.
void	assign_u16string (std::u16string str, void *field)
	Assing to a rosidl_runtime_c__U16String the value contained in a std::u16string.
void	assign_vector_u16string (std::vector< std::u16string > cpp_string_vector, void *str_array, size_t size)
	Assing to a rosidl_runtime_c__U16String the value contained in a vector of std::u16string.
void	assign_vector_u16string_to_sequence (std::vector< std::u16string > cpp_string_vector, void *str_seq)
	Assing to a rosidl_runtime_c__U16String__Sequence the value contained in a vector of std::u16string.

Detailed Description

Namespace containing C sequence handling functions.

The C data type implementation is more complicated than the C++ one, because complex types like vectors have to be manually managed and this header contains functions to convert C strings and generic sequences into respectively C++ strings and vectors.

Function Documentation

assign_string()

void CStringHelper::assign_string	(	std::string	str,
		void *	field )

Assing to a rosidl_runtime_c__String the value contained in a std::string.

This function stores the data contained in a C++ string in a rosidl_runtime_c__String pointed by the field parameter.

Parameters

str	C++ style string containing data
field	Pointer containing the destination of the string

assign_u16string()

void CStringHelper::assign_u16string	(	std::u16string	str,
		void *	field )

Assing to a rosidl_runtime_c__U16String the value contained in a std::u16string.

This function stores the data contained in a C++ u16string in a rosidl_runtime_c__U16String pointed by the field parameter.

Parameters

str	C++ style u16string containing data
field	Pointer containing the destination of the u16string

assign_vector_string()

void CStringHelper::assign_vector_string	(	std::vector< std::string >	cpp_string_vector,
		void *	str_array,
		size_t	size )

Assing to a rosidl_runtime_c__String the value contained in a vector of std::string.

This function stores the data contained in a C++ vector of strings in a rosidl_runtime_c__String fixed size sequence pointed by the str_array parameter.

Parameters

cpp_string_vector	C++ style vector of string containing data
str_array	Pointer containing the destination of the string sequence
size	Number of elements in the array

assign_vector_string_to_sequence()

void CStringHelper::assign_vector_string_to_sequence	(	std::vector< std::string >	cpp_string_vector,
		void *	str_seq )

Assing to a rosidl_runtime_c__String__Sequence the value contained in a vector of std::string.

This function stores the data contained in a C++ vector of strings in a rosidl_runtime_c__String__Sequence variable size sequence pointed by the str_array parameter.

Parameters

cpp_string_vector	C++ style vector of string containing data
str_seq	Pointer containing the destination of the string sequence

assign_vector_u16string()

void CStringHelper::assign_vector_u16string	(	std::vector< std::u16string >	cpp_string_vector,
		void *	str_array,
		size_t	size )

Assing to a rosidl_runtime_c__U16String the value contained in a vector of std::u16string.

This function stores the data contained in a C++ vector of u16strings in a rosidl_runtime_c__U16String fixed size sequence pointed by the str_array parameter.

Parameters

cpp_string_vector	C++ style vector of u16strings containing data
str_array	Pointer containing the destination of the u16string sequence
size	Number of elements in the array

assign_vector_u16string_to_sequence()

void CStringHelper::assign_vector_u16string_to_sequence	(	std::vector< std::u16string >	cpp_string_vector,
		void *	str_seq )

Assing to a rosidl_runtime_c__U16String__Sequence the value contained in a vector of std::u16string.

This function stores the data contained in a C++ vector of u16strings in a rosidl_runtime_c__U16String__Sequence variable size sequence pointed by the str_array parameter.

Parameters

cpp_string_vector	C++ style vector of u16strings containing data
str_seq	Pointer containing the destination of the u16string sequence

convert_sequence_to_std_vector_string()

std::vector< std::string > CStringHelper::convert_sequence_to_std_vector_string

(

void *

str_seq

)

Convert a rosidl_runtime_c__String__Sequence into a vector of std::string.

This function converts a rosidl_runtime_c__String__Sequence variable size sequence into a C++ vector of strings.

Parameters

str_seq

Pointer to the first original C-style string

Returns

A C++ vector of strings

convert_sequence_to_std_vector_u16string()

std::vector< std::u16string > CStringHelper::convert_sequence_to_std_vector_u16string

(

void *

str_seq

)

Convert a rosidl_runtime_c__U16String__Sequence into a vector of std::u16string.

This function converts a rosidl_runtime_c__U16String__Sequence variable size sequence into a C++ vector of u16string.

Parameters

str_seq

Pointer to the first original C-style u16string

Returns

A C++ vector of u16string

convert_to_std_string()

std::string CStringHelper::convert_to_std_string

(

void *

str

)

Convert a rosidl_runtime_c__String into std::string.

This function converts a rosidl_runtime_c__String into a C++ string.

Parameters

str	The original C-style string

Returns

A C++ string

convert_to_std_u16string()

std::u16string CStringHelper::convert_to_std_u16string

(

void *

str

)

Convert a rosidl_runtime_c__U16String into std::u16string.

This function converts a rosidl_runtime_c__U16String into a C++ u16string.

Parameters

str	The original C-style u16string

Returns

A C++ u16string

convert_to_std_vector_string()

std::vector< std::string > CStringHelper::convert_to_std_vector_string	(	void *	str_array,
		size_t	size )

Convert a rosidl_runtime_c__String into a vector of std::string.

This function converts a rosidl_runtime_c__String fixed size sequence into a C++ vector of strings.

Parameters

str_array	Pointer to the first original C-style string
size	Number of elements in the array

Returns

A C++ vector of strings

convert_to_std_vector_u16string()

std::vector< std::u16string > CStringHelper::convert_to_std_vector_u16string	(	void *	str_array,
		size_t	size )

Convert a rosidl_runtime_c__U16String into a vector of std::u16string.

This function converts a rosidl_runtime_c__U16String fixed size sequence into a C++ vector of u16string.

Parameters

str_array	Pointer to the first original C-style u16string
size	Number of elements in the array

Returns

A C++ vector of u16strings