YAMI4 Core Library 2.0.0
Messaging Solution for Distributed Systems
|
Read-only view on the parameters entry. More...
#include <parameter_entry.h>
Public Member Functions | |
parameter_type | type () const |
Returns the type of underlying (current) entry. More... | |
void | get_name (const char *&name, std::size_t &name_length) const |
Extracts the name of current entry. More... | |
result | get_boolean (bool &value) const |
Extracts the bool value from the current entry. More... | |
result | get_integer (int &value) const |
Extracts the int value from the current entry. More... | |
result | get_long_long (long long &value) const |
Extracts the long long value from the current entry. More... | |
result | get_word (unsigned int &value) const |
Extracts the unsigned int value from the current entry. More... | |
result | get_long_long_word (unsigned long long &value) const |
Extracts the unsigned long long value from the current entry. More... | |
result | get_double_float (double &value) const |
Extracts the double value from the current entry. More... | |
result | get_string (const char *&value, std::size_t &value_length) const |
Extracts the string value from the current entry. More... | |
result | get_binary (const void *&value, std::size_t &value_length) const |
Extracts the binary value from the current entry. More... | |
result | get_nested_parameters (parameters *¶ms) const |
Extracts the nested parameters object from the current entry. More... | |
result | get_boolean_array (bool *&values, std::size_t &array_length) const |
Extracts the array of bool values from the current entry. More... | |
result | get_integer_array (int *&values, std::size_t &array_length) const |
Extracts the array of int values from the current entry. More... | |
result | get_long_long_array (long long *&values, std::size_t &array_length) const |
Extracts the array of long long values from the current entry. More... | |
result | get_word_array (unsigned int *&values, std::size_t &array_length) const |
Extracts the array of unsigned int values from the current entry. More... | |
result | get_long_long_word_array (unsigned long long *&values, std::size_t &array_length) const |
Extracts the array of unsigned long long values from the current entry. More... | |
result | get_double_float_array (double *&values, std::size_t &array_length) const |
Extracts the array of double values from the current entry. More... | |
result | get_string_array_length (std::size_t &length) const |
Extracts the length of string array. More... | |
result | get_string_in_array (std::size_t index, const char *&value, std::size_t &value_length) const |
Extracts string value from string array. More... | |
result | get_binary_array_length (std::size_t &length) const |
Extracts the length of binary array. More... | |
result | get_binary_in_array (std::size_t index, const void *&value, std::size_t &value_length) const |
Extracts binary value from binary array. More... | |
Friends | |
class | parameters |
class | parameter_iterator |
result yami::core::parameter_entry::get_binary | ( | const void *& | value, |
std::size_t & | value_length | ||
) | const |
Extracts the binary value from the current entry.
Extracts the binary value from the current entry.
value | Pointer to the internal value buffer to be returned. |
value_length | Length of the internal value buffer. |
ok
if operation was successfulbad_type
if the current entry does not contain the binary value result yami::core::parameter_entry::get_binary_array_length | ( | std::size_t & | length | ) | const |
Extracts the length of binary array.
Extracts the length of binary array that is located at the current entry.
length | Length of the array. |
ok
if operation was successfulbad_type
if the current entry does not contain binary array result yami::core::parameter_entry::get_binary_in_array | ( | std::size_t | index, |
const void *& | value, | ||
std::size_t & | value_length | ||
) | const |
Extracts binary value from binary array.
Extracts the binary value from the given index of binary array that is located at the current entry.
index | The array index (array slot to be read, starting from 0). |
value | Pointer to the internal value buffer to be returned. |
value_length | Length of the internal value buffer. |
ok
if operation was successfulbad_type
if the current entry does not contain binary arrayno_such_index
if the given index is out of range result yami::core::parameter_entry::get_boolean | ( | bool & | value | ) | const |
Extracts the bool value from the current entry.
Extracts the bool value from the current entry.
value | The value to be returned. |
ok
if operation was successfulbad_type
if the current entry does not contain the bool value result yami::core::parameter_entry::get_boolean_array | ( | bool *& | values, |
std::size_t & | array_length | ||
) | const |
Extracts the array of bool values from the current entry.
Extracts the array of bool values from the current entry.
values | Pointer to the internal array buffer to be returned. |
array_length | Length of the internal array. |
ok
if operation was successfulbad_type
if the current entry does not contain bool arrayNote: this function gives read-write access to the underlying array, even if it was set as a shallow-copy.
result yami::core::parameter_entry::get_double_float | ( | double & | value | ) | const |
Extracts the double value from the current entry.
Extracts the double value from the current entry.
value | The value to be returned. |
ok
if operation was successfulbad_type
if the current entry does not contain the double value result yami::core::parameter_entry::get_double_float_array | ( | double *& | values, |
std::size_t & | array_length | ||
) | const |
Extracts the array of double values from the current entry.
Extracts the array of double values from the current entry.
values | Pointer to the internal array buffer to be returned. |
array_length | Length of the internal array. |
ok
if operation was successfulbad_type
if the current entry does not contain double arrayNote: this function gives read-write access to the underlying array, even if it was set as a shallow-copy.
result yami::core::parameter_entry::get_integer | ( | int & | value | ) | const |
Extracts the int value from the current entry.
Extracts the int value from the current entry.
value | The value to be returned. |
ok
if operation was successfulbad_type
if the current entry does not contain the int value result yami::core::parameter_entry::get_integer_array | ( | int *& | values, |
std::size_t & | array_length | ||
) | const |
Extracts the array of int values from the current entry.
Extracts the array of int values from the current entry.
values | Pointer to the internal array buffer to be returned. |
array_length | Length of the internal array. |
ok
if operation was successfulbad_type
if the current entry does not contain int arrayNote: this function gives read-write access to the underlying array, even if it was set as a shallow-copy.
result yami::core::parameter_entry::get_long_long | ( | long long & | value | ) | const |
Extracts the long long value from the current entry.
Extracts the long long value from the current entry.
value | The value to be returned. |
ok
if operation was successfulbad_type
if the current entry does not contain the long long value result yami::core::parameter_entry::get_long_long_array | ( | long long *& | values, |
std::size_t & | array_length | ||
) | const |
Extracts the array of long long values from the current entry.
Extracts the array of long long values from the current entry.
values | Pointer to the internal array buffer to be returned. |
array_length | Length of the internal array. |
ok
if operation was successfulbad_type
if the current entry does not contain long long arrayNote: this function gives read-write access to the underlying array, even if it was set as a shallow-copy.
result yami::core::parameter_entry::get_long_long_word | ( | unsigned long long & | value | ) | const |
Extracts the unsigned long long value from the current entry.
Extracts the unsigned long long value from the current entry.
value | The value to be returned. |
ok
if operation was successfulbad_type
if the current entry does not contain the long long value result yami::core::parameter_entry::get_long_long_word_array | ( | unsigned long long *& | values, |
std::size_t & | array_length | ||
) | const |
Extracts the array of unsigned long long values from the current entry.
Extracts the array of unsigned long long values from the current entry.
values | Pointer to the internal array buffer to be returned. |
array_length | Length of the internal array. |
ok
if operation was successfulbad_type
if the current entry does not contain long long arrayNote: this function gives read-write access to the underlying array, even if it was set as a shallow-copy.
void yami::core::parameter_entry::get_name | ( | const char *& | name, |
std::size_t & | name_length | ||
) | const |
Extracts the name of current entry.
Extracts the name of the underlying entry in the associated parameters object.
name | Pointer to the internal name buffer to be returned. |
name_length | Length of the internal name buffer. |
result yami::core::parameter_entry::get_nested_parameters | ( | parameters *& | params | ) | const |
Extracts the nested parameters object from the current entry.
Extracts nested parameters from the current entry.
params | Pointer to the internally created parameters object. |
ok
if operation was successfulbad_type
if the current entry does not contain nested parameters result yami::core::parameter_entry::get_string | ( | const char *& | value, |
std::size_t & | value_length | ||
) | const |
Extracts the string value from the current entry.
Extracts the string value from the current entry.
value | Pointer to the internal value buffer to be returned. |
value_length | Length of the internal value buffer. |
ok
if operation was successfulbad_type
if the current entry does not contain the string value result yami::core::parameter_entry::get_string_array_length | ( | std::size_t & | length | ) | const |
Extracts the length of string array.
Extracts the length of string array that is located at the current entry.
length | Length of the array. |
ok
if operation was successfulbad_type
if the current entry does not contain string array result yami::core::parameter_entry::get_string_in_array | ( | std::size_t | index, |
const char *& | value, | ||
std::size_t & | value_length | ||
) | const |
Extracts string value from string array.
Extracts the string value from the given index of string array that is located at the current entry.
index | The array index (array slot to be read, starting from 0). |
value | Pointer to the internal value buffer to be returned. |
value_length | Length of the internal value buffer. |
ok
if operation was successfulbad_type
if the current entry does not contain string arrayno_such_index
if the given index is out of range result yami::core::parameter_entry::get_word | ( | unsigned int & | value | ) | const |
Extracts the unsigned int value from the current entry.
Extracts the unsigned int value from the current entry.
value | The value to be returned. |
ok
if operation was successfulbad_type
if the current entry does not contain the unsigned int value result yami::core::parameter_entry::get_word_array | ( | unsigned int *& | values, |
std::size_t & | array_length | ||
) | const |
Extracts the array of unsigned int values from the current entry.
Extracts the array of unsigned int values from the current entry.
values | Pointer to the internal array buffer to be returned. |
array_length | Length of the internal array. |
ok
if operation was successfulbad_type
if the current entry does not contain int arrayNote: this function gives read-write access to the underlying array, even if it was set as a shallow-copy.
parameter_type yami::core::parameter_entry::type | ( | ) | const |
Returns the type of underlying (current) entry.
Returns the type of the underlying entry in the associated parameters object.