#include <DynamicData.hpp>
Public Types | |
using | _ref_type = typename traits< DynamicData >::ref_type |
Public Member Functions | |
virtual FASTDDS_EXPORTED_API traits< DynamicType >::ref_type | type ()=0 |
Retrieve the DynamicType reference associated to this DynamicData. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_descriptor (traits< MemberDescriptor >::ref_type &value, MemberId id)=0 |
Retrieves the MemberDescriptor associated to a member. | |
virtual FASTDDS_EXPORTED_API bool | equals (traits< DynamicData >::ref_type other)=0 |
Compares two DynamicData, equality requires: | |
virtual FASTDDS_EXPORTED_API MemberId | get_member_id_by_name (const ObjectName &name)=0 |
Queries MemberId by name. | |
virtual FASTDDS_EXPORTED_API MemberId | get_member_id_at_index (uint32_t index)=0 |
Queries MemberId by index The query result depends on the type of the sample. | |
virtual FASTDDS_EXPORTED_API uint32_t | get_item_count ()=0 |
Provides the item count of the data and depends on the type of object: | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | clear_all_values ()=0 |
Clear all members associated to the object. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | clear_nonkey_values ()=0 |
Clear all members not associated to the key. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | clear_value (MemberId id)=0 |
Clear a member. | |
virtual FASTDDS_EXPORTED_API traits< DynamicData >::ref_type | loan_value (MemberId id)=0 |
Loans a DynamicData reference within the sample | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | return_loaned_value (traits< DynamicData >::ref_type value)=0 |
Returns a loan retrieved using DynamicData::loan_value. | |
virtual FASTDDS_EXPORTED_API traits< DynamicData >::ref_type | clone ()=0 |
Creates and returns a new data sample with the same contents as this one. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_int32_value (int32_t &value, MemberId id)=0 |
Retrieves an int32 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_int32_value (MemberId id, int32_t value)=0 |
Sets an int32 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_uint32_value (uint32_t &value, MemberId id)=0 |
Retrieves an uint32 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_uint32_value (MemberId id, uint32_t value)=0 |
Sets an uint32 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_int8_value (int8_t &value, MemberId id)=0 |
Retrieves an int8 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_int8_value (MemberId id, int8_t value)=0 |
Sets an int8 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_uint8_value (uint8_t &value, MemberId id)=0 |
Retrieves an uint8 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_uint8_value (MemberId id, uint8_t value)=0 |
Sets an uint8 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_int16_value (int16_t &value, MemberId id)=0 |
Retrieves an int16 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_int16_value (MemberId id, int16_t value)=0 |
Sets an int16 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_uint16_value (uint16_t &value, MemberId id)=0 |
Retrieves an uint16 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_uint16_value (MemberId id, uint16_t value)=0 |
Sets an uint16 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_int64_value (int64_t &value, MemberId id)=0 |
Retrieves an int64 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_int64_value (MemberId id, int64_t value)=0 |
Sets an int64 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_uint64_value (uint64_t &value, MemberId id)=0 |
Retrieves an uint64 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_uint64_value (MemberId id, uint64_t value)=0 |
Sets an uint64 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_float32_value (float &value, MemberId id)=0 |
Retrieves an float32 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_float32_value (MemberId id, float value)=0 |
Sets an float32 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_float64_value (double &value, MemberId id)=0 |
Retrieves an float64 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_float64_value (MemberId id, double value)=0 |
Sets an float64 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_float128_value (long double &value, MemberId id)=0 |
Retrieves an float128 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_float128_value (MemberId id, long double value)=0 |
Sets an float128 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_char8_value (char &value, MemberId id)=0 |
Retrieves an char8 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_char8_value (MemberId id, char value)=0 |
Sets an char8 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_char16_value (wchar_t &value, MemberId id)=0 |
Retrieves an char16 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_char16_value (MemberId id, wchar_t value)=0 |
Sets an char16 value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_byte_value (eprosima::fastdds::rtps::octet &value, MemberId id)=0 |
Retrieves an byte value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_byte_value (MemberId id, eprosima::fastdds::rtps::octet value)=0 |
Sets an byte value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_boolean_value (bool &value, MemberId id)=0 |
Retrieves an bool value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_boolean_value (MemberId id, bool value)=0 |
Sets an bool value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_string_value (std::string &value, MemberId id)=0 |
Retrieves an string value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_string_value (MemberId id, const std::string &value)=0 |
Sets an string value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_wstring_value (std::wstring &value, MemberId id)=0 |
Retrieves an wstring value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_wstring_value (MemberId id, const std::wstring &value)=0 |
Sets an wstring value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_complex_value (traits< DynamicData >::ref_type &value, MemberId id)=0 |
Retrieves a complex value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_complex_value (MemberId id, traits< DynamicData >::ref_type value)=0 |
Sets a complex value associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_int32_values (Int32Seq &value, MemberId id)=0 |
Retrieves a sequence of int32 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_int32_values (MemberId id, const Int32Seq &value)=0 |
Sets a sequence of int32 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_uint32_values (UInt32Seq &value, MemberId id)=0 |
Retrieves a sequence of uint32 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_uint32_values (MemberId id, const UInt32Seq &value)=0 |
Sets a sequence of uint32 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_int8_values (Int8Seq &value, MemberId id)=0 |
Retrieves a sequence of int8 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_int8_values (MemberId id, const Int8Seq &value)=0 |
Sets a sequence of int8 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_uint8_values (UInt8Seq &value, MemberId id)=0 |
Retrieves a sequence of uint8 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_uint8_values (MemberId id, const UInt8Seq &value)=0 |
Sets a sequence of uint8 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_int16_values (Int16Seq &value, MemberId id)=0 |
Retrieves a sequence of int16 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_int16_values (MemberId id, const Int16Seq &value)=0 |
Sets a sequence of int16 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_uint16_values (UInt16Seq &value, MemberId id)=0 |
Retrieves a sequence of uint16 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_uint16_values (MemberId id, const UInt16Seq &value)=0 |
Sets a sequence of uint16 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_int64_values (Int64Seq &value, MemberId id)=0 |
Retrieves a sequence of int64 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_int64_values (MemberId id, const Int64Seq &value)=0 |
Sets a sequence of int64 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_uint64_values (UInt64Seq &value, MemberId id)=0 |
Retrieves a sequence of uint64 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_uint64_values (MemberId id, const UInt64Seq &value)=0 |
Sets a sequence of uint64 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_float32_values (Float32Seq &value, MemberId id)=0 |
Retrieves a sequence of float32 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_float32_values (MemberId id, const Float32Seq &value)=0 |
Sets a sequence of float32 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_float64_values (Float64Seq &value, MemberId id)=0 |
Retrieves a sequence of float64 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_float64_values (MemberId id, const Float64Seq &value)=0 |
Sets a sequence of float64 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_float128_values (Float128Seq &value, MemberId id)=0 |
Retrieves a sequence of float128 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_float128_values (MemberId id, const Float128Seq &value)=0 |
Sets a sequence of float128 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_char8_values (CharSeq &value, MemberId id)=0 |
Retrieves a sequence of char8 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_char8_values (MemberId id, const CharSeq &value)=0 |
Sets a sequence of char8 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_char16_values (WcharSeq &value, MemberId id)=0 |
Retrieves a sequence of char16 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_char16_values (MemberId id, const WcharSeq &value)=0 |
Sets a sequence of char16 values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_byte_values (ByteSeq &value, MemberId id)=0 |
Retrieves a sequence of byte values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_byte_values (MemberId id, const ByteSeq &value)=0 |
Sets a sequence of byte values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_boolean_values (BooleanSeq &value, MemberId id)=0 |
Retrieves a sequence of bool values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_boolean_values (MemberId id, const BooleanSeq &value)=0 |
Sets a sequence of bool values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_string_values (StringSeq &value, MemberId id)=0 |
Retrieves a sequence of string values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_string_values (MemberId id, const StringSeq &value)=0 |
Sets a sequence of string values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_wstring_values (WstringSeq &value, MemberId id)=0 |
Retrieves a sequence of wstring values associated to an identifier. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | set_wstring_values (MemberId id, const WstringSeq &value)=0 |
Sets a sequence of wstring values associated to an identifier. | |
Protected Member Functions | |
DynamicData ()=default | |
virtual | ~DynamicData ()=default |
traits< DynamicData >::ref_type | _this () |
using _ref_type = typename traits<DynamicData>::ref_type |
|
protecteddefault |
|
protectedvirtualdefault |
|
protected |
|
pure virtual |
Clear all members associated to the object.
RETCODE_OK | when the cleaning was successful. |
|
pure virtual |
Clear all members not associated to the key.
RETCODE_OK | when the cleaning was successful. |
|
pure virtual |
Clear a member.
The meaning of "clearing" depends on the type of the sample:
[in] | id | Identifier of the member to purge |
RETCODE_OK | when the cleaning was successful. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid. |
|
pure virtual |
Creates and returns a new data sample with the same contents as this one.
A comparison of this object and the clone using equals immediately following this call will return true
.
|
pure virtual |
Compares two DynamicData, equality requires:
[in] | other | DynamicData reference to compare to |
true
on equality
|
pure virtual |
Retrieves an bool value associated to an identifier.
[in] | id | Identifier of the member to query. |
[in,out] | value | bool to populate. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to bool. |
|
pure virtual |
Retrieves a sequence of bool values associated to an identifier.
[in,out] | value | Sequence of bool to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of bool. |
|
pure virtual |
Retrieves an byte value associated to an identifier.
[in,out] | value | byte to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to byte. |
|
pure virtual |
Retrieves a sequence of byte values associated to an identifier.
[in,out] | value | Sequence of byte to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of byte. |
|
pure virtual |
Retrieves an char16 value associated to an identifier.
[in,out] | value | char16 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to char16. |
|
pure virtual |
Retrieves a sequence of char16 values associated to an identifier.
[in,out] | value | Sequence of char16 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of char16. |
|
pure virtual |
Retrieves an char8 value associated to an identifier.
[in,out] | value | char8 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to char8. |
|
pure virtual |
Retrieves a sequence of char8 values associated to an identifier.
[in,out] | value | Sequence of char8 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of char8. |
|
pure virtual |
Retrieves a complex value associated to an identifier.
[in,out] | value | DynamicData reference to populate |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to complex. |
|
pure virtual |
Retrieves the MemberDescriptor associated to a member.
[in,out] | value | Non-nil MemberDescriptor reference where the information is copied. |
[in] | id | Identifier of the member to be retrieved. |
RETCODE_OK | when the copy was successful. |
RETCODE_BAD_PARAMETER | when descriptor reference is nil or member identifier is not found. |
|
pure virtual |
Retrieves an float128 value associated to an identifier.
[in,out] | value | float128 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to float128. |
|
pure virtual |
Retrieves a sequence of float128 values associated to an identifier.
[in,out] | value | Sequence of float128 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of float128. |
|
pure virtual |
Retrieves an float32 value associated to an identifier.
[in,out] | value | float32 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to float32. |
|
pure virtual |
Retrieves a sequence of float32 values associated to an identifier.
[in,out] | value | Sequence of float32 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of float32. |
|
pure virtual |
Retrieves an float64 value associated to an identifier.
[in,out] | value | float64 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to float64. |
|
pure virtual |
Retrieves a sequence of float64 values associated to an identifier.
[in,out] | value | Sequence of float64 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of float64. |
|
pure virtual |
Retrieves an int16 value associated to an identifier.
[in,out] | value | int16 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to int16. |
|
pure virtual |
Retrieves a sequence of int16 values associated to an identifier.
[in,out] | value | Sequence of int16 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of int16. |
|
pure virtual |
Retrieves an int32 value associated to an identifier.
[in,out] | value | int32 to populate |
[in] | id | identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to int32. |
|
pure virtual |
Retrieves a sequence of int32 values associated to an identifier.
[in,out] | value | Sequence of int32 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of int32. |
|
pure virtual |
Retrieves an int64 value associated to an identifier.
[in,out] | value | int64 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to int64. |
|
pure virtual |
Retrieves a sequence of int64 values associated to an identifier.
[in,out] | value | Sequence of int64 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of int64. |
|
pure virtual |
Retrieves an int8 value associated to an identifier.
[in,out] | value | int8 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to int8. |
|
pure virtual |
Retrieves a sequence of int8 values associated to an identifier.
[in,out] | value | Sequence of int8 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of int8. |
|
pure virtual |
Provides the item count of the data and depends on the type of object:
|
pure virtual |
Queries MemberId by index The query result depends on the type of the sample.
Only next types support accessing by index.
[in] | index | Index. |
|
pure virtual |
Queries MemberId by name.
The query result depends on the type of the sample. Only next types support accessing by name.
[in] | name | string |
|
pure virtual |
Retrieves an string value associated to an identifier.
[in,out] | value | string to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to string. |
|
pure virtual |
Retrieves a sequence of string values associated to an identifier.
[in,out] | value | Sequence of string to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of string. |
|
pure virtual |
Retrieves an uint16 value associated to an identifier.
[in,out] | value | uint16 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to uint16. |
|
pure virtual |
Retrieves a sequence of uint16 values associated to an identifier.
[in,out] | value | Sequence of uint16 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of uint16. |
|
pure virtual |
Retrieves an uint32 value associated to an identifier.
[in,out] | value | uint32 to populate |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to uint32. |
|
pure virtual |
Retrieves a sequence of uint32 values associated to an identifier.
[in,out] | value | Sequence of uint32 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of uint32. |
|
pure virtual |
Retrieves an uint64 value associated to an identifier.
[in,out] | value | uint64 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to uint64. |
|
pure virtual |
Retrieves a sequence of uint64 values associated to an identifier.
[in,out] | value | Sequence of uint64 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of uint64. |
|
pure virtual |
Retrieves an uint8 value associated to an identifier.
[in,out] | value | uint8 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to uint8. |
|
pure virtual |
Retrieves a sequence of uint8 values associated to an identifier.
[in,out] | value | Sequence of uint8 to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of uint8. |
|
pure virtual |
Retrieves an wstring value associated to an identifier.
[in,out] | value | wstring to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to wstring. |
|
pure virtual |
Retrieves a sequence of wstring values associated to an identifier.
[in,out] | value | Sequence of wstring to populate. |
[in] | id | Identifier of the member to query. |
RETCODE_OK | when the value was retrieved successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of wstring. |
|
pure virtual |
Loans a DynamicData reference within the sample
[in] | id | identifier of the object to retrieve |
|
pure virtual |
Returns a loan retrieved using DynamicData::loan_value.
[in] | value | DynamicData reference previously loaned |
RETCODE_OK | when the loan was returned successfully. |
RETCODE_PRECONDITION_NOT_MET | when the loan is invalid. |
|
pure virtual |
Sets an bool value associated to an identifier.
[in] | id | identifier of the member to set. |
[in] | value | bool to set. |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to bool. |
|
pure virtual |
Sets a sequence of bool values associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | Sequence of bool to set |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of bool. |
|
pure virtual |
Sets an byte value associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | byte to set. |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to byte. |
|
pure virtual |
Sets a sequence of byte values associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | Sequence of byte to set |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of byte. |
|
pure virtual |
Sets an char16 value associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | char16 to set. |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to char16. |
|
pure virtual |
Sets a sequence of char16 values associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | Sequence of char16 to set |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of char16. |
|
pure virtual |
Sets an char8 value associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | char8 to set. |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to char8. |
|
pure virtual |
Sets a sequence of char8 values associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | Sequence of char8 to set |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of char8. |
|
pure virtual |
Sets a complex value associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | DynamicData reference to set |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the value reference is nil or MemberId is invalid or the member type is not promotable to complex. |
|
pure virtual |
Sets an float128 value associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | float128 to set. |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to float128. |
|
pure virtual |
Sets a sequence of float128 values associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | Sequence of float128 to set |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of float128. |
|
pure virtual |
Sets an float32 value associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | float32 to set. |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to float32. |
|
pure virtual |
Sets a sequence of float32 values associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | Sequence of float32 to set |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of float32. |
|
pure virtual |
Sets an float64 value associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | float64 to set. |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to float64. |
|
pure virtual |
Sets a sequence of float64 values associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | Sequence of float64 to set |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of float64. |
|
pure virtual |
Sets an int16 value associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | int16 to set. |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to int16. |
|
pure virtual |
Sets a sequence of int16 values associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | Sequence of int16 to set |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of int16. |
|
pure virtual |
Sets an int32 value associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | int32 to set |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to int32. |
|
pure virtual |
Sets a sequence of int32 values associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | Sequence of int32 to set |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of int32. |
|
pure virtual |
Sets an int64 value associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | int64 to set. |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to int64. |
|
pure virtual |
Sets a sequence of int64 values associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | Sequence of int64 to set |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of int64. |
|
pure virtual |
Sets an int8 value associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | int8 to set. |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to int8. |
|
pure virtual |
Sets a sequence of int8 values associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | Sequence of int8 to set |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of int8. |
|
pure virtual |
Sets an string value associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | string to set. |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to string or the string length is greater than the string bound. |
|
pure virtual |
Sets a sequence of string values associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | Sequence of string to set |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of string. |
|
pure virtual |
Sets an uint16 value associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | uint16 to set. |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to uint16. |
|
pure virtual |
Sets a sequence of uint16 values associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | Sequence of uint16 to set |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of uint16. |
|
pure virtual |
Sets an uint32 value associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | uint32 to set. |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to uint32. |
|
pure virtual |
Sets a sequence of uint32 values associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | Sequence of uint32 to set |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of uint32. |
|
pure virtual |
Sets an uint64 value associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | uint64 to set. |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to uint64. |
|
pure virtual |
Sets a sequence of uint64 values associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | Sequence of uint64 to set |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of uint64. |
|
pure virtual |
Sets an uint8 value associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | uint8 to set. |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to uint8. |
|
pure virtual |
Sets a sequence of uint8 values associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | Sequence of uint8 to set |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of uint8. |
|
pure virtual |
Sets an wstring value associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | wstring to set. |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to wstring or the string length is greater than the string bound. |
|
pure virtual |
Sets a sequence of wstring values associated to an identifier.
[in] | id | Identifier of the member to set. |
[in] | value | Sequence of wstring to set |
RETCODE_OK | when the value was set successfully. |
RETCODE_BAD_PARAMETER | when the MemberId is invalid or the member type is not promotable to sequence of wstring. |
|
pure virtual |
Retrieve the DynamicType reference associated to this DynamicData.