|
RTI Connext Traditional C++ API Version 7.3.0
|
A sample of any complex data type, which can be inspected and manipulated reflectively. More...
Public Member Functions | |
| DDS_DynamicData (const DDS_TypeCode *type, const DDS_DynamicDataProperty_t &property) | |
| The constructor for new DDS_DynamicData objects. More... | |
| DDS_Boolean | is_valid () const |
| Indicates whether the object was constructed properly. More... | |
| DDS_ReturnCode_t | copy (const DDS_DynamicData &src) |
| Deeply copy from the given object to this object. More... | |
| DDS_Boolean | equal (const DDS_DynamicData &other) const |
| Indicate whether the contents of another DDS_DynamicData sample are the same as those of this one. More... | |
| DDS_DynamicData & | operator= (const DDS_DynamicData &src) |
| Deeply copy from the given object to this object. More... | |
| DDS_Boolean | operator== (const DDS_DynamicData &other) const |
| Indicate whether the contents of another DDS_DynamicData sample are the same as those of this one. More... | |
| DDS_ReturnCode_t | clear_all_members () |
| Clear the contents of all data members of this object. More... | |
| DDS_ReturnCode_t | clear_optional_member (const char *member_name, DDS_DynamicDataMemberId member_id) |
| Clear the contents of a single optional data member of this object. More... | |
| DDS_ReturnCode_t | clear_member (const char *member_name, DDS_DynamicDataMemberId member_id) |
| Clear the contents of a single data member of this object. More... | |
| DDS_Boolean | is_cdr () const |
| Determine if a DynamicData object is using CDR as its data representation. More... | |
| const char * | get_cdr_buffer (DDS_UnsignedLong &length) const |
| Get the CDR buffer associated with a DynamicData object. More... | |
| DDS_ReturnCode_t | set_cdr_buffer (const char *buffer, DDS_UnsignedLong length) |
| Associate a CDR buffer with a DynamicData object. More... | |
| DDS_ReturnCode_t | from_cdr_buffer (const char *buffer, unsigned int length) |
| Deserializes a DynamicData object from a buffer of octets. More... | |
| DDS_ReturnCode_t | to_cdr_buffer (char *buffer, unsigned int &length) |
| Serializes a DynamicData object into a CDR buffer of octets. More... | |
| DDS_ReturnCode_t | to_cdr_buffer_ex (char *buffer, unsigned int &length, DDS_DataRepresentationId_t representation) |
| Serializes a DynamicData object into a buffer of octets. More... | |
| DDS_ReturnCode_t | to_string (char *str, DDS_UnsignedLong &str_size, const DDS_PrintFormatProperty &property) |
| Get a string representation of a DynamicData object. More... | |
| DDS_ReturnCode_t | from_string (const char *str, DDS_PrintFormatKind format_kind) |
| Populates a DynamicData object from a JSON string representation. More... | |
| DDS_ReturnCode_t | print (FILE *fp, int indent) const |
| Output a textual representation of this object and its contents to the given file. More... | |
| void | get_info (DDS_DynamicDataInfo &info_out) const |
| Fill in the given descriptor with information about this DDS_DynamicData. More... | |
| DDS_ReturnCode_t | bind_type (const DDS_TypeCode *type) |
| If this DDS_DynamicData object is not yet associated with a data type, set that type now to the given DDS_TypeCode. More... | |
| DDS_ReturnCode_t | unbind_type () |
| Dissociate this DDS_DynamicData object from any particular data type. More... | |
| DDS_ReturnCode_t | bind_complex_member (DDS_DynamicData &value_out, const char *member_name, DDS_DynamicDataMemberId member_id) |
| Use another DDS_DynamicData object to provide access to a complex field of this DDS_DynamicData object. More... | |
| DDS_ReturnCode_t | unbind_complex_member (DDS_DynamicData &value) |
| Tear down the association created by a DDS_DynamicData::bind_complex_member operation, committing any changes to the outer object since then. More... | |
| const DDS_TypeCode * | get_type () const |
| Get the data type, of which this DDS_DynamicData represents an instance. More... | |
| DDS_TCKind | get_type_kind () const |
| Get the kind of this object's data type. More... | |
| DDS_UnsignedLong | get_member_count () const |
| Get the number of members in the type. More... | |
| DDS_Boolean | member_exists (const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Indicates whether a member exists in this sample. More... | |
| DDS_Boolean | member_exists_in_type (const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Indicates whether a member of a particular name/ID exists in this data sample's type. More... | |
| DDS_ReturnCode_t | get_member_info (DDS_DynamicDataMemberInfo &info, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Fill in the given descriptor with information about the identified member of this DDS_DynamicData sample. More... | |
| DDS_ReturnCode_t | get_member_info_by_index (struct DDS_DynamicDataMemberInfo &info, DDS_UnsignedLong index) const |
| Fill in the given descriptor with information about the identified member of this DDS_DynamicData sample. More... | |
| DDS_ReturnCode_t | get_member_type (const DDS_TypeCode *&type_out, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get the type of the given member of this sample. More... | |
| DDS_ReturnCode_t | is_member_key (DDS_Boolean &is_key_out, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Indicates whether a given member forms part of the key of this sample's data type. More... | |
| DDS_ReturnCode_t | get_long (DDS_Long &value_out, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get the value of the given field, which is of type DDS_Long or another type implicitly convertible to it (DDS_Octet, DDS_Char, DDS_Short, DDS_UnsignedShort, or DDS_Enum). More... | |
| DDS_ReturnCode_t | get_short (DDS_Short &value_out, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get the value of the given field, which is of type DDS_Short or another type implicitly convertible to it (DDS_Octet or DDS_Char). More... | |
| DDS_ReturnCode_t | get_ulong (DDS_UnsignedLong &value_out, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get the value of the given field, which is of type DDS_UnsignedLong or another type implicitly convertible to it (DDS_Octet, DDS_Char, DDS_Short, DDS_UnsignedShort, or DDS_Enum). More... | |
| DDS_ReturnCode_t | get_ushort (DDS_UnsignedShort &value_out, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get the value of the given field, which is of type DDS_UnsignedShort or another type implicitly convertible to it (DDS_Octet or DDS_Char). More... | |
| DDS_ReturnCode_t | get_float (DDS_Float &value_out, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get the value of the given field, which is of type DDS_Float. More... | |
| DDS_ReturnCode_t | get_double (DDS_Double &value_out, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get the value of the given field, which is of type DDS_Double or another type implicitly convertible to it (DDS_Float). More... | |
| DDS_ReturnCode_t | get_boolean (DDS_Boolean &value_out, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get the value of the given field, which is of type DDS_Boolean. More... | |
| DDS_ReturnCode_t | get_char (DDS_Char &value_out, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get the value of the given field, which is of type DDS_Char. More... | |
| DDS_ReturnCode_t | get_octet (DDS_Octet &value_out, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get the value of the given field, which is of type DDS_Octet. More... | |
| DDS_ReturnCode_t | get_longlong (DDS_LongLong &value_out, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get the value of the given field, which is of type DDS_LongLong or another type implicitly convertible to it (DDS_Octet, DDS_Char, DDS_Short, DDS_UnsignedShort, DDS_Long, DDS_UnsignedLong, or DDS_Enum). More... | |
| DDS_ReturnCode_t | get_ulonglong (DDS_UnsignedLongLong &value_out, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get the value of the given field, which is of type DDS_UnsignedLongLong or another type implicitly convertible to it (DDS_Octet, DDS_Char, DDS_Short, DDS_UnsignedShort, DDS_Long, DDS_UnsignedLong, or DDS_Enum). More... | |
| DDS_ReturnCode_t | get_longdouble (DDS_LongDouble &value_out, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get the value of the given field, which is of type DDS_LongDouble or another type implicitly convertible to it (DDS_Float or DDS_Double). More... | |
| DDS_ReturnCode_t | get_wchar (DDS_Wchar &value_out, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get the value of the given field, which is of type DDS_Wchar or another type implicitly convertible to it (DDS_Char). More... | |
| DDS_ReturnCode_t | get_string (char *&value, DDS_UnsignedLong *size, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get the value of the given field, which is of type char*. More... | |
| DDS_ReturnCode_t | get_wstring (DDS_Wchar *&value, DDS_UnsignedLong *size, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get the value of the given field, which is of type DDS_Wchar*. More... | |
| DDS_ReturnCode_t | get_int8 (DDS_Int8 &value_out, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get the value of the given field, which is of type DDS_Int8. More... | |
| DDS_ReturnCode_t | get_uint8 (DDS_UInt8 &value_out, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get the value of the given field, which is of type DDS_UInt8. More... | |
| DDS_ReturnCode_t | get_complex_member (DDS_DynamicData &value_out, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the value of the given field, which is of some composed type. More... | |
| DDS_ReturnCode_t | get_long_array (DDS_Long *array, DDS_UnsignedLong *length, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given array member. The array may contain members of type DDS_Long or DDS_Enum. More... | |
| DDS_ReturnCode_t | get_short_array (DDS_Short *array, DDS_UnsignedLong *length, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given array member. More... | |
| DDS_ReturnCode_t | get_ulong_array (DDS_UnsignedLong *array, DDS_UnsignedLong *length, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given array member. The array may contain members of type DDS_UnsignedLong or DDS_Enum. More... | |
| DDS_ReturnCode_t | get_ushort_array (DDS_UnsignedShort *array, DDS_UnsignedLong *length, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given array member. More... | |
| DDS_ReturnCode_t | get_float_array (DDS_Float *array, DDS_UnsignedLong *length, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given array member. More... | |
| DDS_ReturnCode_t | get_double_array (DDS_Double *array, DDS_UnsignedLong *length, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given array member. More... | |
| DDS_ReturnCode_t | get_boolean_array (DDS_Boolean *array, DDS_UnsignedLong *length, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given array member. More... | |
| DDS_ReturnCode_t | get_char_array (DDS_Char *array, DDS_UnsignedLong *length, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given array member. More... | |
| DDS_ReturnCode_t | get_octet_array (DDS_Octet *array, DDS_UnsignedLong *length, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given array member. More... | |
| DDS_ReturnCode_t | get_longlong_array (DDS_LongLong *array, DDS_UnsignedLong *length, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given array member. More... | |
| DDS_ReturnCode_t | get_ulonglong_array (DDS_UnsignedLongLong *array, DDS_UnsignedLong *length, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given array member. More... | |
| DDS_ReturnCode_t | get_longdouble_array (DDS_LongDouble *array, DDS_UnsignedLong *length, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given array member. More... | |
| DDS_ReturnCode_t | get_wchar_array (DDS_Wchar *array, DDS_UnsignedLong *length, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given array member. More... | |
| DDS_ReturnCode_t | get_int8_array (DDS_Int8 *array, DDS_UnsignedLong *length, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given array member. More... | |
| DDS_ReturnCode_t | get_uint8_array (DDS_UInt8 *array, DDS_UnsignedLong *length, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given array member. More... | |
| DDS_ReturnCode_t | get_long_seq (DDS_LongSeq &seq, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given sequence member. More... | |
| DDS_ReturnCode_t | get_short_seq (DDS_ShortSeq &seq, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given sequence member. More... | |
| DDS_ReturnCode_t | get_ulong_seq (DDS_UnsignedLongSeq &seq, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given sequence member. More... | |
| DDS_ReturnCode_t | get_ushort_seq (DDS_UnsignedShortSeq &seq, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given sequence member. More... | |
| DDS_ReturnCode_t | get_float_seq (DDS_FloatSeq &seq, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given sequence member. More... | |
| DDS_ReturnCode_t | get_double_seq (DDS_DoubleSeq &seq, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given sequence member. More... | |
| DDS_ReturnCode_t | get_boolean_seq (DDS_BooleanSeq &seq, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given sequence member. More... | |
| DDS_ReturnCode_t | get_char_seq (DDS_CharSeq &seq, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given sequence member. More... | |
| DDS_ReturnCode_t | get_octet_seq (DDS_OctetSeq &seq, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given sequence member. More... | |
| DDS_ReturnCode_t | get_longlong_seq (DDS_LongLongSeq &seq, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given sequence member. More... | |
| DDS_ReturnCode_t | get_ulonglong_seq (DDS_UnsignedLongLongSeq &seq, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given sequence member. More... | |
| DDS_ReturnCode_t | get_longdouble_seq (DDS_LongDoubleSeq &seq, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given sequence member. More... | |
| DDS_ReturnCode_t | get_wchar_seq (DDS_WcharSeq &seq, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given sequence member. More... | |
| DDS_ReturnCode_t | get_int8_seq (DDS_Int8Seq &seq, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given sequence member. More... | |
| DDS_ReturnCode_t | get_uint8_seq (DDS_UInt8Seq &seq, const char *member_name, DDS_DynamicDataMemberId member_id) const |
| Get a copy of the given sequence member. More... | |
| DDS_ReturnCode_t | set_long (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_Long value) |
| Set the value of the given field, which is of type DDS_Long. More... | |
| DDS_ReturnCode_t | set_short (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_Short value) |
| Set the value of the given field, which is of type DDS_Short. More... | |
| DDS_ReturnCode_t | set_ulong (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_UnsignedLong value) |
| Set the value of the given field, which is of type DDS_UnsignedLong. More... | |
| DDS_ReturnCode_t | set_ushort (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_UnsignedShort value) |
| Set the value of the given field, which is of type DDS_UnsignedShort. More... | |
| DDS_ReturnCode_t | set_float (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_Float value) |
| Set the value of the given field, which is of type DDS_Float. More... | |
| DDS_ReturnCode_t | set_double (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_Double value) |
| Set the value of the given field, which is of type DDS_Double. More... | |
| DDS_ReturnCode_t | set_boolean (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_Boolean value) |
| Set the value of the given field, which is of type DDS_Boolean. More... | |
| DDS_ReturnCode_t | set_char (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_Char value) |
| Set the value of the given field, which is of type DDS_Char. More... | |
| DDS_ReturnCode_t | set_octet (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_Octet value) |
| Set the value of the given field, which is of type DDS_Octet. More... | |
| DDS_ReturnCode_t | set_longlong (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_LongLong value) |
| Set the value of the given field, which is of type DDS_LongLong. More... | |
| DDS_ReturnCode_t | set_ulonglong (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_UnsignedLongLong value) |
| Set the value of the given field, which is of type DDS_UnsignedLongLong. More... | |
| DDS_ReturnCode_t | set_longdouble (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_LongDouble value) |
| Set the value of the given field, which is of type DDS_LongDouble. More... | |
| DDS_ReturnCode_t | set_wchar (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_Wchar value) |
| Set the value of the given field, which is of type DDS_Wchar. More... | |
| DDS_ReturnCode_t | set_string (const char *member_name, DDS_DynamicDataMemberId member_id, const char *value) |
| Set the value of the given field of type char*. More... | |
| DDS_ReturnCode_t | set_wstring (const char *member_name, DDS_DynamicDataMemberId member_id, const DDS_Wchar *value) |
| Set the value of the given field of type DDS_Wchar*. More... | |
| DDS_ReturnCode_t | set_int8 (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_Int8 value) |
| Set the value of the given field, which is of type DDS_Int8. More... | |
| DDS_ReturnCode_t | set_uint8 (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_UInt8 value) |
| Set the value of the given field, which is of type DDS_UInt8. More... | |
| DDS_ReturnCode_t | set_complex_member (const char *member_name, DDS_DynamicDataMemberId member_id, const DDS_DynamicData &value) |
| Copy the state of the given DDS_DynamicData object into a member of this object. More... | |
| DDS_ReturnCode_t | set_long_array (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_UnsignedLong length, const DDS_Long *array) |
| Set the contents of the given array member. The array may contain members of type DDS_Long or DDS_Enum. More... | |
| DDS_ReturnCode_t | set_short_array (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_UnsignedLong length, const DDS_Short *array) |
| Set the contents of the given array member. More... | |
| DDS_ReturnCode_t | set_ulong_array (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_UnsignedLong length, const DDS_UnsignedLong *array) |
| Set the contents of the given array member. The array may contain members of type DDS_UnsignedLong or DDS_Enum. More... | |
| DDS_ReturnCode_t | set_ushort_array (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_UnsignedLong length, const DDS_UnsignedShort *array) |
| Set the contents of the given array member. More... | |
| DDS_ReturnCode_t | set_float_array (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_UnsignedLong length, const DDS_Float *array) |
| Set the contents of the given array member. More... | |
| DDS_ReturnCode_t | set_double_array (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_UnsignedLong length, const DDS_Double *array) |
| Set the contents of the given array member. More... | |
| DDS_ReturnCode_t | set_boolean_array (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_UnsignedLong length, const DDS_Boolean *array) |
| Set the contents of the given array member. More... | |
| DDS_ReturnCode_t | set_char_array (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_UnsignedLong length, const DDS_Char *array) |
| Set the contents of the given array member. More... | |
| DDS_ReturnCode_t | set_octet_array (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_UnsignedLong length, const DDS_Octet *array) |
| Set the contents of the given array member. More... | |
| DDS_ReturnCode_t | set_longlong_array (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_UnsignedLong length, const DDS_LongLong *array) |
| Set the contents of the given array member. More... | |
| DDS_ReturnCode_t | set_ulonglong_array (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_UnsignedLong length, const DDS_UnsignedLongLong *array) |
| Set the contents of the given array member. More... | |
| DDS_ReturnCode_t | set_longdouble_array (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_UnsignedLong length, const DDS_LongDouble *array) |
| Set the contents of the given array member. More... | |
| DDS_ReturnCode_t | set_wchar_array (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_UnsignedLong length, const DDS_Wchar *array) |
| Set the contents of the given array member. More... | |
| DDS_ReturnCode_t | set_int8_array (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_UnsignedLong length, const DDS_Int8 *array) |
| Set the contents of the given array member. More... | |
| DDS_ReturnCode_t | set_uint8_array (const char *member_name, DDS_DynamicDataMemberId member_id, DDS_UnsignedLong length, const DDS_UInt8 *array) |
| Set the contents of the given array member. More... | |
| DDS_ReturnCode_t | set_long_seq (const char *member_name, DDS_DynamicDataMemberId member_id, const DDS_LongSeq &value) |
| Set the contents of the given sequence member. More... | |
| DDS_ReturnCode_t | set_short_seq (const char *member_name, DDS_DynamicDataMemberId member_id, const DDS_ShortSeq &value) |
| Set the contents of the given sequence member. More... | |
| DDS_ReturnCode_t | set_ulong_seq (const char *member_name, DDS_DynamicDataMemberId member_id, const DDS_UnsignedLongSeq &value) |
| Set the contents of the given sequence member. More... | |
| DDS_ReturnCode_t | set_ushort_seq (const char *member_name, DDS_DynamicDataMemberId member_id, const DDS_UnsignedShortSeq &value) |
| Set the contents of the given sequence member. More... | |
| DDS_ReturnCode_t | set_float_seq (const char *member_name, DDS_DynamicDataMemberId member_id, const DDS_FloatSeq &value) |
| Set the contents of the given sequence member. More... | |
| DDS_ReturnCode_t | set_double_seq (const char *member_name, DDS_DynamicDataMemberId member_id, const DDS_DoubleSeq &value) |
| Set the contents of the given sequence member. More... | |
| DDS_ReturnCode_t | set_boolean_seq (const char *member_name, DDS_DynamicDataMemberId member_id, const DDS_BooleanSeq &value) |
| Set the contents of the given sequence member. More... | |
| DDS_ReturnCode_t | set_char_seq (const char *member_name, DDS_DynamicDataMemberId member_id, const DDS_CharSeq &value) |
| Set the contents of the given sequence member. More... | |
| DDS_ReturnCode_t | set_octet_seq (const char *member_name, DDS_DynamicDataMemberId member_id, const DDS_OctetSeq &value) |
| Set the contents of the given sequence member. More... | |
| DDS_ReturnCode_t | set_longlong_seq (const char *member_name, DDS_DynamicDataMemberId member_id, const DDS_LongLongSeq &value) |
| Set the contents of the given sequence member. More... | |
| DDS_ReturnCode_t | set_ulonglong_seq (const char *member_name, DDS_DynamicDataMemberId member_id, const DDS_UnsignedLongLongSeq &value) |
| Set the contents of the given sequence member. More... | |
| DDS_ReturnCode_t | set_longdouble_seq (const char *member_name, DDS_DynamicDataMemberId member_id, const DDS_LongDoubleSeq &value) |
| Set the contents of the given sequence member. More... | |
| DDS_ReturnCode_t | set_wchar_seq (const char *member_name, DDS_DynamicDataMemberId member_id, const DDS_WcharSeq &value) |
| Set the contents of the given sequence member. More... | |
| DDS_ReturnCode_t | set_int8_seq (const char *member_name, DDS_DynamicDataMemberId member_id, const DDS_Int8Seq &value) |
| Set the contents of the given sequence member. More... | |
| DDS_ReturnCode_t | set_uint8_seq (const char *member_name, DDS_DynamicDataMemberId member_id, const DDS_UInt8Seq &value) |
| Set the contents of the given sequence member. More... | |
| ~DDS_DynamicData () | |
| Finalize and deallocate this DDS_DynamicData sample. More... | |
A sample of any complex data type, which can be inspected and manipulated reflectively.
Objects of type DDS_DynamicData represent corresponding objects of the type identified by their DDS_TypeCode. Because the definition of these types may not have existed at compile time on the system on which the application is running, you will interact with the data using an API of reflective getters and setters.
For example, if you had access to your data types at compile time, you could do this:
Instead, you will do something like this:
DDS_DynamicData objects can represent any complex data type, including those of type kinds DDS_TK_ARRAY, DDS_TK_SEQUENCE, DDS_TK_STRUCT, DDS_TK_UNION, and DDS_TK_VALUE. They cannot represent objects of basic types (e.g., integers and strings). Since those type definitions always exist on every system, you can examine their objects directly.
The members of a data type can be identified in one of two ways: by their name or by their numeric ID. The former is often more transparent to human users; the latter is typically faster.
You define the name and ID of a type member when you add that member to that type. If you define your type in IDL or XML, the name will be the field name that appears in the type definition; the ID will be the one-based index of the field in declaration order. For example, in the following IDL structure, the ID of theLong is 2.
For unions (DDS_TK_UNION), the ID of a member is the discriminator value corresponding to that member. To access the current discriminator of a union, you must use the DDS_DynamicData::get_member_info_by_index operation on the DynamicData object using an index value of 0. This operation fills in a DDS_DynamicDataMemberInfo, then you can access the populated DDS_DynamicDataMemberInfo::member_id field to get the current discriminator. Once you know the value of the discriminator, you can use it in the proper get/set_xxx() operations to access and set the member's value. Here is an example of accessing the discriminator:
It is possible to refer to a nested member in a type without first having to use the DDS_DynamicData::bind_complex_member API. You can do this by using a hierarchical name. A hierarchical member name is a concatenation of member names separated by the '.' character. The hierarchical name describes the complete path from a top-level type to the nested member. For example, in the above type, any DynamicData API that receives a member name will accept "theNestedType.theChar" to refer to the char member in MyNestedType:
In order to access the value of theChar without using a hierarchical name, you would have to first bind to theNestedType and then get the value:
As you can see, using a hierarchical member name removes the need to call the DDS_DynamicData::bind_complex_member and DDS_DynamicData::unbind_complex_member APIs, and allows for access to nested members at any depth directly from the top-level type.
The member name can also contain indexes to address members in arrays and sequences. For example, to set the third member in the array theOctetArray, you can pass in "theNestedType.theOctetArray[2]" as the member name to the DDS_DynamicData::set_octet API. The index values when used as part of the member name are 0-based.
For multi-dimensional arrays, the indexes for each dimension should be listed comma-separated in between brackets. For example, to address a member of theMultidimensionalArray, the member name should be something like "theNestedType.theMultidimensionalArray[3,2,5]".
In complex types with arrays and sequences that contain other arrays and sequences, the hierarchical name may include multiple index values, one right after another. For example, in MyNestedType, myArrayOfSeq is an array of sequences. In order to set the third member of the sequence in the fourth member of the array, the member name would be "myNestedType.myArrayOfSeq[3][2]".
The "members" of array and sequence types, unlike those of structure and union types, don't have names or explicit member IDs. However, they may nevertheless be accessed by "ID": the ID is one more than the index. (The first element has ID 1, the second 2, etc.)
Multi-dimensional arrays are effectively flattened by this pattern. For example, for an array theArray[4][5], accessing ID 7 is equivalent to index 6, or the second element of the second group of 5.
To determine the length of a collection-typed member of a structure or union, you have two choices:
The Dynamic Data API is large when measured by the number of methods it contains. But each method falls into one of a very small number of categories. You will find it easier to navigate this documentation if you understand these categories.
Managing the lifecycle of DDS_DynamicData objects is simple. You have two choices:
You can also copy DDS_DynamicData objects:
You can test them for equality:
And you can print their contents:
Most methods get or set the value of some field. These methods are named according to the type of the field they access.
The names of types vary across languages. The programming API for each language reflects that programming language. However, if your chosen language does not use the same names as the language that you used to define your types (e.g., IDL), or if you need to interoperate among programming languages, you will need to understand these differences. They are explained the following table. (Note: for modern C++, see the RTI Connext Modern C++ API reference.)
| Type | IDL | C, Traditional C++ | Java | Ada |
|---|---|---|---|---|
| 16-bit integer | short | DDS_Short | short | Standard.DDS.Short |
| 32-bit integer | long | DDS_Long | int | Standard.DDS.Long |
| 64-bit integer | long long | DDS_LongLong | long | Standard.DDS.Long_Long |
| Unsigned 16-bit integer | unsigned short | DDS_UnsignedShort | short | Standard.DDS.Unsigned_Short |
| Unsigned 32-bit integer | unsigned long | DDS_UnsignedLong | int | Standard.DDS.Long |
| Unsigned 64-bit integer | unsigned long long | DDS_UnsignedLongLong | long | Standard.DDS.Unsigned_Long_Long |
| float | float | DDS_Float | float | Standard.DDS.Float |
| double | double | DDS_Double | double | Standard.DDS.Double |
| long double | long double | DDS_LongDouble | N/A (see CORE-14091 known issue) | Standard.DDS.Long_Double |
| character | char | DDS_Char | char | Standard.DDS.Char |
| wide character | wchar | DDS_Wchar | char | Standard.DDS.Wchar |
| octet | octet | DDS_Octet | byte | Standard.DDS.Octet |
| boolean | boolean | DDS_Boolean | boolean | Standard.DDS.Boolean |
| string | string | DDS_Char* | String | Standard.DDS.String |
| wstring | wstring | DDS_Wchar* | String | Standard.DDS.Wide_String |
When working with a DDS_DynamicData object representing an array or sequence, calling one of the "get" methods below for an index that is out of bounds will result in DDS_RETCODE_NO_DATA. Calling "set" for an index that is past the end of a sequence will cause that sequence to automatically lengthen (filling with default contents).
When working with a DDS_DynamicData object whose type contains optional members, calling one of the "get" methods below on an unset optional member or any member that is part of an unset complex optional member will result in DDS_RETCODE_NO_DATA.
| Get | Set |
|---|---|
| DDS_DynamicData::get_complex_member | DDS_DynamicData::set_complex_member |
In addition to getting or setting a field, you can "clear" its value; that is, set it to a default zero value.
Not all components of your application will have static knowledge of all of the fields of your type. Sometimes, you will want to query meta-data about the fields that appear in a given data sample.
Sometimes, you may want to change the association between a data object and its type. This is not something you can do with a typical object, but with DDS_DynamicData objects, it is a powerful capability. It allows you to, for example, examine nested structures without copying them by using a "bound" DDS_DynamicData object as a view into an enclosing DDS_DynamicData object.
By default, a DynamicData object stores its content in an implementation-specific representation that allows getting and setting its fields by name or ID.
When a sample is received, the CDR-formatted data is deserialized into this buffer.
When a sample is published, the data is serialized into CDR from the buffer and sent to the network.
However, there are scenarios where DynamicData is used for purposes that don't involve manipulating the object's content directly. Two common examples are:
RTI provides dedicated services, namely RTI Recording Service and RTI Routing Service, to address these use cases. However, in certain situations, you might be unable to utilize these services.
For scenarios where inspecting or modifying the content of DynamicData fields is unnecessary, DynamicData offers a high-performance method to configure a DataReader to avoid deserializing incoming samples into the internal representation. Additionally, the DynamicData API provides a method to link a CDR-formatted serialization buffer directly with a DynamicData object, facilitating direct transmission without converting the data from the internal representation to CDR.
To skip the deserialization of a DynamicData object on the DataReader side, you can set the field DDS_DynamicDataTypeSerializationProperty_t::skip_deserialization to DDS_BOOLEAN_TRUE.
Once a sample is received, you can access the serialized buffer directly by using the DDS_DynamicData::get_cdr_buffer. This buffer can be stored in persistent storage in a Recording/Replaying use case.
To link a serialization buffer directly with a DynamicData object, you can use the DDS_DynamicData::set_cdr_buffer method. This method allows you to set the buffer that will be used to serialize the DynamicData object when it is published.
| DDS_DynamicData::DDS_DynamicData | ( | const DDS_TypeCode * | type, |
| const DDS_DynamicDataProperty_t & | property | ||
| ) |
The constructor for new DDS_DynamicData objects.
The type parameter may be NULL. In that case, this DDS_DynamicData must be bound with DDS_DynamicData::bind_type or DDS_DynamicData::bind_complex_member before it can be used.
If the DDS_TypeCode is not NULL, the newly constructed DDS_DynamicData object will retain a reference to it. It is not safe to delete the DDS_TypeCode until all samples that use it have themselves been deleted.
In most cases, it is not necessary to call this constructor explicitly. Instead, use DDSDynamicDataTypeSupport::create_data, and the DDS_TypeCode and properties will be specified for you. Using the factory method also ensures that the memory management contract documented above is followed correctly, because the DDSDynamicDataTypeSupport object maintains the DDS_TypeCode used by the samples it creates.
However you create a DDS_DynamicData object, you must delete it when you are finished with it. If you choose to use this constructor, delete the object with the destructor: DDS_DynamicData::~DDS_DynamicData.
NOTE that RTI Connext does not explicitly generate any exceptions in this constructor, because C++ exception support is not consistent across all platforms on which RTI Connext runs. Therefore, to check whether construction succeeded, you must use the DDS_DynamicData::is_valid method. Alternatively, you can create an DDS_DynamicData object with DDSDynamicDataTypeSupport::create_data, which returns NULL on failure, eliminating the need to call DDS_DynamicData::is_valid.
| type | <<in>> The type of which the new object will represent an object. |
| property | <<in>> Properties that configure the behavior of the new object. Most users can simply use DDS_DYNAMIC_DATA_PROPERTY_DEFAULT. |
| DDS_DynamicData::~DDS_DynamicData | ( | ) |
Finalize and deallocate this DDS_DynamicData sample.
| DDS_Boolean DDS_DynamicData::is_valid | ( | ) | const |
Indicates whether the object was constructed properly.
This method returns DDS_BOOLEAN_TRUE if the constructor succeeded; it returns DDS_BOOLEAN_FALSE if the constructor failed for any reason, which should also have resulted in a log message. It is only necessary to call this method if you created the DDS_DynamicData object using the constructor, DDS_DynamicData::DDS_DynamicData(const DDS_TypeCode *, const DDS_DynamicDataProperty_t &).
Possible failure reasons include passing an invalid type or invalid properties to the constructor.
This method is necessary because C++ exception support is not consistent across all of the platforms on which RTI Connext runs. Therefore, the implementation does not throw any exceptions in the constructor.
| DDS_ReturnCode_t DDS_DynamicData::copy | ( | const DDS_DynamicData & | src | ) |
Deeply copy from the given object to this object.
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| DDS_Boolean DDS_DynamicData::equal | ( | const DDS_DynamicData & | other | ) | const |
Indicate whether the contents of another DDS_DynamicData sample are the same as those of this one.
This operation compares the data and type of existing members.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_BOOLEAN_FALSE. See DDS_DynamicData::is_cdr for more information.
| DDS_DynamicData & DDS_DynamicData::operator= | ( | const DDS_DynamicData & | src | ) |
| DDS_Boolean DDS_DynamicData::operator== | ( | const DDS_DynamicData & | other | ) | const |
Indicate whether the contents of another DDS_DynamicData sample are the same as those of this one.
This operation compares the data and type of existing members.
| DDS_ReturnCode_t DDS_DynamicData::clear_all_members | ( | ) |
Clear the contents of all data members of this object.
| One | of the Standard Return Codes |
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| DDS_ReturnCode_t DDS_DynamicData::clear_optional_member | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id | ||
| ) |
Clear the contents of a single optional data member of this object.
This method is only applicable to optional members. Members of unions, sequences, and arrays are not considered optional.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member (to look up the member by name), or NULL (to look up the member by its ID). |
| member_id | <<in>> The ID of the member (to look up the member by its ID), or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED (to look up the member by name). See Member Names and IDs. |
| One | of the Standard Return Codes |
| DDS_ReturnCode_t DDS_DynamicData::clear_member | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id | ||
| ) |
Clear the contents of a single data member of this object.
This method can be used to clear both optional and non-optional members.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member to clear or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member to clear or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes |
| DDS_Boolean DDS_DynamicData::is_cdr | ( | ) | const |
Determine if a DynamicData object is using CDR as its data representation.
This method returns DDS_BOOLEAN_TRUE if the DynamicData object is using CDR as its data representation, and DDS_BOOLEAN_FALSE otherwise.
When the DynamicData object is using CDR as its data representation, many of the DynamicData APIs cannot be used. The DynamicData object will use CDR as its data representation when DDS_DynamicDataTypeSerializationProperty_t::skip_deserialization has been set to DDS_BOOLEAN_TRUE or DDS_DynamicData::set_cdr_buffer has been used to associate a CDR buffer with the DynamicData object. See each functions's documentation for whether or not the function is supported for DynamicData objects in CDR format.
| const char * DDS_DynamicData::get_cdr_buffer | ( | DDS_UnsignedLong & | length | ) | const |
Get the CDR buffer associated with a DynamicData object.
This method returns the CDR buffer associated with a DynamicData object.
If the DynamicData object is not using CDR as its data representation, this method will return NULL and log an error.
To configure a DynamicData DataReader to not deserialize the incoming samples and keep the data in CDR format, you must set the configuration option DDS_DynamicDataTypeSerializationProperty_t::skip_deserialization to DDS_BOOLEAN_TRUE.
| length | <<out>> CDR buffer length. |
| One | of the Standard Return Codes |
| DDS_ReturnCode_t DDS_DynamicData::set_cdr_buffer | ( | const char * | buffer, |
| DDS_UnsignedLong | length | ||
| ) |
Associate a CDR buffer with a DynamicData object.
This method associates a CDR buffer with a DynamicData object.
In this context, 'associates' means that the DynamicData object will use the input buffer to store its value. Additionally, if the buffer is loaned, the application is responsible for keeping it alive.
If the DynamicData is owned by the reader, this method will return an error.
| One | of the Standard Return Codes |
| DDS_ReturnCode_t DDS_DynamicData::from_cdr_buffer | ( | const char * | buffer, |
| unsigned int | length | ||
| ) |
Deserializes a DynamicData object from a buffer of octets.
This method deserializes a DynamicData object from a CDR buffer of octets.
The content of the buffer generated by the method DDS_DynamicData::to_cdr_buffer can be provided to this method to get the DynamicData object back.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| buffer | <<in>>. Deserialization buffer. |
| length | <<in>>. Length of the serialized representation of the DynamicData object in the buffer. |
| One | of the Standard Return Codes |
| DDS_ReturnCode_t DDS_DynamicData::to_cdr_buffer | ( | char * | buffer, |
| unsigned int & | length | ||
| ) |
Serializes a DynamicData object into a CDR buffer of octets.
This method serializes a DynamicData object into a buffer of octets, using CDR as the data representation. Calling this method is equivalent to calling DDS_DynamicData::to_cdr_buffer_ex with DDS_AUTO_DATA_REPRESENTATION as the representation.
The input buffer must be large enough to store the serialized representation of the DynamicData object. Otherwise, the method will return an error code.
To determine the minimum size of the input buffer, you must call this method with the buffer set to NULL.
| buffer | <<out>>. Serialization buffer. |
| length | <<inout>>. When the buffer is set to NULL, after the method executes, length will contain the required size for the serialization buffer. When buffer is not NULL, length must contain the size of the input buffer when the method is invoked. After the method executes, length will be updated to contain the actual size of the serialized content, which may be smaller than the size obtained when buffer is set to NULL. |
| One | of the Standard Return Codes |
| DDS_ReturnCode_t DDS_DynamicData::to_cdr_buffer_ex | ( | char * | buffer, |
| unsigned int & | length, | ||
| DDS_DataRepresentationId_t | representation | ||
| ) |
Serializes a DynamicData object into a buffer of octets.
This method serializes a DynamicData object into a buffer of octets using the input data representation. See DDS_DynamicData::to_cdr_buffer for details.
| DDS_ReturnCode_t DDS_DynamicData::to_string | ( | char * | str, |
| DDS_UnsignedLong & | str_size, | ||
| const DDS_PrintFormatProperty & | property | ||
| ) |
Get a string representation of a DynamicData object.
This method takes a dynamic data sample and creates a string representation of the data.
The input character buffer must be big enough to store the string representation of the sample. Otherwise, the method will return an error.
To determine the minimum size of the input character buffer, the user must call this method with the buffer set to NULL.
If the size of the output string is longer than the size of an unsigned 32-bit integer, this operation will fail with DDS_RETCODE_OUT_OF_RESOURCES.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| str | <<out>>. Output string representing the dynamic data sample. |
| str_size | <<inout>>. When str is set to NULL, after the method executes, str_size will contain a buffer size big enough to hold the string representation of the data. When str is not NULL, str_size must contain the size of the input buffer when the method is invoked. If the size of the input buffer is too small, after the method executes, str_size will be updated to contain the required size of the string content and the method will return DDS_RETCODE_OUT_OF_RESOURCES. |
| property | <<in>>. Properties describing what the format of the output string should be. Cannot be NULL. |
| One | of the Standard Return Codes, DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::from_string | ( | const char * | str, |
| DDS_PrintFormatKind | format_kind | ||
| ) |
Populates a DynamicData object from a JSON string representation.
This method takes a JSON string representing a data sample of this type, and uses it to populate this DynamicData.
| str | <<in>>. The JSON string representation |
| format_kind | <<in>>. Must be set to DDS_JSON_PRINT_FORMAT, the only currently supported format. |
| One | of the Standard Return Codes, DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::print | ( | FILE * | fp, |
| int | indent | ||
| ) | const |
Output a textual representation of this object and its contents to the given file.
This method is equivalent to DDSDynamicDataTypeSupport::print_data.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| fp | <<in>> The file into which the object should be printed (to print to standard output, provide the stream pointer 'stdout') |
| indent | <<in>> The output of this method will be pretty-printed. This argument indicates the amount of initial indentation of the output. |
| One | of the Standard Return Codes |
| void DDS_DynamicData::get_info | ( | DDS_DynamicDataInfo & | info_out | ) | const |
Fill in the given descriptor with information about this DDS_DynamicData.
This API is not supported when the DynamicData object is in CDR format and will print an error log. See DDS_DynamicData::is_cdr for more information.
| info_out | <<out>> The descriptor object whose contents will be overwritten by this operation. |
| DDS_ReturnCode_t DDS_DynamicData::bind_type | ( | const DDS_TypeCode * | type | ) |
If this DDS_DynamicData object is not yet associated with a data type, set that type now to the given DDS_TypeCode.
This advanced operation allows you to reuse a single DDS_DynamicData object with multiple data types.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
Note that the DDS_DynamicData object will retain a reference to the DDS_TypeCode object you provide. It is not safe to delete the DDS_TypeCode until after it is unbound.
| type | <<in>> The type to associate with this DDS_DynamicData object. |
| One | of the Standard Return Codes |
| DDS_ReturnCode_t DDS_DynamicData::unbind_type | ( | ) |
Dissociate this DDS_DynamicData object from any particular data type.
This step is necessary before the object can be associated with a new data type.
This operation clears all members as a side effect.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| One | of the Standard Return Codes |
| DDS_ReturnCode_t DDS_DynamicData::bind_complex_member | ( | DDS_DynamicData & | value_out, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) |
Use another DDS_DynamicData object to provide access to a complex field of this DDS_DynamicData object.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
For example, consider the following data types:
Suppose you have an instance of MyOuterType, and you would like to examine the contents of its member complexMember. To do this, you must bind another DDS_DynamicData object to that member. This operation will bind the type code of the member to the provided DDS_DynamicData object and perform additional initialization.
The following example demonstrates the usage pattern. Note that error handling has been omitted for brevity.
This operation is only permitted when the object toBeBound (named as in the example above) is not currently associated with any type, including already being bound to another member. You can see in the example that this object is created directly with the constructer and is not provided with a DDS_TypeCode.
Only a single member of a given DDS_DynamicData object may be bound at one time – however, members of members may be recursively bound to any depth. Furthermore, while the outer object has a bound member, it may only be modified through that bound member. That is, after calling this member, all "set" operations on the outer object will be disabled until DDS_DynamicData::unbind_complex_member has been called. Furthermore, any bound member must be unbound before a sample can be written or deleted.
This method is logically related to DDS_DynamicData::get_complex_member in that both allow you to examine the state of nested objects. They are different in an important way: this method provides a view into an outer object, such that any change made to the inner object will be reflected in the outer. But the DDS_DynamicData::get_complex_member operation copies the state of the nested object; changes to it will not be reflected in the source object.
Note that you can bind to a member of a sequence at an index that is past the current length of that sequence. In that case, this method behaves like a "set" method: it automatically lengthens the sequence (filling in default elements) to allow the bind to take place. See Getters and Setters.
| value_out | <<out>> The object that you wish to bind to the field. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes |
| DDS_ReturnCode_t DDS_DynamicData::unbind_complex_member | ( | DDS_DynamicData & | value | ) |
Tear down the association created by a DDS_DynamicData::bind_complex_member operation, committing any changes to the outer object since then.
Some changes to the outer object will not be observable until after you have performed this operation.
If you have called DDS_DynamicData::bind_complex_member on a data sample, you must unbind before writing or deleting the sample.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| value | <<in>> The same object you passed to DDS_DynamicData::bind_complex_member. This argument is used for error checking purposes. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| const DDS_TypeCode * DDS_DynamicData::get_type | ( | ) | const |
Get the data type, of which this DDS_DynamicData represents an instance.
| DDS_TCKind DDS_DynamicData::get_type_kind | ( | ) | const |
Get the kind of this object's data type.
This is a convenience method. It's equivalent to calling DDS_DynamicData::get_type followed by DDS_TypeCode::kind.
| DDS_UnsignedLong DDS_DynamicData::get_member_count | ( | ) | const |
Get the number of members in the type.
For objects of type kind DDS_TK_ARRAY or DDS_TK_SEQUENCE, this method returns the number of elements in the collection.
For objects of type kind DDS_TK_STRUCT or DDS_TK_VALUE, it returns the number of fields in the type.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| DDS_Boolean DDS_DynamicData::member_exists | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Indicates whether a member exists in this sample.
You only need to specify the name OR the ID (not both).
If the member doesn't exist in the type, this function returns false. In all other cases, it provides the same result as DDS_DynamicDataMemberInfo::member_exists, which is retrieved with idref_DynamicDataMember_get_member_info.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_BOOLEAN_FALSE. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| DDS_Boolean DDS_DynamicData::member_exists_in_type | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Indicates whether a member of a particular name/ID exists in this data sample's type.
You only need to specify the name OR the ID (not both).
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_BOOLEAN_FALSE. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| DDS_ReturnCode_t DDS_DynamicData::get_member_info | ( | DDS_DynamicDataMemberInfo & | info, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Fill in the given descriptor with information about the identified member of this DDS_DynamicData sample.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
This operation is valid for objects of DDS_TCKind DDS_TK_ARRAY, DDS_TK_SEQUENCE, DDS_TK_STRUCT, DDS_TK_UNION, and DDS_TK_VALUE.
When this sample represents a struct, a value type, or a union:
When this sample represents a sequence and member_id is the 1-based element index:
member_id is greater than the sequence's maximum length, this function fails with DDS_RETCODE_NO_DATA. member_id is greater than the sequence's current length but smaller than or equal to its maximum length, this function returns an object with DDS_DynamicDataMemberInfo::member_exists set to false. member_id is smaller than or equal to the current length, DDS_DynamicDataMemberInfo::member_exists is true. When this sample represents an array, this function either fails with with DDS_RETCODE_NO_DATA when the index is out of bounds or else returns an object with DDS_DynamicDataMemberInfo::member_exists set to true.
| info | <<out>> The descriptor object whose contents will be overwritten by this operations. |
| member_name | <<in>> The name of the member for which to get the info or NULL to look up the member by its ID. Only one of the name and the ID may be unspecified. |
| member_id | <<in>> The ID of the member for which to get the info, or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes |
| DDS_ReturnCode_t DDS_DynamicData::get_member_info_by_index | ( | struct DDS_DynamicDataMemberInfo & | info, |
| DDS_UnsignedLong | index | ||
| ) | const |
Fill in the given descriptor with information about the identified member of this DDS_DynamicData sample.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
This operation is valid for objects of DDS_TCKind DDS_TK_ARRAY, DDS_TK_SEQUENCE, DDS_TK_STRUCT, DDS_TK_VALUE, and DDS_TK_UNION.
| info | <<out>> The descriptor object whose contents will be overwritten by this operations. |
| index | <<in>> The zero-base of the member for which to get the info. |
| One | of the Standard Return Codes |
| DDS_ReturnCode_t DDS_DynamicData::get_member_type | ( | const DDS_TypeCode *& | type_out, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get the type of the given member of this sample.
The member can be looked up either by name or by ID.
This operation is valid for objects of DDS_TCKind DDS_TK_ARRAY, DDS_TK_SEQUENCE, DDS_TK_STRUCT, and DDS_TK_VALUE. For type kinds DDS_TK_ARRAY and DDS_TK_SEQUENCE, the index into the collection is taken to be one less than the ID, if specified. If this index is valid, this operation will return the content type of this collection.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| type_out | <<out>> If this method returned success, this argument refers to the found member's type. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes |
| DDS_ReturnCode_t DDS_DynamicData::is_member_key | ( | DDS_Boolean & | is_key_out, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Indicates whether a given member forms part of the key of this sample's data type.
This operation is only valid for samples of types of kind DDS_TK_STRUCT or DDS_TK_VALUE.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| is_key_out | <<out>> If this method returned success, this argument indicates whether the indicated member is part of the key. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes |
| DDS_ReturnCode_t DDS_DynamicData::get_long | ( | DDS_Long & | value_out, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get the value of the given field, which is of type DDS_Long or another type implicitly convertible to it (DDS_Octet, DDS_Char, DDS_Short, DDS_UnsignedShort, or DDS_Enum).
The member may be specified by name or by ID.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| value_out | <<out>> If this method returned success, this argument will contain the value of the indicated member. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_short | ( | DDS_Short & | value_out, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get the value of the given field, which is of type DDS_Short or another type implicitly convertible to it (DDS_Octet or DDS_Char).
The member may be specified by name or by ID.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| value_out | <<out>> If this method returned success, this argument will contain the value of the indicated member. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_ulong | ( | DDS_UnsignedLong & | value_out, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get the value of the given field, which is of type DDS_UnsignedLong or another type implicitly convertible to it (DDS_Octet, DDS_Char, DDS_Short, DDS_UnsignedShort, or DDS_Enum).
The member may be specified by name or by ID.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| value_out | <<out>> If this method returned success, this argument will contain the value of the indicated member. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_ushort | ( | DDS_UnsignedShort & | value_out, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get the value of the given field, which is of type DDS_UnsignedShort or another type implicitly convertible to it (DDS_Octet or DDS_Char).
The member may be specified by name or by ID.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| value_out | <<out>> If this method returned success, this argument will contain the value of the indicated member. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_float | ( | DDS_Float & | value_out, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get the value of the given field, which is of type DDS_Float.
The member may be specified by name or by ID.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| value_out | <<out>> If this method returned success, this argument will contain the value of the indicated member. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_double | ( | DDS_Double & | value_out, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get the value of the given field, which is of type DDS_Double or another type implicitly convertible to it (DDS_Float).
The member may be specified by name or by ID.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| value_out | <<out>> If this method returned success, this argument will contain the value of the indicated member. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_boolean | ( | DDS_Boolean & | value_out, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get the value of the given field, which is of type DDS_Boolean.
The member may be specified by name or by ID.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| value_out | <<out>> If this method returned success, this argument will contain the value of the indicated member. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_char | ( | DDS_Char & | value_out, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get the value of the given field, which is of type DDS_Char.
The member may be specified by name or by ID.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| value_out | <<out>> If this method returned success, this argument will contain the value of the indicated member. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_octet | ( | DDS_Octet & | value_out, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get the value of the given field, which is of type DDS_Octet.
The member may be specified by name or by ID.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| value_out | <<out>> If this method returned success, this argument will contain the value of the indicated member. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_longlong | ( | DDS_LongLong & | value_out, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get the value of the given field, which is of type DDS_LongLong or another type implicitly convertible to it (DDS_Octet, DDS_Char, DDS_Short, DDS_UnsignedShort, DDS_Long, DDS_UnsignedLong, or DDS_Enum).
The member may be specified by name or by ID.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| value_out | <<out>> If this method returned success, this argument will contain the value of the indicated member. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_ulonglong | ( | DDS_UnsignedLongLong & | value_out, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get the value of the given field, which is of type DDS_UnsignedLongLong or another type implicitly convertible to it (DDS_Octet, DDS_Char, DDS_Short, DDS_UnsignedShort, DDS_Long, DDS_UnsignedLong, or DDS_Enum).
The member may be specified by name or by ID.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| value_out | <<out>> If this method returned success, this argument will contain the value of the indicated member. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_longdouble | ( | DDS_LongDouble & | value_out, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get the value of the given field, which is of type DDS_LongDouble or another type implicitly convertible to it (DDS_Float or DDS_Double).
The member may be specified by name or by ID.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| value_out | <<out>> If this method returned success, this argument will contain the value of the indicated member. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_wchar | ( | DDS_Wchar & | value_out, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get the value of the given field, which is of type DDS_Wchar or another type implicitly convertible to it (DDS_Char).
The member may be specified by name or by ID.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| value_out | <<out>> If this method returned success, this argument will contain the value of the indicated member. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_string | ( | char *& | value, |
| DDS_UnsignedLong * | size, | ||
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get the value of the given field, which is of type char*.
The member may be specified by name or by ID.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| value | <<out>> The string into which the middleware should copy the string member. The allocated size of this string is indicated by size argument. If the size is sufficient to hold the contents of the member, they will be copied into this string. If value is a pointer to NULL, the middleware will allocate a new string for you of sufficient length; it will be your responsibility to free that string. If the size is insufficient but greater than zero, the middleware will not free your string; instead, this operation will fail and size will contain the minimum required size. |
| size | <<inout>> As an input argument, the allocated size of the string. As an output argument, the actual size of the contents. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA. This operation may also return DDS_RETCODE_OUT_OF_RESOURCES. |
| DDS_ReturnCode_t DDS_DynamicData::get_wstring | ( | DDS_Wchar *& | value, |
| DDS_UnsignedLong * | size, | ||
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get the value of the given field, which is of type DDS_Wchar*.
The member may be specified by name or by ID.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| value | <<out>> The string into which the middleware should copy the string member. The allocated size of this string is indicated by size argument. If the size is sufficient to hold the contents of the member, they will be copied into this string. If value is a pointer to NULL, the middleware will allocate a new string for you of sufficient length; it will be your responsibility to free that string. If the size is insufficient but greater than zero, the middleware will not free your string; instead, this operation will fail and size will contain the minimum required size. |
| size | <<inout>> As an input argument, the allocated size of the string. As an output argument, the actual size of the contents. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA. This operation may also return DDS_RETCODE_OUT_OF_RESOURCES. |
| DDS_ReturnCode_t DDS_DynamicData::get_int8 | ( | DDS_Int8 & | value_out, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get the value of the given field, which is of type DDS_Int8.
The member may be specified by name or by ID.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| value_out | <<out>> If this method returned success, this argument will contain the value of the indicated member. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_uint8 | ( | DDS_UInt8 & | value_out, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get the value of the given field, which is of type DDS_UInt8.
The member may be specified by name or by ID.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| value_out | <<out>> If this method returned success, this argument will contain the value of the indicated member. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_complex_member | ( | DDS_DynamicData & | value_out, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the value of the given field, which is of some composed type.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
The member may be of type kind DDS_TK_ARRAY, DDS_TK_SEQUENCE, DDS_TK_STRUCT, DDS_TK_VALUE, or DDS_TK_UNION. It may be specified by name or by ID.
This method is logically related to DDS_DynamicData::bind_complex_member in that both allow you to examine the state of nested objects. They are different in an important way: this method provides a copy of the data; changes to it will not be reflected in the source object.
| value_out | <<out>> The DDS_DynamicData sample whose contents will be overwritten by this operation. This object must not be a bound member of another DDS_DynamicData sample. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA. This operation may also return DDS_RETCODE_OUT_OF_RESOURCES. |
| DDS_ReturnCode_t DDS_DynamicData::get_long_array | ( | DDS_Long * | array, |
| DDS_UnsignedLong * | length, | ||
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given array member. The array may contain members of type DDS_Long or DDS_Enum.
This method will perform an automatic conversion from DDS_LongSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| array | <<out>> An already-allocated array, into which the elements will be copied. |
| length | <<inout>> As an input, the allocated length of array. As an output, the number of elements that were copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_short_array | ( | DDS_Short * | array, |
| DDS_UnsignedLong * | length, | ||
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given array member.
This method will perform an automatic conversion from DDS_ShortSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| array | <<out>> An already-allocated array, into which the elements will be copied. |
| length | <<inout>> As an input, the allocated length of array. As an output, the number of elements that were copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_ulong_array | ( | DDS_UnsignedLong * | array, |
| DDS_UnsignedLong * | length, | ||
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given array member. The array may contain members of type DDS_UnsignedLong or DDS_Enum.
This method will perform an automatic conversion from DDS_UnsignedLongSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| array | <<out>> An already-allocated array, into which the elements will be copied. |
| length | <<inout>> As an input, the allocated length of array. As an output, the number of elements that were copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_ushort_array | ( | DDS_UnsignedShort * | array, |
| DDS_UnsignedLong * | length, | ||
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given array member.
This method will perform an automatic conversion from DDS_UnsignedShortSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| array | <<out>> An already-allocated array, into which the elements will be copied. |
| length | <<inout>> As an input, the allocated length of array. As an output, the number of elements that were copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_float_array | ( | DDS_Float * | array, |
| DDS_UnsignedLong * | length, | ||
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given array member.
This method will perform an automatic conversion from DDS_FloatSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| array | <<out>> An already-allocated array, into which the elements will be copied. |
| length | <<inout>> As an input, the allocated length of array. As an output, the number of elements that were copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_double_array | ( | DDS_Double * | array, |
| DDS_UnsignedLong * | length, | ||
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given array member.
This method will perform an automatic conversion from DDS_DoubleSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| array | <<out>> An already-allocated array, into which the elements will be copied. |
| length | <<inout>> As an input, the allocated length of array. As an output, the number of elements that were copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_boolean_array | ( | DDS_Boolean * | array, |
| DDS_UnsignedLong * | length, | ||
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given array member.
This method will perform an automatic conversion from DDS_BooleanSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| array | <<out>> An already-allocated array, into which the elements will be copied. |
| length | <<inout>> As an input, the allocated length of array. As an output, the number of elements that were copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_char_array | ( | DDS_Char * | array, |
| DDS_UnsignedLong * | length, | ||
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given array member.
This method will perform an automatic conversion from DDS_CharSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| array | <<out>> An already-allocated array, into which the elements will be copied. |
| length | <<inout>> As an input, the allocated length of array. As an output, the number of elements that were copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_octet_array | ( | DDS_Octet * | array, |
| DDS_UnsignedLong * | length, | ||
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given array member.
This method will perform an automatic conversion from DDS_OctetSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| array | <<out>> An already-allocated array, into which the elements will be copied. |
| length | <<inout>> As an input, the allocated length of array. As an output, the number of elements that were copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_longlong_array | ( | DDS_LongLong * | array, |
| DDS_UnsignedLong * | length, | ||
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given array member.
This method will perform an automatic conversion from DDS_LongLongSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| array | <<out>> An already-allocated array, into which the elements will be copied. |
| length | <<inout>> As an input, the allocated length of array. As an output, the number of elements that were copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_ulonglong_array | ( | DDS_UnsignedLongLong * | array, |
| DDS_UnsignedLong * | length, | ||
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given array member.
This method will perform an automatic conversion from DDS_UnsignedLongLongSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| array | <<out>> An already-allocated array, into which the elements will be copied. |
| length | <<inout>> As an input, the allocated length of array. As an output, the number of elements that were copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_longdouble_array | ( | DDS_LongDouble * | array, |
| DDS_UnsignedLong * | length, | ||
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given array member.
This method will perform an automatic conversion from DDS_LongDoubleSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| array | <<out>> An already-allocated array, into which the elements will be copied. |
| length | <<inout>> As an input, the allocated length of array. As an output, the number of elements that were copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_wchar_array | ( | DDS_Wchar * | array, |
| DDS_UnsignedLong * | length, | ||
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given array member.
This method will perform an automatic conversion from DDS_WcharSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| array | <<out>> An already-allocated array, into which the elements will be copied. |
| length | <<inout>> As an input, the allocated length of array. As an output, the number of elements that were copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_int8_array | ( | DDS_Int8 * | array, |
| DDS_UnsignedLong * | length, | ||
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given array member.
This method will perform an automatic conversion from DDS_Int8Seq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| array | <<out>> An already-allocated array, into which the elements will be copied. |
| length | <<inout>> As an input, the allocated length of array. As an output, the number of elements that were copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_uint8_array | ( | DDS_UInt8 * | array, |
| DDS_UnsignedLong * | length, | ||
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given array member.
This method will perform an automatic conversion from DDS_UInt8Seq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| array | <<out>> An already-allocated array, into which the elements will be copied. |
| length | <<inout>> As an input, the allocated length of array. As an output, the number of elements that were copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA |
| DDS_ReturnCode_t DDS_DynamicData::get_long_seq | ( | DDS_LongSeq & | seq, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of DDS_Long.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| seq | <<out>> A sequence, into which the elements will be copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA. This operation may also return DDS_RETCODE_OUT_OF_RESOURCES. |
| DDS_ReturnCode_t DDS_DynamicData::get_short_seq | ( | DDS_ShortSeq & | seq, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of DDS_Short.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| seq | <<out>> A sequence, into which the elements will be copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA. This operation may also return DDS_RETCODE_OUT_OF_RESOURCES. |
| DDS_ReturnCode_t DDS_DynamicData::get_ulong_seq | ( | DDS_UnsignedLongSeq & | seq, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of DDS_UnsignedLong.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| seq | <<out>> A sequence, into which the elements will be copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA. This operation may also return DDS_RETCODE_OUT_OF_RESOURCES. |
| DDS_ReturnCode_t DDS_DynamicData::get_ushort_seq | ( | DDS_UnsignedShortSeq & | seq, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of DDS_UnsignedShort.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| seq | <<out>> A sequence, into which the elements will be copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA. This operation may also return DDS_RETCODE_OUT_OF_RESOURCES. |
| DDS_ReturnCode_t DDS_DynamicData::get_float_seq | ( | DDS_FloatSeq & | seq, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of DDS_Long.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| seq | <<out>> A sequence, into which the elements will be copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA. This operation may also return DDS_RETCODE_OUT_OF_RESOURCES. |
| DDS_ReturnCode_t DDS_DynamicData::get_double_seq | ( | DDS_DoubleSeq & | seq, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of DDS_Double.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| seq | <<out>> A sequence, into which the elements will be copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA. This operation may also return DDS_RETCODE_OUT_OF_RESOURCES. |
| DDS_ReturnCode_t DDS_DynamicData::get_boolean_seq | ( | DDS_BooleanSeq & | seq, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of DDS_Boolean.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| seq | <<out>> A sequence, into which the elements will be copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA. This operation may also return DDS_RETCODE_OUT_OF_RESOURCES. |
| DDS_ReturnCode_t DDS_DynamicData::get_char_seq | ( | DDS_CharSeq & | seq, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of DDS_Char.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| seq | <<out>> A sequence, into which the elements will be copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA. This operation may also return DDS_RETCODE_OUT_OF_RESOURCES. |
| DDS_ReturnCode_t DDS_DynamicData::get_octet_seq | ( | DDS_OctetSeq & | seq, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of DDS_Octet.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| seq | <<out>> A sequence, into which the elements will be copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA. This operation may also return DDS_RETCODE_OUT_OF_RESOURCES. |
| DDS_ReturnCode_t DDS_DynamicData::get_longlong_seq | ( | DDS_LongLongSeq & | seq, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of DDS_LongLong.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| seq | <<out>> A sequence, into which the elements will be copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA. This operation may also return DDS_RETCODE_OUT_OF_RESOURCES. |
| DDS_ReturnCode_t DDS_DynamicData::get_ulonglong_seq | ( | DDS_UnsignedLongLongSeq & | seq, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of DDS_UnsignedLongLong.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| seq | <<out>> A sequence, into which the elements will be copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA. This operation may also return DDS_RETCODE_OUT_OF_RESOURCES. |
| DDS_ReturnCode_t DDS_DynamicData::get_longdouble_seq | ( | DDS_LongDoubleSeq & | seq, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of DDS_LongDouble.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| seq | <<out>> A sequence, into which the elements will be copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA. This operation may also return DDS_RETCODE_OUT_OF_RESOURCES. |
| DDS_ReturnCode_t DDS_DynamicData::get_wchar_seq | ( | DDS_WcharSeq & | seq, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of DDS_Wchar.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| seq | <<out>> A sequence, into which the elements will be copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA. This operation may also return DDS_RETCODE_OUT_OF_RESOURCES. |
| DDS_ReturnCode_t DDS_DynamicData::get_int8_seq | ( | DDS_Int8Seq & | seq, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of DDS_Int8.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| seq | <<out>> A sequence, into which the elements will be copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA. This operation may also return DDS_RETCODE_OUT_OF_RESOURCES. |
| DDS_ReturnCode_t DDS_DynamicData::get_uint8_seq | ( | DDS_UInt8Seq & | seq, |
| const char * | member_name, | ||
| DDS_DynamicDataMemberId | member_id | ||
| ) | const |
Get a copy of the given sequence member.
The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of DDS_UInt8.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| seq | <<out>> A sequence, into which the elements will be copied. |
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| One | of the Standard Return Codes. If the member is optional and not set, this operation will return DDS_RETCODE_NO_DATA. This operation may also return DDS_RETCODE_OUT_OF_RESOURCES. |
| DDS_ReturnCode_t DDS_DynamicData::set_long | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_Long | value | ||
| ) |
Set the value of the given field, which is of type DDS_Long.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> The value to which to set the member. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_short | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_Short | value | ||
| ) |
Set the value of the given field, which is of type DDS_Short.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> The value to which to set the member. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_ulong | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_UnsignedLong | value | ||
| ) |
Set the value of the given field, which is of type DDS_UnsignedLong.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> The value to which to set the member. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_ushort | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_UnsignedShort | value | ||
| ) |
Set the value of the given field, which is of type DDS_UnsignedShort.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> The value to which to set the member. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_float | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_Float | value | ||
| ) |
Set the value of the given field, which is of type DDS_Float.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> The value to which to set the member. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_double | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_Double | value | ||
| ) |
Set the value of the given field, which is of type DDS_Double.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> The value to which to set the member. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_boolean | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_Boolean | value | ||
| ) |
Set the value of the given field, which is of type DDS_Boolean.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> The value to which to set the member. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_char | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_Char | value | ||
| ) |
Set the value of the given field, which is of type DDS_Char.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> The value to which to set the member. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_octet | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_Octet | value | ||
| ) |
Set the value of the given field, which is of type DDS_Octet.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> The value to which to set the member. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_longlong | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_LongLong | value | ||
| ) |
Set the value of the given field, which is of type DDS_LongLong.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> The value to which to set the member. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_ulonglong | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_UnsignedLongLong | value | ||
| ) |
Set the value of the given field, which is of type DDS_UnsignedLongLong.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> The value to which to set the member. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_longdouble | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_LongDouble | value | ||
| ) |
Set the value of the given field, which is of type DDS_LongDouble.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> The value to which to set the member. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_wchar | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_Wchar | value | ||
| ) |
Set the value of the given field, which is of type DDS_Wchar.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> The value to which to set the member. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_string | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| const char * | value | ||
| ) |
Set the value of the given field of type char*.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> The value to which to set the member. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_wstring | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| const DDS_Wchar * | value | ||
| ) |
Set the value of the given field of type DDS_Wchar*.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> The value to which to set the member. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_int8 | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_Int8 | value | ||
| ) |
Set the value of the given field, which is of type DDS_Int8.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> The value to which to set the member. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_uint8 | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_UInt8 | value | ||
| ) |
Set the value of the given field, which is of type DDS_UInt8.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> The value to which to set the member. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_complex_member | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| const DDS_DynamicData & | value | ||
| ) |
Copy the state of the given DDS_DynamicData object into a member of this object.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
The member may be of type kind DDS_TK_ARRAY, DDS_TK_SEQUENCE, DDS_TK_STRUCT, DDS_TK_VALUE, or DDS_TK_UNION. It may be specified by name or by ID.
Example: Copying Data
This method can be used with DDS_DynamicData::bind_complex_member to copy from one DDS_DynamicData object to another efficiently. Suppose the following data structure:
Suppose we have two instances of Foo, foo_dst and foo_src, and we want to replace the contents of foo_dst.theBar with the contents of foo_src.theBar. The following example shows how to do this (error handling has been omitted for the sake of brevity).
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> The source DDS_DynamicData object whose contents will be copied. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_long_array | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_UnsignedLong | length, | ||
| const DDS_Long * | array | ||
| ) |
Set the contents of the given array member. The array may contain members of type DDS_Long or DDS_Enum.
This method will perform an automatic conversion to DDS_LongSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| length | <<in>> The length of array. |
| array | <<in>> The elements to copy. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_short_array | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_UnsignedLong | length, | ||
| const DDS_Short * | array | ||
| ) |
Set the contents of the given array member.
This method will perform an automatic conversion to DDS_ShortSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| length | <<in>> The length of array. |
| array | <<in>> The elements to copy. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_ulong_array | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_UnsignedLong | length, | ||
| const DDS_UnsignedLong * | array | ||
| ) |
Set the contents of the given array member. The array may contain members of type DDS_UnsignedLong or DDS_Enum.
This method will perform an automatic conversion to DDS_UnsignedLongSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| length | <<in>> The length of array. |
| array | <<in>> The elements to copy. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_ushort_array | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_UnsignedLong | length, | ||
| const DDS_UnsignedShort * | array | ||
| ) |
Set the contents of the given array member.
This method will perform an automatic conversion to DDS_UnsignedShortSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| length | <<in>> The length of array. |
| array | <<in>> The elements to copy. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_float_array | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_UnsignedLong | length, | ||
| const DDS_Float * | array | ||
| ) |
Set the contents of the given array member.
This method will perform an automatic conversion to DDS_FloatSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| length | <<in>> The length of array. |
| array | <<in>> The elements to copy. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_double_array | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_UnsignedLong | length, | ||
| const DDS_Double * | array | ||
| ) |
Set the contents of the given array member.
This method will perform an automatic conversion to DDS_DoubleSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| length | <<in>> The length of array. |
| array | <<in>> The elements to copy. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_boolean_array | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_UnsignedLong | length, | ||
| const DDS_Boolean * | array | ||
| ) |
Set the contents of the given array member.
This method will perform an automatic conversion to DDS_BooleanSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| length | <<in>> The length of array. |
| array | <<in>> The elements to copy. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_char_array | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_UnsignedLong | length, | ||
| const DDS_Char * | array | ||
| ) |
Set the contents of the given array member.
This method will perform an automatic conversion to DDS_CharSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| length | <<in>> The length of array. |
| array | <<in>> The elements to copy. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_octet_array | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_UnsignedLong | length, | ||
| const DDS_Octet * | array | ||
| ) |
Set the contents of the given array member.
This method will perform an automatic conversion to DDS_OctetSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| length | <<in>> The length of array. |
| array | <<in>> The elements to copy. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_longlong_array | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_UnsignedLong | length, | ||
| const DDS_LongLong * | array | ||
| ) |
Set the contents of the given array member.
This method will perform an automatic conversion to DDS_LongLongSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| length | <<in>> The length of array. |
| array | <<in>> The elements to copy. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_ulonglong_array | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_UnsignedLong | length, | ||
| const DDS_UnsignedLongLong * | array | ||
| ) |
Set the contents of the given array member.
This method will perform an automatic conversion to DDS_UnsignedLongLongSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| length | <<in>> The length of array. |
| array | <<in>> The elements to copy. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_longdouble_array | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_UnsignedLong | length, | ||
| const DDS_LongDouble * | array | ||
| ) |
Set the contents of the given array member.
This method will perform an automatic conversion to DDS_LongDoubleSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| length | <<in>> The length of array. |
| array | <<in>> The elements to copy. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_wchar_array | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_UnsignedLong | length, | ||
| const DDS_Wchar * | array | ||
| ) |
Set the contents of the given array member.
This method will perform an automatic conversion to DDS_WcharSeq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| length | <<in>> The length of array. |
| array | <<in>> The elements to copy. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_int8_array | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_UnsignedLong | length, | ||
| const DDS_Int8 * | array | ||
| ) |
Set the contents of the given array member.
This method will perform an automatic conversion to DDS_Int8Seq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| length | <<in>> The length of array. |
| array | <<in>> The elements to copy. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_uint8_array | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| DDS_UnsignedLong | length, | ||
| const DDS_UInt8 * | array | ||
| ) |
Set the contents of the given array member.
This method will perform an automatic conversion to DDS_UInt8Seq.
If the destination array is insufficiently long to store the data, this operation will fail without copying anything.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| length | <<in>> The length of array. |
| array | <<in>> The elements to copy. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_long_seq | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| const DDS_LongSeq & | value | ||
| ) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of DDS_Long.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> A sequence, from which the elements will be copied. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_short_seq | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| const DDS_ShortSeq & | value | ||
| ) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of DDS_Short.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> A sequence, from which the elements will be copied. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_ulong_seq | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| const DDS_UnsignedLongSeq & | value | ||
| ) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of DDS_UnsignedLong.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> A sequence, from which the elements will be copied. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_ushort_seq | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| const DDS_UnsignedShortSeq & | value | ||
| ) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of DDS_UnsignedShort.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> A sequence, from which the elements will be copied. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_float_seq | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| const DDS_FloatSeq & | value | ||
| ) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of DDS_Float.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> A sequence, from which the elements will be copied. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_double_seq | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| const DDS_DoubleSeq & | value | ||
| ) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of DDS_Double.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> A sequence, from which the elements will be copied. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_boolean_seq | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| const DDS_BooleanSeq & | value | ||
| ) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of DDS_Boolean.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> A sequence, from which the elements will be copied. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_char_seq | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| const DDS_CharSeq & | value | ||
| ) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of DDS_Char.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> A sequence, from which the elements will be copied. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_octet_seq | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| const DDS_OctetSeq & | value | ||
| ) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of DDS_Octet.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> A sequence, from which the elements will be copied. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_longlong_seq | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| const DDS_LongLongSeq & | value | ||
| ) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of DDS_LongLong.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> A sequence, from which the elements will be copied. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_ulonglong_seq | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| const DDS_UnsignedLongLongSeq & | value | ||
| ) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of DDS_UnsignedLongLong.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> A sequence, from which the elements will be copied. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_longdouble_seq | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| const DDS_LongDoubleSeq & | value | ||
| ) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of DDS_LongDouble.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> A sequence, from which the elements will be copied. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_wchar_seq | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| const DDS_WcharSeq & | value | ||
| ) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of DDS_Wchar.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> A sequence, from which the elements will be copied. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_int8_seq | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| const DDS_Int8Seq & | value | ||
| ) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of DDS_Int8.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> A sequence, from which the elements will be copied. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |
| DDS_ReturnCode_t DDS_DynamicData::set_uint8_seq | ( | const char * | member_name, |
| DDS_DynamicDataMemberId | member_id, | ||
| const DDS_UInt8Seq & | value | ||
| ) |
Set the contents of the given sequence member.
This method will perform an automatic conversion to an array of DDS_UInt8.
This API is not supported when the DynamicData object is in CDR format and will fail with DDS_RETCODE_PRECONDITION_NOT_MET. See DDS_DynamicData::is_cdr for more information.
| member_name | <<in>> The name of the member or NULL to look up the member by its ID. |
| member_id | <<in>> The ID of the member or DDS_DYNAMIC_DATA_MEMBER_ID_UNSPECIFIED to look up by name. See Member Names and IDs. |
| value | <<in>> A sequence, from which the elements will be copied. |
| One | of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES |