CoreDX Data Distribution Service
The High Performance, Small Footprint DDS from Twin Oaks Computing, Inc
X-Types DynamicType

Files

file  xtypes.h
 Provides the X-Types DDS_DynamicDataReader and DDS_DynamicDataWriter API.
 
file  xtypes_dtype.h
 Provides the X-Types DDS_DynamicType, DDS_DynamicData, and related APIs.
 

Data Structures

struct  DDS_AnnotationDescriptor
 A DDS_AnnotationDescriptor object comprises the state of an annotation as it is applied to some element. More...
 
struct  DDS_TypeDescriptor
 A DDS_TypeDescriptor comprises the state of a type. More...
 
struct  DDS_MemberDescriptor
 A DDS_MemberDescriptor comprises the state of a DDS_DynamicTypeMember. More...
 
struct  DDS_DynamicDataReader
 Provides a DataReader interface that is tailored to support reading an X-Types defined DynamicType data type. The specific DynamicType must have been registered previously with the DomainParticipant. More...
 
struct  DDS_DynamicDataWriter
 Provides a DataWriter interface that is tailored to support writing an X-Types defined DynamicType data type. The specific DynamicType must have been registered previously with the DomainParticipant. More...
 
struct  DDS_DynamicTypeBuilderFactory
 An instance of this type is responsible for creating DDS_DynamicType and DDS_DynamicTypeSupport objects. More...
 
struct  DDS_DynamicTypeBuilder
 A DDS_DynamicTypeBuilder object represents the state of a particular type defined according to the Type System. It is used to instantiate concrete DDS_DynamicType objects. More...
 
struct  DDS_DynamicTypeSupport
 The DDS_DynamicTypeSupport interface extends the DDS_TypeSupport interface defined by the DDS specification. This TypeSupport operates on DDS_DynamicData samples. More...
 
struct  DDS_DynamicType
 An instance of DDS_DynamicType represent a type’s schema: its physical name, kind, member definitions (if any), and so on. More...
 
struct  DDS_DynamicTypeMember
 A DDS_DynamicTypeMember represents a "member" of a type. A "member" in this sense may be a member of an aggregated type, a constant within an enumeration, or some other type substructure. More...
 
struct  DDS_DynamicDataFactory
 This type is responsible for creating DDS_DynamicData instances. More...
 
struct  DDS_DynamicData
 A DDS_DynamicData object represents an individual data sample. It provides reflective getters and setters for the members of that sample. More...
 

Functions

 DDS_MAP_DECLARE (DDS_ObjectName, DDS_ObjectName, DDS_Parameters)
 A DDS_Parameters instance is a key-value map.
 
 DDS_MAP_DECLARE (char *, DDS_DynamicTypeMember, DDS_DynamicTypeMembersByName)
 A DDS_DynamicTypeMembersByName instance is a map of DDS_DynamicTypeMember's indexed by 'name'.
 
 DDS_MAP_DECLARE (DDS_MemberId, DDS_DynamicTypeMember, DDS_DynamicTypeMembersById)
 A DDS_DynamicTypeMembersByName instance is a map of DDS_DynamicTypeMember's indexed by MemberId.
 
 DECLARE_SEQ (DDS_DynamicTypeMember, DDS_DynamicTypeMemberSeq)
 A DDS_DynamicTypeMemberSeq instance is a sequence of DDS_DynamicTypeMember's.
 
COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilderFactory DDS_DynamicTypeBuilderFactory_get_instance (void)
 Return the DDS_DynamicTypeBuilderFactory singleton instance. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilderFactory_delete_instance (void)
 Reclaim any resources associated with the instance returned from DDS_DynamicTypeBuilderFactory_get_instance. More...
 
COREDX_C_DYNTYPE_API DDS_DynamicType DDS_DynamicTypeBuilderFactory_get_primitive_type (DDS_DynamicTypeBuilderFactory dtbf, const DDS_TypeKind kind)
 Retrieve a DDS_DynamicType object corresponding to the indicated primitive type kind. More...
 
COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_type (DDS_DynamicTypeBuilderFactory dtbf, const DDS_TypeDescriptor *descriptor)
 Create and return a new DDS_DynamicTypeBuilder object as described by the given type descriptor. More...
 
COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_type_copy (DDS_DynamicTypeBuilderFactory dtbf, const DDS_DynamicType type)
 Create and return a new DDS_DynamicTypeBuilder object with a copy of the state of the given type. More...
 
COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_type_w_type_object (DDS_DynamicTypeBuilderFactory dtbf, const DDS_TypeObject *type_object)
 Create and return a new DDS_DynamicTypeBuilder object that describes a type identical to that described by the given TypeObject. More...
 
COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_string_type (DDS_DynamicTypeBuilderFactory dtbf, const unsigned int bound)
 Create and return a new DDS_DynamicTypeBuilder object representing a string type. More...
 
COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_wstring_type (DDS_DynamicTypeBuilderFactory dtbf, const unsigned int bound)
 Create and return a new DDS_DynamicTypeBuilder object representing a string type. More...
 
COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_sequence_type (DDS_DynamicTypeBuilderFactory dtbf, const DDS_DynamicType element_type, const unsigned int bound)
 Create and return a new DDS_DynamicTypeBuilder object representing a sequence type. More...
 
COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_array_type (DDS_DynamicTypeBuilderFactory dtbf, const DDS_DynamicType element_type, const DDS_BoundSeq *bound)
 Create and return a new DDS_DynamicTypeBuilder object representing an array type. More...
 
COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_map_type (DDS_DynamicTypeBuilderFactory dtbf, const DDS_DynamicType key_element_type, const DDS_DynamicType element_type, const unsigned int bound)
 Create and return a new DDS_DynamicTypeBuilder object representing a map type. More...
 
COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_bitset_type (DDS_DynamicTypeBuilderFactory dtbf, const unsigned int bound)
 Create and return a new DDS_DynamicTypeBuilder object representing a bit set type. More...
 
COREDX_C_DYNTYPE_XML_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_type_w_uri (DDS_DynamicTypeBuilderFactory dtbf, const char *document_url, const char *type_name, const DDS_IncludePathSeq *include_paths)
 Create and return a new DDS_DynamicTypeBuilder object by parsing the type description at the given URL. More...
 
COREDX_C_DYNTYPE_XML_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_type_w_document (DDS_DynamicTypeBuilderFactory dtbf, const char *document, const char *type_name, const DDS_IncludePathSeq *include_paths)
 Create and return a new DDS_DynamicTypeBuilder object by parsing the type description contained in the given string. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilderFactory_delete_type_builder (DDS_DynamicTypeBuilderFactory dtbf, DDS_DynamicTypeBuilder type_builder)
 Destroy a DDS_DynamicTypeBuilder instance obtained through one of the create methods on the DDS_DynamicTypeBuilderFactory. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilderFactory_delete_type (DDS_DynamicTypeBuilderFactory dtbf, DDS_DynamicType type)
 Destroy a DDS_DynamicType instance obtained through the DDS_DynamicTypeBuilderFactory_get_primitive_type operation. More...
 
COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_structure_type (DDS_DynamicTypeBuilderFactory dtbf, DDS_DynamicType base_type)
 Create and return a new DDS_DynamicTypeBuilder object representing a structure type. More...
 
COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_union_type (DDS_DynamicTypeBuilderFactory dtbf)
 Create and return a new DDS_DynamicTypeBuilder object representing a union type. More...
 
COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_alias_type (DDS_DynamicTypeBuilderFactory dtbf, const DDS_DynamicType base_type)
 Create and return a new DDS_DynamicTypeBuilder object representing an alias for the provided 'base_type'. More...
 
COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_enumeration_type (DDS_DynamicTypeBuilderFactory dtbf, const unsigned int bound)
 Create and return a new DDS_DynamicTypeBuilder object representing an enumeration type. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilderFactory_create_extensibility_annotation (DDS_DynamicTypeBuilderFactory dtbf, DDS_AnnotationDescriptor *ad, DDS_ExtensibilityKind ekind)
 Initialize an AnnotationDescriptor to represent an '@extensibility' annotation with the specified extensibility kind. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilderFactory_create_optional_annotation (DDS_DynamicTypeBuilderFactory dtbf, DDS_AnnotationDescriptor *ad)
 Initialize an AnnotationDescriptor to represent an '@optional' annotation. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilder_get_descriptor (DDS_DynamicTypeBuilder dtb, DDS_TypeDescriptor *descriptor)
 This operation provides a summary of the state of this type. More...
 
COREDX_C_DYNTYPE_API const char * DDS_DynamicTypeBuilder_get_name (DDS_DynamicTypeBuilder dtb)
 This convenience operation provides the fully qualified name of this type. I. More...
 
COREDX_C_DYNTYPE_API DDS_TypeKind DDS_DynamicTypeBuilder_get_kind (DDS_DynamicTypeBuilder dtb)
 This convenience operation indicates the kind of this type (e.g., integer, structure, etc.). More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilder_get_member_by_name (DDS_DynamicTypeBuilder dtb, DDS_DynamicTypeMember *member, const DDS_ObjectName name)
 This operation accesses a member by name. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilder_get_all_members_by_name (DDS_DynamicTypeBuilder dtb, DDS_DynamicTypeMembersByName *member)
 This operation provides access to the 'members_by_name' map. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilder_get_member (DDS_DynamicTypeBuilder dtb, DDS_DynamicTypeMember *member, const DDS_MemberId id)
 This operation accesses a member by id. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilder_get_all_members (DDS_DynamicTypeBuilder dtb, DDS_DynamicTypeMembersById *member)
 This operation provides access to the 'members_by_id' map. More...
 
COREDX_C_DYNTYPE_API unsigned int DDS_DynamicTypeBuilder_get_annotation_count (DDS_DynamicTypeBuilder dtb)
 Return the number of annotations applied to this type. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilder_get_annotation (DDS_DynamicTypeBuilder dtb, DDS_AnnotationDescriptor *descriptor, const unsigned int idx)
 Access an annotation at the specified index. On success, the 'descriptor' parameter is set to the annotation. More...
 
COREDX_C_DYNTYPE_API unsigned char DDS_DynamicTypeBuilder_equals (DDS_DynamicTypeBuilder dtb, const DDS_DynamicType other)
 Two types shall be considered equal if and only if all of their respective properties are equal. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilder_add_member (DDS_DynamicTypeBuilder dtb, const DDS_MemberDescriptor *descriptor)
 Add a member to the type. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilder_apply_annotation (DDS_DynamicTypeBuilder dtb, const DDS_AnnotationDescriptor *descriptor)
 Apply the given annotation to this type. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilder_set_extensibility (DDS_DynamicTypeBuilder dtb, uint32_t ext)
 Assign the specified extensibility to the Builder (struct/union) More...
 
COREDX_C_DYNTYPE_API DDS_DynamicType DDS_DynamicTypeBuilder_build (DDS_DynamicTypeBuilder dtb)
 Create an immutable DDS_DynamicType object defined by the builder's current state. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilder_delete_type (DDS_DynamicTypeBuilder dtb, DDS_DynamicType type)
 Destroy the type information contained in this DDS_DynamicTypeBuilder instance. More...
 
COREDX_C_DYNTYPE_API DDS_DynamicTypeSupport DDS_DynamicTypeSupport_create_type_support (const DDS_DynamicType type)
 Create and return a new DDS_DynamicTypeSupport object capable of supporting the given type. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeSupport_delete_type_support (DDS_DynamicTypeSupport type_support)
 Delete the given type support object, which was previously created by a call to DDS_DynamicTypeSupport_create_type_support. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeSupport_register_type (DDS_DynamicTypeSupport dts, const DDS_DomainParticipant participant, const char *type_name)
 Registers the TypeSupport with the DDS_DomainParticipant.
 
COREDX_C_DYNTYPE_API const char * DDS_DynamicTypeSupport_get_type_name (DDS_DynamicTypeSupport dts)
 Returns the name of the type supported by this TypeSupport instance. More...
 
COREDX_C_DYNTYPE_API DDS_DynamicType DDS_DynamicTypeSupport_get_type (DDS_DynamicTypeSupport dts)
 Returns the DDS_DynamicType that is supported by this TypeSupport instance. More...
 
COREDX_C_DYNTYPE_API DDS_DynamicData DDS_DynamicTypeSupport_create_dynamic_sample (DDS_DynamicTypeSupport dts)
 Constructs a DynamicData instance based on the associated DynamicType.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicType_get_descriptor (DDS_DynamicType dt, DDS_TypeDescriptor *descriptor)
 This operation provides a summary of the current state of this type. More...
 
COREDX_C_DYNTYPE_API const char * DDS_DynamicType_get_name (DDS_DynamicType dt)
 This convenience operation provides the fully qualified name of this type. More...
 
COREDX_C_DYNTYPE_API DDS_TypeKind DDS_DynamicType_get_kind (DDS_DynamicType dt)
 This convenience operation returns the kind of this type (e.g., integer, structure, etc.). More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicType_get_member_by_name (DDS_DynamicType dt, DDS_DynamicTypeMember *member, const DDS_ObjectName name)
 This operation accesses a member by name. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicType_get_all_members_by_name (DDS_DynamicType dt, DDS_DynamicTypeMembersByName *member)
 This operation provides access to the 'members_by_name' map. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicType_get_member (DDS_DynamicType dt, DDS_DynamicTypeMember *member, const DDS_MemberId id)
 This operation accesses a member by id. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicType_get_all_members (DDS_DynamicType dt, DDS_DynamicTypeMembersById *member)
 This operation provides access to the 'members_by_id' map. More...
 
COREDX_C_DYNTYPE_API unsigned int DDS_DynamicType_get_annotation_count (DDS_DynamicType dt)
 Return the number of annotations applied to this type. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicType_get_annotation (DDS_DynamicType dt, DDS_AnnotationDescriptor *descriptor, const unsigned int idx)
 Access an annotation at the specified index. On success, the 'descriptor' parameter is set to the annotation. More...
 
COREDX_C_DYNTYPE_API unsigned char DDS_DynamicType_equals (DDS_DynamicType dt, const DDS_DynamicType other)
 Two types shall be considered equal if and only if all of their respective properties are equal. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_AnnotationDescriptor_get_value (const DDS_AnnotationDescriptor *ad, DDS_ObjectName *value, const DDS_ObjectName key)
 This accesses an annotation property 'value' associated with the 'key' name. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_AnnotationDescriptor_get_all_value (const DDS_AnnotationDescriptor *ad, DDS_Parameters *value)
 Access the map of all key-value pairs. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_AnnotationDescriptor_set_value (DDS_AnnotationDescriptor *ad, const DDS_ObjectName key, const DDS_ObjectName value)
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_AnnotationDescriptor_copy_from (DDS_AnnotationDescriptor *ad, const DDS_AnnotationDescriptor *other)
 
COREDX_C_DYNTYPE_API unsigned char DDS_AnnotationDescriptor_equals (DDS_AnnotationDescriptor *ad, const DDS_AnnotationDescriptor *other)
 
COREDX_C_DYNTYPE_API unsigned char DDS_AnnotationDescriptor_is_consistent (const DDS_AnnotationDescriptor *ad)
 
COREDX_C_DYNTYPE_API DDS_DynamicType DDS_AnnotationDescriptor_get_type (const DDS_AnnotationDescriptor *ad)
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_TypeDescriptor_copy_from (DDS_TypeDescriptor *to, const DDS_TypeDescriptor *from)
 Overwrite the contents of this descriptor with those of another descriptor. More...
 
COREDX_C_DYNTYPE_API unsigned char DDS_TypeDescriptor_equals (const DDS_TypeDescriptor *td, const DDS_TypeDescriptor *other)
 Compare two DDS_TypeDescriptor's. More...
 
COREDX_C_DYNTYPE_API unsigned char DDS_TypeDescriptor_is_consistent (const DDS_TypeDescriptor *td)
 Indicates whether the states of all of this descriptor’s properties are consistent. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_MemberDescriptor_copy_from (DDS_MemberDescriptor *to, const DDS_MemberDescriptor *from)
 Overwrite the contents of the 'to' descriptor with those of the provided 'from' descriptor. More...
 
COREDX_C_DYNTYPE_API unsigned char DDS_MemberDescriptor_equals (DDS_MemberDescriptor *md, const DDS_MemberDescriptor *other)
 Compare two DDS_TypeDescriptor's. More...
 
COREDX_C_DYNTYPE_API unsigned char DDS_MemberDescriptor_is_consistent (DDS_MemberDescriptor *md)
 Indicates whether the states of all of this descriptor’s properties are consistent. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeMember_get_descriptor (DDS_DynamicTypeMember dtm, DDS_MemberDescriptor *descriptor)
 This operation accesses the current state of this type. More...
 
COREDX_C_DYNTYPE_API unsigned int DDS_DynamicTypeMember_get_annotation_count (DDS_DynamicTypeMember dtm)
 Return the number of annotations applied to this type. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeMember_get_annotation (DDS_DynamicTypeMember dtm, DDS_AnnotationDescriptor *descriptor, const unsigned int idx)
 Access an annotation at the specified index. On success, the 'descriptor' parameter is set to the annotation. More...
 
COREDX_C_DYNTYPE_API unsigned char DDS_DynamicTypeMember_equals (DDS_DynamicTypeMember dtm, const DDS_DynamicTypeMember other)
 Compare two DDS_DynamicTypeMember's. More...
 
COREDX_C_DYNTYPE_API DDS_MemberId DDS_DynamicTypeMember_get_id (DDS_DynamicTypeMember dtm)
 This convenience operation provides the member ID of this member. More...
 
COREDX_C_DYNTYPE_API const char * DDS_DynamicTypeMember_get_name (DDS_DynamicTypeMember dtm)
 This convenience operation provides the name of this member. More...
 
COREDX_C_DYNTYPE_API DDS_MemberFlag DDS_DynamicTypeMember_get_flags (DDS_DynamicTypeMember dtm)
 Access the type flags.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeMember_set_flags (DDS_DynamicTypeMember dtm, DDS_MemberFlag f)
 Set the type flags.
 
COREDX_C_DYNTYPE_API DDS_DynamicDataFactory DDS_DynamicDataFactory_get_instance (void)
 Return a DDS_DynamicDataFactory instance that can be used to create and delete DDS_DynamicData instances.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicDataFactory_delete_instance (void)
 Reclaim any resources associated with the object(s) previously returned from get_instance.
 
COREDX_C_DYNTYPE_API DDS_DynamicData DDS_DynamicDataFactory_create_data (DDS_DynamicDataFactory ddf, DDS_DynamicType dt)
 Create and return a new data sample. All objects returned by this operation should eventually be deleted by calling DDS_DynamicDataFactory_delete_data. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicDataFactory_delete_data (DDS_DynamicDataFactory ddf, DDS_DynamicData data)
 Dispose of a data sample, reclaiming any associated resources.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_type (DDS_DynamicData dd, DDS_DynamicType *dyn_type)
 This provides the type that defines the values within this sample.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_descriptor (DDS_DynamicData dd, DDS_MemberDescriptor *value, const DDS_MemberId id)
 This provides access to the descriptor for each value in this object, identified by the member ID. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_descriptor (DDS_DynamicData dd, const DDS_MemberId id, const DDS_MemberDescriptor *value)
 Set the descriptor of the member specified by 'id'.
 
COREDX_C_DYNTYPE_API unsigned char DDS_DynamicData_equals (DDS_DynamicData dd, const DDS_DynamicData *other)
 Compare two DDS_DynamicData instances for equality. More...
 
COREDX_C_DYNTYPE_API DDS_MemberId DDS_DynamicData_get_member_id_by_name (DDS_DynamicData dd, const DDS_ObjectName name)
 Access the 'id' of a member matching 'name'.
 
COREDX_C_DYNTYPE_API DDS_MemberId DDS_DynamicData_get_member_id_at_index (DDS_DynamicData dd, const unsigned int index)
 Access the 'id' of a member at the specified index.
 
COREDX_C_DYNTYPE_API unsigned int DDS_DynamicData_get_item_count (DDS_DynamicData dd)
 Access the "item count" of the DDS_DynamicData. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_clear_all_values (DDS_DynamicData dd)
 Clears all values from the instance. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_clear_nonkey_values (DDS_DynamicData dd)
 Clear all non-key values from the instance. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_clear_value (DDS_DynamicData dd, const DDS_MemberId id)
 Clear the specified value from the instance. More...
 
COREDX_C_DYNTYPE_API DDS_DynamicData DDS_DynamicData_loan_value (DDS_DynamicData dd, const DDS_MemberId id)
 The "loan" operations loan to the application a DDS_DynamicData object representing a value within this sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_return_loaned_value (DDS_DynamicData dd, const DDS_DynamicData value)
 Return a "loaned" data sample. More...
 
COREDX_C_DYNTYPE_API DDS_DynamicData DDS_DynamicData_clone (DDS_DynamicData dd)
 Create and return a new data sample with the same contents as this one. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_int32_value (DDS_DynamicData dd, int *value, const DDS_MemberId id)
 Access a 32bit integer value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_int32_value (DDS_DynamicData dd, const DDS_MemberId id, const int value)
 Set a 32bit integer value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_uint32_value (DDS_DynamicData dd, unsigned int *value, const DDS_MemberId id)
 Access an unsigned 32bit integer value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_uint32_value (DDS_DynamicData dd, const DDS_MemberId id, const unsigned int value)
 Set an unsigned 32bit integer value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_int16_value (DDS_DynamicData dd, short *value, const DDS_MemberId id)
 Access a 16bit integer value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_int16_value (DDS_DynamicData dd, const DDS_MemberId id, const short value)
 Set a 16bit integer value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_uint16_value (DDS_DynamicData dd, unsigned short *value, const DDS_MemberId id)
 Access an unsigned 16bit integer value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_uint16_value (DDS_DynamicData dd, const DDS_MemberId id, const unsigned short value)
 Set an unsigned 16bit integer value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_int64_value (DDS_DynamicData dd, int64_t *value, const DDS_MemberId id)
 Access a 64bit integer value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_int64_value (DDS_DynamicData dd, const DDS_MemberId id, const int64_t value)
 Set a 64bit integer value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_uint64_value (DDS_DynamicData dd, uint64_t *value, const DDS_MemberId id)
 Access an unsigned 64bit integer value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_uint64_value (DDS_DynamicData dd, const DDS_MemberId id, const uint64_t value)
 Set an unsigned 64bit integer value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_float32_value (DDS_DynamicData dd, float *value, const DDS_MemberId id)
 Access a float value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_float32_value (DDS_DynamicData dd, const DDS_MemberId id, const float value)
 Set a float value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_float64_value (DDS_DynamicData dd, double *value, const DDS_MemberId id)
 Access a double value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_float64_value (DDS_DynamicData dd, const DDS_MemberId id, const double value)
 Set a double value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_char8_value (DDS_DynamicData dd, char *value, const DDS_MemberId id)
 Access an 8bit character value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_char8_value (DDS_DynamicData dd, const DDS_MemberId id, const char value)
 Set an 8bit character value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_char32_value (DDS_DynamicData dd, cdx_char32_t *value, const DDS_MemberId id)
 Access a 32bit character value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_char32_value (DDS_DynamicData dd, const DDS_MemberId id, const cdx_char32_t value)
 Set a 32bit character value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_byte_value (DDS_DynamicData dd, unsigned char *value, const DDS_MemberId id)
 Access an 8bit value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_byte_value (DDS_DynamicData dd, const DDS_MemberId id, const unsigned char value)
 Set an 8bit value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_boolean_value (DDS_DynamicData dd, unsigned char *value, const DDS_MemberId id)
 Access a boolean value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_boolean_value (DDS_DynamicData dd, const DDS_MemberId id, const unsigned char value)
 Set a boolean value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_string_value (DDS_DynamicData dd, char **value, const DDS_MemberId id)
 Access a string value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_string_value (DDS_DynamicData dd, const DDS_MemberId id, const char *value)
 Set a string value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_wstring_value (DDS_DynamicData dd, cdx_char32_t **value, const DDS_MemberId id)
 Access a wstring value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_wstring_value (DDS_DynamicData dd, const DDS_MemberId id, const cdx_char32_t *value)
 Set a wstring value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_complex_value (DDS_DynamicData dd, DDS_DynamicData *value, const DDS_MemberId id)
 Access a complex value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_complex_value (DDS_DynamicData dd, const DDS_MemberId id, const DDS_DynamicData value)
 Set a complex value, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_map_key_value (DDS_DynamicData dd, const char **key_str, const DDS_MemberId id)
 Access the key value of a map type, identified by 'id', in the sample. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_int32_values (DDS_DynamicData dd, DDS_Int32Seq *value, const DDS_MemberId id)
 Provide access to array values as a sequence. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. The sequence is populated with a 'shallow' copy of the data. This means that modifications to any of the values in the sequence will result in modifications to the data in the DDS_DynamicData instance. It is an error to 'clear' the returned sequence, as this will destroy memory that the DynamicData owns.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_int32_values (DDS_DynamicData dd, const DDS_MemberId id, const DDS_Int32Seq *value)
 Modify an array of values in the DDS_DynamicData instance. More...
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_uint32_values (DDS_DynamicData dd, DDS_UInt32Seq *value, const DDS_MemberId id)
 Provide access to array values as a sequence. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. The sequence is populated with a 'shallow' copy of the data. This means that modifications to any of the values in the sequence will result in modifications to the data in the DDS_DynamicData instance. It is an error to 'clear' the returned sequence, as this will destroy memory that the DynamicData owns.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_uint32_values (DDS_DynamicData dd, const DDS_MemberId id, const DDS_UInt32Seq *value)
 Modify an array of values in the DDS_DynamicData instance. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. This copies the data into the DynamicData instance 'dd'. Modifications to the value sequence after this call will not have an effect on the contents of 'dd'.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_int16_values (DDS_DynamicData dd, DDS_Int16Seq *value, const DDS_MemberId id)
 Provide access to array values as a sequence. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. The sequence is populated with a 'shallow' copy of the data. This means that modifications to any of the values in the sequence will result in modifications to the data in the DDS_DynamicData instance. It is an error to 'clear' the returned sequence, as this will destroy memory that the DynamicData owns.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_int16_values (DDS_DynamicData dd, const DDS_MemberId id, const DDS_Int16Seq *value)
 Modify an array of values in the DDS_DynamicData instance. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. This copies the data into the DynamicData instance 'dd'. Modifications to the value sequence after this call will not have an effect on the contents of 'dd'.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_uint16_values (DDS_DynamicData dd, DDS_UInt16Seq *value, const DDS_MemberId id)
 Provide access to array values as a sequence. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. The sequence is populated with a 'shallow' copy of the data. This means that modifications to any of the values in the sequence will result in modifications to the data in the DDS_DynamicData instance. It is an error to 'clear' the returned sequence, as this will destroy memory that the DynamicData owns.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_uint16_values (DDS_DynamicData dd, const DDS_MemberId id, const DDS_UInt16Seq *value)
 Modify an array of values in the DDS_DynamicData instance. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. This copies the data into the DynamicData instance 'dd'. Modifications to the value sequence after this call will not have an effect on the contents of 'dd'.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_int64_values (DDS_DynamicData dd, DDS_Int64Seq *value, const DDS_MemberId id)
 Provide access to array values as a sequence. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. The sequence is populated with a 'shallow' copy of the data. This means that modifications to any of the values in the sequence will result in modifications to the data in the DDS_DynamicData instance. It is an error to 'clear' the returned sequence, as this will destroy memory that the DynamicData owns.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_int64_values (DDS_DynamicData dd, const DDS_MemberId id, const DDS_Int64Seq *value)
 Modify an array of values in the DDS_DynamicData instance. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. This copies the data into the DynamicData instance 'dd'. Modifications to the value sequence after this call will not have an effect on the contents of 'dd'.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_uint64_values (DDS_DynamicData dd, DDS_UInt64Seq *value, const DDS_MemberId id)
 Provide access to array values as a sequence. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. The sequence is populated with a 'shallow' copy of the data. This means that modifications to any of the values in the sequence will result in modifications to the data in the DDS_DynamicData instance. It is an error to 'clear' the returned sequence, as this will destroy memory that the DynamicData owns.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_uint64_values (DDS_DynamicData dd, const DDS_MemberId id, const DDS_UInt64Seq *value)
 Modify an array of values in the DDS_DynamicData instance. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. This copies the data into the DynamicData instance 'dd'. Modifications to the value sequence after this call will not have an effect on the contents of 'dd'.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_float32_values (DDS_DynamicData dd, DDS_Float32Seq *value, const DDS_MemberId id)
 Provide access to array values as a sequence. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. The sequence is populated with a 'shallow' copy of the data. This means that modifications to any of the values in the sequence will result in modifications to the data in the DDS_DynamicData instance. It is an error to 'clear' the returned sequence, as this will destroy memory that the DynamicData owns.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_float32_values (DDS_DynamicData dd, const DDS_MemberId id, const DDS_Float32Seq *value)
 Modify an array of values in the DDS_DynamicData instance. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. This copies the data into the DynamicData instance 'dd'. Modifications to the value sequence after this call will not have an effect on the contents of 'dd'.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_float64_values (DDS_DynamicData dd, DDS_Float64Seq *value, const DDS_MemberId id)
 Provide access to array values as a sequence. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. The sequence is populated with a 'shallow' copy of the data. This means that modifications to any of the values in the sequence will result in modifications to the data in the DDS_DynamicData instance. It is an error to 'clear' the returned sequence, as this will destroy memory that the DynamicData owns.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_float64_values (DDS_DynamicData dd, const DDS_MemberId id, const DDS_Float64Seq *value)
 Modify an array of values in the DDS_DynamicData instance. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. This copies the data into the DynamicData instance 'dd'. Modifications to the value sequence after this call will not have an effect on the contents of 'dd'.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_char8_values (DDS_DynamicData dd, DDS_CharSeq *value, const DDS_MemberId id)
 Provide access to array values as a sequence. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. The sequence is populated with a 'shallow' copy of the data. This means that modifications to any of the values in the sequence will result in modifications to the data in the DDS_DynamicData instance. It is an error to 'clear' the returned sequence, as this will destroy memory that the DynamicData owns.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_char8_values (DDS_DynamicData dd, const DDS_MemberId id, const DDS_CharSeq *value)
 Modify an array of values in the DDS_DynamicData instance. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. This copies the data into the DynamicData instance 'dd'. Modifications to the value sequence after this call will not have an effect on the contents of 'dd'.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_char32_values (DDS_DynamicData dd, DDS_WcharSeq *value, const DDS_MemberId id)
 Provide access to array values as a sequence. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. The sequence is populated with a 'shallow' copy of the data. This means that modifications to any of the values in the sequence will result in modifications to the data in the DDS_DynamicData instance. It is an error to 'clear' the returned sequence, as this will destroy memory that the DynamicData owns.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_char32_values (DDS_DynamicData dd, const DDS_MemberId id, const DDS_WcharSeq *value)
 Modify an array of values in the DDS_DynamicData instance. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. This copies the data into the DynamicData instance 'dd'. Modifications to the value sequence after this call will not have an effect on the contents of 'dd'.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_byte_values (DDS_DynamicData dd, DDS_ByteSeq *value, const DDS_MemberId id)
 Provide access to array values as a sequence. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. The sequence is populated with a 'shallow' copy of the data. This means that modifications to any of the values in the sequence will result in modifications to the data in the DDS_DynamicData instance. It is an error to 'clear' the returned sequence, as this will destroy memory that the DynamicData owns.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_byte_values (DDS_DynamicData dd, const DDS_MemberId id, const DDS_ByteSeq *value)
 Modify an array of values in the DDS_DynamicData instance. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. This copies the data into the DynamicData instance 'dd'. Modifications to the value sequence after this call will not have an effect on the contents of 'dd'.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_boolean_values (DDS_DynamicData dd, DDS_BooleanSeq *value, const DDS_MemberId id)
 Provide access to array values as a sequence. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. The sequence is populated with a 'shallow' copy of the data. This means that modifications to any of the values in the sequence will result in modifications to the data in the DDS_DynamicData instance. It is an error to 'clear' the returned sequence, as this will destroy memory that the DynamicData owns.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_boolean_values (DDS_DynamicData dd, const DDS_MemberId id, const DDS_BooleanSeq *value)
 Modify an array of values in the DDS_DynamicData instance. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. This copies the data into the DynamicData instance 'dd'. Modifications to the value sequence after this call will not have an effect on the contents of 'dd'.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_string_values (DDS_DynamicData dd, DDS_StringSeq *value, const DDS_MemberId id)
 Provide access to array values as a sequence. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. The sequence is populated with a 'shallow' copy of the data. This means that modifications to any of the values in the sequence will result in modifications to the data in the DDS_DynamicData instance. It is an error to 'clear' the returned sequence, as this will destroy memory that the DynamicData owns.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_string_values (DDS_DynamicData dd, const DDS_MemberId id, const DDS_StringSeq *value)
 Modify an array of values in the DDS_DynamicData instance. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. This copies the data into the DynamicData instance 'dd'. Modifications to the value sequence after this call will not have an effect on the contents of 'dd'.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_wstring_values (DDS_DynamicData dd, DDS_WstringSeq *value, const DDS_MemberId id)
 Provide access to array values as a sequence. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. The sequence is populated with a 'shallow' copy of the data. This means that modifications to any of the values in the sequence will result in modifications to the data in the DDS_DynamicData instance. It is an error to 'clear' the returned sequence, as this will destroy memory that the DynamicData owns.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_wstring_values (DDS_DynamicData dd, const DDS_MemberId id, const DDS_WstringSeq *value)
 Modify an array of values in the DDS_DynamicData instance. If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. This copies the data into the DynamicData instance 'dd'. Modifications to the value sequence after this call will not have an effect on the contents of 'dd'.
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicDataFactory_create_value (DDS_DynamicDataFactory ddf, const DDS_DynamicData data, const DDS_MemberId id, DDS_DynamicData *value)
 Creates a DynamicData instance for the specified member (id) of 'data'. This is useful for 'optional' members that are not constructed by the DDS_DynamicData_create_data() call. By default 'optional' members are left in the 'null' state. To set them, call create_value() and then set_complex_value().
 
COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_copy (DDS_DynamicData dest_dd, DDS_DynamicData src_dd)
 Copies contents from 'src' to 'dest'.
 

Detailed Description

Function Documentation

◆ DDS_AnnotationDescriptor_copy_from()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_AnnotationDescriptor_copy_from ( DDS_AnnotationDescriptor ad,
const DDS_AnnotationDescriptor other 
)
related
Not Yet Supported:
This operation is not yet implemented.

◆ DDS_AnnotationDescriptor_equals()

COREDX_C_DYNTYPE_API unsigned char DDS_AnnotationDescriptor_equals ( DDS_AnnotationDescriptor ad,
const DDS_AnnotationDescriptor other 
)
related
Not Yet Supported:
This operation is not yet implemented.

◆ DDS_AnnotationDescriptor_get_all_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_AnnotationDescriptor_get_all_value ( const DDS_AnnotationDescriptor ad,
DDS_Parameters *  value 
)
related

Access the map of all key-value pairs.

Return values
DDS_RETCODE_OKon success, the 'value' parameters map is populated.
Not Yet Supported:
This operation is not yet implemented.

◆ DDS_AnnotationDescriptor_get_type()

COREDX_C_DYNTYPE_API DDS_DynamicType DDS_AnnotationDescriptor_get_type ( const DDS_AnnotationDescriptor ad)
related
Not Yet Supported:
This operation is not yet implemented.

◆ DDS_AnnotationDescriptor_get_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_AnnotationDescriptor_get_value ( const DDS_AnnotationDescriptor ad,
DDS_ObjectName *  value,
const DDS_ObjectName  key 
)
related

This accesses an annotation property 'value' associated with the 'key' name.

Every attribute value is represented as a string although annotation type members can have other types as well. A string representation of a data value is considered well formed if it would be a valid IDL literal of the corresponding type with the following qualifications:

  • String and character literals shall not be surrounded by quotation characters (‘"’ or ‘'’)
  • All expressions shall be fully evaluated such that no operators or other non-literal characters occur in the value. For example, “5” shall be considered a well-formed string representation of the integer quantity five, but “2 + ENUM_VALUE_THREE” shall not be.
    Not Yet Supported:
    This operation is not yet implemented.

◆ DDS_AnnotationDescriptor_is_consistent()

COREDX_C_DYNTYPE_API unsigned char DDS_AnnotationDescriptor_is_consistent ( const DDS_AnnotationDescriptor ad)
related
Not Yet Supported:
This operation is not yet implemented.

◆ DDS_AnnotationDescriptor_set_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_AnnotationDescriptor_set_value ( DDS_AnnotationDescriptor ad,
const DDS_ObjectName  key,
const DDS_ObjectName  value 
)
related
Not Yet Supported:
This operation is not yet implemented.

◆ DDS_DynamicData_clear_all_values()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_clear_all_values ( DDS_DynamicData  dd)
related

Clears all values from the instance.

The meaning of "clearing" a member depends on the type of data represented by this sample:

  • If this sample is of an aggregated type, and the indicated member is optional, remove it. If the indicated member is not optional, set it to its default value.
  • If this sample is of a variable-length collection type, remove the indicated element, shifting any subsequent elements to the next-lowest index.
  • If the sample is of an array type, set the indicated element to its default value.
  • If the sample is of a bit set type, clear the indicated bit.
  • If the sample is of an enumerated type, set it to the first value of the enumerated type.
  • If the sample is of a primitive type, set it to its default value.
  • The clear_all_members takes the above action for each value in turn.
  • The clear_nonkey_value operation has exactly the same effect as clear_all_values with one exception: the values of key fields of aggregated types retain their values.

◆ DDS_DynamicData_clear_nonkey_values()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_clear_nonkey_values ( DDS_DynamicData  dd)
related

Clear all non-key values from the instance.

See also
DDS_DynamicData_clear_all_values

◆ DDS_DynamicData_clear_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_clear_value ( DDS_DynamicData  dd,
const DDS_MemberId  id 
)
related

Clear the specified value from the instance.

See also
DDS_DynamicData_clear_all_values

◆ DDS_DynamicData_clone()

COREDX_C_DYNTYPE_API DDS_DynamicData DDS_DynamicData_clone ( DDS_DynamicData  dd)
related

Create and return a new data sample with the same contents as this one.

A comparison of this object and the clone using equals immediately following this call will return true.

◆ DDS_DynamicData_equals()

COREDX_C_DYNTYPE_API unsigned char DDS_DynamicData_equals ( DDS_DynamicData  dd,
const DDS_DynamicData other 
)
related

Compare two DDS_DynamicData instances for equality.

Two data samples are considered to be equal if and only if all of the following conditions hold:

  • Their respective type definitions are equal.
  • All contained values are equal and occur in the same order.

If the samples’ type is an aggregated type, the previous rule is amended as follows:

  • Members shall be compared without regard to their order.
  • One of the samples may omit a non-optional member that is present in the other if that member takes its default value in the latter sample.

◆ DDS_DynamicData_get_boolean_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_boolean_value ( DDS_DynamicData  dd,
unsigned char *  value,
const DDS_MemberId  id 
)
related

Access a boolean value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_get_byte_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_byte_value ( DDS_DynamicData  dd,
unsigned char *  value,
const DDS_MemberId  id 
)
related

Access an 8bit value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_get_char32_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_char32_value ( DDS_DynamicData  dd,
cdx_char32_t *  value,
const DDS_MemberId  id 
)
related

Access a 32bit character value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_get_char8_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_char8_value ( DDS_DynamicData  dd,
char *  value,
const DDS_MemberId  id 
)
related

Access an 8bit character value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_get_complex_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_complex_value ( DDS_DynamicData  dd,
DDS_DynamicData value,
const DDS_MemberId  id 
)
related

Access a complex value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_get_descriptor()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_descriptor ( DDS_DynamicData  dd,
DDS_MemberDescriptor value,
const DDS_MemberId  id 
)
related

This provides access to the descriptor for each value in this object, identified by the member ID.

See the description of DDS_DynamicData values.

◆ DDS_DynamicData_get_float32_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_float32_value ( DDS_DynamicData  dd,
float *  value,
const DDS_MemberId  id 
)
related

Access a float value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_get_float64_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_float64_value ( DDS_DynamicData  dd,
double *  value,
const DDS_MemberId  id 
)
related

Access a double value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_get_int16_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_int16_value ( DDS_DynamicData  dd,
short *  value,
const DDS_MemberId  id 
)
related

Access a 16bit integer value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_get_int32_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_int32_value ( DDS_DynamicData  dd,
int *  value,
const DDS_MemberId  id 
)
related

Access a 32bit integer value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_get_int64_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_int64_value ( DDS_DynamicData  dd,
int64_t *  value,
const DDS_MemberId  id 
)
related

Access a 64bit integer value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_get_item_count()

COREDX_C_DYNTYPE_API unsigned int DDS_DynamicData_get_item_count ( DDS_DynamicData  dd)
related

Access the "item count" of the DDS_DynamicData.

The "item count" of the data depends on the type of the object.

  • If the object is of a collection type, return the number of elements currently in the collection.
  • In the case of an array type, this value will always be equal to the product of the bounds of all array dimensions.
  • If the object is of a bit set type, return the number of named flags that are currently set in the bit set.
  • If the object is of a structure or annotation type, return the number of members in the object. This value may be different than the number of members in the corresponding DDS_DynamicType; for example, some optional members may be omitted.
  • If the object is of a union type, return the number of members in the object. This value will always be two: the discriminator and the current member corresponding to it.
  • If the object is of a primitive or enumeration type, it is atomic, and the count is one.
  • If the object is of an alias type, return the value appropriate for the alias’s base type.

◆ DDS_DynamicData_get_map_key_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_map_key_value ( DDS_DynamicData  dd,
const char **  key_str,
const DDS_MemberId  id 
)
related

Access the key value of a map type, identified by 'id', in the sample.

This treats 'dd' as a map, and returns the key value of the pair at index 'id'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or out of range 'id'.

◆ DDS_DynamicData_get_string_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_string_value ( DDS_DynamicData  dd,
char **  value,
const DDS_MemberId  id 
)
related

Access a string value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_get_uint16_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_uint16_value ( DDS_DynamicData  dd,
unsigned short *  value,
const DDS_MemberId  id 
)
related

Access an unsigned 16bit integer value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_get_uint32_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_uint32_value ( DDS_DynamicData  dd,
unsigned int *  value,
const DDS_MemberId  id 
)
related

Access an unsigned 32bit integer value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_get_uint64_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_uint64_value ( DDS_DynamicData  dd,
uint64_t *  value,
const DDS_MemberId  id 
)
related

Access an unsigned 64bit integer value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_get_wstring_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_get_wstring_value ( DDS_DynamicData  dd,
cdx_char32_t **  value,
const DDS_MemberId  id 
)
related

Access a wstring value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_loan_value()

COREDX_C_DYNTYPE_API DDS_DynamicData DDS_DynamicData_loan_value ( DDS_DynamicData  dd,
const DDS_MemberId  id 
)
related

The "loan" operations loan to the application a DDS_DynamicData object representing a value within this sample.

This operation allows applications to visit values without allocating additional DDS_DynamicData objects or copying values. This loan shall be returned by the DDS_DynamicData_return_loaned_value operation.

A given DDS_DynamicData object may support only a single outstanding loan at a time. That is, after calling a "loan" operation, an application must subsequently call return_loaned_value before calling a loan operation again. If an application violates this constraint, the loan operation shall return a nil value.

A loan operation shall also return a nil value if the indicated value does not exist.

◆ DDS_DynamicData_return_loaned_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_return_loaned_value ( DDS_DynamicData  dd,
const DDS_DynamicData  value 
)
related

Return a "loaned" data sample.

The DDS_DynamicData_return_loaned_value operation may return DDS_RETCODE_PRECONDITION_NOT_MET if the provided sample object does not represent an outstanding loan from the sample on which the operation is invoked.

◆ DDS_DynamicData_set_boolean_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_boolean_value ( DDS_DynamicData  dd,
const DDS_MemberId  id,
const unsigned char  value 
)
related

Set a boolean value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_set_byte_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_byte_value ( DDS_DynamicData  dd,
const DDS_MemberId  id,
const unsigned char  value 
)
related

Set an 8bit value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_set_char32_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_char32_value ( DDS_DynamicData  dd,
const DDS_MemberId  id,
const cdx_char32_t  value 
)
related

Set a 32bit character value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_set_char8_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_char8_value ( DDS_DynamicData  dd,
const DDS_MemberId  id,
const char  value 
)
related

Set an 8bit character value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_set_complex_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_complex_value ( DDS_DynamicData  dd,
const DDS_MemberId  id,
const DDS_DynamicData  value 
)
related

Set a complex value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_set_float32_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_float32_value ( DDS_DynamicData  dd,
const DDS_MemberId  id,
const float  value 
)
related

Set a float value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_set_float64_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_float64_value ( DDS_DynamicData  dd,
const DDS_MemberId  id,
const double  value 
)
related

Set a double value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_set_int16_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_int16_value ( DDS_DynamicData  dd,
const DDS_MemberId  id,
const short  value 
)
related

Set a 16bit integer value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_set_int32_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_int32_value ( DDS_DynamicData  dd,
const DDS_MemberId  id,
const int  value 
)
related

Set a 32bit integer value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_set_int32_values()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_int32_values ( DDS_DynamicData  dd,
const DDS_MemberId  id,
const DDS_Int32Seq *  value 
)
related

Modify an array of values in the DDS_DynamicData instance.

If 'dd' is an array type, then 'id' must be DDS_MEMBER_ID_INVALID. If 'dd' is an aggregate type, then 'id' must refer to a member that is of type array. This copies the data into the DynamicData instance 'dd'. Modifications to the value sequence after this call will not have an effect on the contents of 'dd'.

◆ DDS_DynamicData_set_int64_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_int64_value ( DDS_DynamicData  dd,
const DDS_MemberId  id,
const int64_t  value 
)
related

Set a 64bit integer value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_set_string_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_string_value ( DDS_DynamicData  dd,
const DDS_MemberId  id,
const char *  value 
)
related

Set a string value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_set_uint16_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_uint16_value ( DDS_DynamicData  dd,
const DDS_MemberId  id,
const unsigned short  value 
)
related

Set an unsigned 16bit integer value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_set_uint32_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_uint32_value ( DDS_DynamicData  dd,
const DDS_MemberId  id,
const unsigned int  value 
)
related

Set an unsigned 32bit integer value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_set_uint64_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_uint64_value ( DDS_DynamicData  dd,
const DDS_MemberId  id,
const uint64_t  value 
)
related

Set an unsigned 64bit integer value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicData_set_wstring_value()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicData_set_wstring_value ( DDS_DynamicData  dd,
const DDS_MemberId  id,
const cdx_char32_t *  value 
)
related

Set a wstring value, identified by 'id', in the sample.

If 'id' is DDS_MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter or non-existent 'id'.

◆ DDS_DynamicDataFactory_create_data()

COREDX_C_DYNTYPE_API DDS_DynamicData DDS_DynamicDataFactory_create_data ( DDS_DynamicDataFactory  ddf,
DDS_DynamicType  dt 
)
related

Create and return a new data sample. All objects returned by this operation should eventually be deleted by calling DDS_DynamicDataFactory_delete_data.

Parameter type - The type of the sample to create.

◆ DDS_DynamicType_equals()

COREDX_C_DYNTYPE_API unsigned char DDS_DynamicType_equals ( DDS_DynamicType  dt,
const DDS_DynamicType  other 
)
related

Two types shall be considered equal if and only if all of their respective properties are equal.

Return values
zeroif not equal
non-zeroif equal

◆ DDS_DynamicType_get_all_members()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicType_get_all_members ( DDS_DynamicType  dt,
DDS_DynamicTypeMembersById *  member 
)
related

This operation provides access to the 'members_by_id' map.

Return values
DDS_RETCODE_PRECONDITION_NOT_METif the type does not have members
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter
DDS_RETCODE_OKon success

◆ DDS_DynamicType_get_all_members_by_name()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicType_get_all_members_by_name ( DDS_DynamicType  dt,
DDS_DynamicTypeMembersByName *  member 
)
related

This operation provides access to the 'members_by_name' map.

Return values
DDS_RETCODE_PRECONDITION_NOT_METif the type does not have members
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter
DDS_RETCODE_OKon success

◆ DDS_DynamicType_get_annotation()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicType_get_annotation ( DDS_DynamicType  dt,
DDS_AnnotationDescriptor descriptor,
const unsigned int  idx 
)
related

Access an annotation at the specified index. On success, the 'descriptor' parameter is set to the annotation.

Not Yet Supported:
This operation is not yet implemented.

◆ DDS_DynamicType_get_annotation_count()

COREDX_C_DYNTYPE_API unsigned int DDS_DynamicType_get_annotation_count ( DDS_DynamicType  dt)
related

Return the number of annotations applied to this type.

Return values
uintthe number of annotations
Not Yet Supported:
This operation is not yet implemented.

◆ DDS_DynamicType_get_descriptor()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicType_get_descriptor ( DDS_DynamicType  dt,
DDS_TypeDescriptor descriptor 
)
related

This operation provides a summary of the current state of this type.

It populates the provided 'descriptor' parameter.

Return values
DDS_RETCODE_BAD_PARAMETERif any parameters are invalid
DDS_RETCODE_OKon success

◆ DDS_DynamicType_get_kind()

COREDX_C_DYNTYPE_API DDS_TypeKind DDS_DynamicType_get_kind ( DDS_DynamicType  dt)
related

This convenience operation returns the kind of this type (e.g., integer, structure, etc.).

Its result shall be the kind indicated by the type’s descriptor property.

◆ DDS_DynamicType_get_member()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicType_get_member ( DDS_DynamicType  dt,
DDS_DynamicTypeMember member,
const DDS_MemberId  id 
)
related

This operation accesses a member by id.

Several types are considered to have 'members"

  • structures, unions, enumerations, annotations, and bitsets

On success, the 'member' parameter is set to the member that has a matching member id.

Return values
DDS_RETCODE_PRECONDITION_NOT_METif the type does not have members
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter
DDS_RETCODE_ERRORif the member id is not present in the type
DDS_RETCODE_OKon success

◆ DDS_DynamicType_get_member_by_name()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicType_get_member_by_name ( DDS_DynamicType  dt,
DDS_DynamicTypeMember member,
const DDS_ObjectName  name 
)
related

This operation accesses a member by name.

Several types are considered to have 'members"

  • structures, unions, enumerations, annotations, and bitsets

On success, the 'member' parameter is set to the named member.

Return values
DDS_RETCODE_PRECONDITION_NOT_METif the type does not have members
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter
DDS_RETCODE_ERRORif the named member is not present in the type
DDS_RETCODE_OKon success

◆ DDS_DynamicType_get_name()

COREDX_C_DYNTYPE_API const char * DDS_DynamicType_get_name ( DDS_DynamicType  dt)
related

This convenience operation provides the fully qualified name of this type.

It is identical to the name string that is a member of the descriptor property.

◆ DDS_DynamicTypeBuilder_add_member()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilder_add_member ( DDS_DynamicTypeBuilder  dtb,
const DDS_MemberDescriptor descriptor 
)
related

Add a member to the type.

Return values
DDS_RETCODE_PRECONDITION_NOT_METif the type does not have members or a member with the same id already exists
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter
DDS_RETCODE_OUT_OF_RESOURCESin the case of a memory shortage
DDS_RETCODE_OKon success

◆ DDS_DynamicTypeBuilder_apply_annotation()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilder_apply_annotation ( DDS_DynamicTypeBuilder  dtb,
const DDS_AnnotationDescriptor descriptor 
)
related

Apply the given annotation to this type.

Parameter descriptor - A consistent descriptor for the annotation to apply.

Return values
DDS_RETCODE_BAD_PARAMETERIf this 'descriptor' parameter is not consistent
Note
This operation is implemented only for the builtin annotation '@extensibility'.

◆ DDS_DynamicTypeBuilder_build()

COREDX_C_DYNTYPE_API DDS_DynamicType DDS_DynamicTypeBuilder_build ( DDS_DynamicTypeBuilder  dtb)
related

Create an immutable DDS_DynamicType object defined by the builder's current state.

Subsequent changes to this builder, if any, shall have no effect on the state of any previously created DDS_DynamicType.

Return values
nilin the case of an error

◆ DDS_DynamicTypeBuilder_delete_type()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilder_delete_type ( DDS_DynamicTypeBuilder  dtb,
DDS_DynamicType  type 
)
related

Destroy the type information contained in this DDS_DynamicTypeBuilder instance.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter
DDS_RETCODE_OKon success

◆ DDS_DynamicTypeBuilder_equals()

COREDX_C_DYNTYPE_API unsigned char DDS_DynamicTypeBuilder_equals ( DDS_DynamicTypeBuilder  dtb,
const DDS_DynamicType  other 
)
related

Two types shall be considered equal if and only if all of their respective properties are equal.

Return values
zeroif not equal
non-zeroif equal

◆ DDS_DynamicTypeBuilder_get_all_members()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilder_get_all_members ( DDS_DynamicTypeBuilder  dtb,
DDS_DynamicTypeMembersById *  member 
)
related

This operation provides access to the 'members_by_id' map.

Return values
DDS_RETCODE_PRECONDITION_NOT_METif the type does not have members
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter
DDS_RETCODE_OKon success

◆ DDS_DynamicTypeBuilder_get_all_members_by_name()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilder_get_all_members_by_name ( DDS_DynamicTypeBuilder  dtb,
DDS_DynamicTypeMembersByName *  member 
)
related

This operation provides access to the 'members_by_name' map.

Return values
DDS_RETCODE_PRECONDITION_NOT_METif the type does not have members
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter
DDS_RETCODE_OKon success

◆ DDS_DynamicTypeBuilder_get_annotation()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilder_get_annotation ( DDS_DynamicTypeBuilder  dtb,
DDS_AnnotationDescriptor descriptor,
const unsigned int  idx 
)
related

Access an annotation at the specified index. On success, the 'descriptor' parameter is set to the annotation.

Not Yet Supported:
This operation is not yet implemented.

◆ DDS_DynamicTypeBuilder_get_annotation_count()

COREDX_C_DYNTYPE_API unsigned int DDS_DynamicTypeBuilder_get_annotation_count ( DDS_DynamicTypeBuilder  dtb)
related

Return the number of annotations applied to this type.

Return values
uintthe number of annotations
Not Yet Supported:
This operation is not yet implemented.

◆ DDS_DynamicTypeBuilder_get_descriptor()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilder_get_descriptor ( DDS_DynamicTypeBuilder  dtb,
DDS_TypeDescriptor descriptor 
)
related

This operation provides a summary of the state of this type.

It overwrites the state of the application-provided 'descriptor' object.

Return values
DDS_RETCODE_BAD_PARAMETERif the descriptor parameter is invalid
DDS_RETCODE_OKon success

◆ DDS_DynamicTypeBuilder_get_kind()

COREDX_C_DYNTYPE_API DDS_TypeKind DDS_DynamicTypeBuilder_get_kind ( DDS_DynamicTypeBuilder  dtb)
related

This convenience operation indicates the kind of this type (e.g., integer, structure, etc.).

Its result shall be the same as the kind indicated by the type’s descriptor property.

◆ DDS_DynamicTypeBuilder_get_member()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilder_get_member ( DDS_DynamicTypeBuilder  dtb,
DDS_DynamicTypeMember member,
const DDS_MemberId  id 
)
related

This operation accesses a member by id.

Several types are considered to have 'members"

  • structures, unions, enumerations, annotations, and bitsets

On success, the 'member' parameter is set to the member that has a matching member id.

Return values
DDS_RETCODE_PRECONDITION_NOT_METif the type does not have members
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter
DDS_RETCODE_ERRORif the member id is not present in the type
DDS_RETCODE_OKon success

◆ DDS_DynamicTypeBuilder_get_member_by_name()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilder_get_member_by_name ( DDS_DynamicTypeBuilder  dtb,
DDS_DynamicTypeMember member,
const DDS_ObjectName  name 
)
related

This operation accesses a member by name.

Several types are considered to have 'members"

  • structures, unions, enumerations, annotations, and bitsets

On success, the 'member' parameter is set to the named member.

Return values
DDS_RETCODE_PRECONDITION_NOT_METif the type does not have members
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter
DDS_RETCODE_ERRORif the named member is not present in the type
DDS_RETCODE_OKon success

◆ DDS_DynamicTypeBuilder_get_name()

COREDX_C_DYNTYPE_API const char * DDS_DynamicTypeBuilder_get_name ( DDS_DynamicTypeBuilder  dtb)
related

This convenience operation provides the fully qualified name of this type. I.

t shall be identical to the name string that is a member of the descriptor property.

◆ DDS_DynamicTypeBuilder_set_extensibility()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilder_set_extensibility ( DDS_DynamicTypeBuilder  dtb,
uint32_t  ext 
)
related

Assign the specified extensibility to the Builder (struct/union)

The 'ext' parameter is 0, 1, or 2, for FINAL, EXTENSIBLE, and MUTABLE, respectively.

Return values
DDS_RETCODE_BAD_PARAMETERIf the 'ext' parameter is invalid.

◆ DDS_DynamicTypeBuilderFactory_create_alias_type()

COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_alias_type ( DDS_DynamicTypeBuilderFactory  dtbf,
const DDS_DynamicType  base_type 
)
related

Create and return a new DDS_DynamicTypeBuilder object representing an alias for the provided 'base_type'.

This is a convenience routine, in place of calling DDS_DynamicTypeBuilder_create_type() directly. The alias type refers to the 'base_type' parameter.

Return values
nilIn the case of an error

◆ DDS_DynamicTypeBuilderFactory_create_array_type()

COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_array_type ( DDS_DynamicTypeBuilderFactory  dtbf,
const DDS_DynamicType  element_type,
const DDS_BoundSeq *  bound 
)
related

Create and return a new DDS_DynamicTypeBuilder object representing an array type.

All objects returned by this operation should eventually be deleted by calling DDS_DynamicTypeBuilderFactory_delete_type_builder.

All array types having equal element types, an equal number of dimensions, and equal bounds in each dimension shall be considered equal. An implementation may therefore elect whether to always return a new object from this method or whether to pool objects and to return previously created type objects consistent with these rules.

The type of all objects that can be stored in an array of the new type is specified by parameter 'element_type'.

The 'bound' parameter is a collection of unsigned integers, the length of which is equal to the number of dimensions in the new array type, and the values of which are the bounds of each dimension. (For example, a three-by-two array would be described by a collection of length two, where the first element had a value of three and the second a value of two.)

Return values
nilIf any parameters are invalid or an error occurs.

◆ DDS_DynamicTypeBuilderFactory_create_bitset_type()

COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_bitset_type ( DDS_DynamicTypeBuilderFactory  dtbf,
const unsigned int  bound 
)
related

Create and return a new DDS_DynamicTypeBuilder object representing a bit set type.

All objects returned by this operation should eventually be deleted by calling DDS_DynamicTypeBuilderFactory_delete_type_builder.

Parameter bound - The number of reserved bits in the bit set.

Return values
nilIf an error occurs, for example if the bound is out of range.

◆ DDS_DynamicTypeBuilderFactory_create_enumeration_type()

COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_enumeration_type ( DDS_DynamicTypeBuilderFactory  dtbf,
const unsigned int  bound 
)
related

Create and return a new DDS_DynamicTypeBuilder object representing an enumeration type.

This is a convenience routine, in place of calling DDS_DynamicTypeBuilder_create_type() directly. The enumeration type of the result returned shall initially contain no members.

Return values
nilIn the case of an error

◆ DDS_DynamicTypeBuilderFactory_create_extensibility_annotation()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilderFactory_create_extensibility_annotation ( DDS_DynamicTypeBuilderFactory  dtbf,
DDS_AnnotationDescriptor ad,
DDS_ExtensibilityKind  ekind 
)
related

Initialize an AnnotationDescriptor to represent an '@extensibility' annotation with the specified extensibility kind.

This is a convenience routine, in place of calling DDS_DynamicTypeBuilderFactory routines directly. Use DDS_AnnotationDescriptor_clear() to reclaim the memory allocated by this routine.

Return values
DDS_RETCODE_OKif AnnotationDescriptor is correctly initialized
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter (ie, dtbf or ad == NULL)

◆ DDS_DynamicTypeBuilderFactory_create_map_type()

COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_map_type ( DDS_DynamicTypeBuilderFactory  dtbf,
const DDS_DynamicType  key_element_type,
const DDS_DynamicType  element_type,
const unsigned int  bound 
)
related

Create and return a new DDS_DynamicTypeBuilder object representing a map type.

All objects returned by this operation should eventually be deleted by calling DDS_DynamicTypeBuilderFactory_delete_type_builder.

All map types having equal key and value element types and equal bounds shall be considered equal. An implementation may therefore elect whether to always return a new object from this method or whether to pool objects and to return previously created type objects consistent with these rules.

Parameter key_element_type - The type of all objects that can be stored as keys in a map of the new type.

Parameter element_type - The type of all objects that can be stored as values in a map of the new type.

Parameter bound - The maximum number of key-value pairs that may be stored in a map of the new type. If this argument is equal to LENGTH_UNLIMITED, the map type shall be considered to be unbounded.

Return values
nilIf an error occurs, or any parameter is invalid

◆ DDS_DynamicTypeBuilderFactory_create_optional_annotation()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilderFactory_create_optional_annotation ( DDS_DynamicTypeBuilderFactory  dtbf,
DDS_AnnotationDescriptor ad 
)
related

Initialize an AnnotationDescriptor to represent an '@optional' annotation.

This is a convenience routine, in place of calling DDS_DynamicTypeBuilderFactory routines directly. Use DDS_AnnotationDescriptor_clear() to reclaim the memory allocated by this routine.

Return values
DDS_RETCODE_OKif AnnotationDescriptor is correctly initialized
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter (ie, dtbf or ad == NULL)

◆ DDS_DynamicTypeBuilderFactory_create_sequence_type()

COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_sequence_type ( DDS_DynamicTypeBuilderFactory  dtbf,
const DDS_DynamicType  element_type,
const unsigned int  bound 
)
related

Create and return a new DDS_DynamicTypeBuilder object representing a sequence type.

All objects returned by this operation should eventually be deleted by calling DDS_DynamicTypeBuilderFactory_delete_type_builder.

All sequence types having equal element types and equal bounds shall be considered equal. An implementation may therefore elect whether to always return a new object from this method or whether to pool objects and to return previously created type objects consistent with these rules.

The type of all objects that can be stored in a sequence of the new type is specified by the 'element_type' parameter.

The maximum number of elements that may be stored in a sequence of the new type is specified by the 'bound' parameter. If this argument is equal to DDS_LENGTH_UNLIMITED, the sequence type shall be considered to be unbounded.

Return values
nilIf an error occurs, or any parameters are invalid

◆ DDS_DynamicTypeBuilderFactory_create_string_type()

COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_string_type ( DDS_DynamicTypeBuilderFactory  dtbf,
const unsigned int  bound 
)
related

Create and return a new DDS_DynamicTypeBuilder object representing a string type.

The element type of the result returned by DDS_DynamicTypeBuilderFactory_create_string_type shall be Char8. The element type of the result returned by create_wstring_type shall be Char32.

All string types having equal element types and equal bounds shall be considered equal. An implementation may therefore elect whether to always return a new object from this method or whether to pool objects and to return previously created type objects consistent with these rules.

The maximum number of elements that may be stored in a string of the new type is specified by parameter 'bound'. If this argument is equal to DDS_LENGTH_UNLIMITED, the string type shall be unbounded.

Return values
nilIf an error occurs

◆ DDS_DynamicTypeBuilderFactory_create_structure_type()

COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_structure_type ( DDS_DynamicTypeBuilderFactory  dtbf,
DDS_DynamicType  base_type 
)
related

Create and return a new DDS_DynamicTypeBuilder object representing a structure type.

This is a convenience routine, in place of calling DDS_DynamicTypeBuilder_create_type() directly. The structure type of the result returned shall initially contain no members. If the structure is to inherit from a parent type, it is specified in the 'base_type' parameter, otherwise, 'base_type' should be set tp NULL.

Return values
nilIn the case of an error

◆ DDS_DynamicTypeBuilderFactory_create_type()

COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_type ( DDS_DynamicTypeBuilderFactory  dtbf,
const DDS_TypeDescriptor descriptor 
)
related

Create and return a new DDS_DynamicTypeBuilder object as described by the given type descriptor.

This method is the conventional mechanism for creating structured, enumeration, and alias types, although it can also be used to create types of other kinds. All objects returned by this operation should eventually be deleted by calling DDS_DynamicTypeBuilderFactory_delete_type.

The properties of the new type to create is provided by the 'descriptor' parameter.

Return values
nilIf the descriptor parameter is nil or inconsistent (as indicated by its is_consistent operation)

◆ DDS_DynamicTypeBuilderFactory_create_type_copy()

COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_type_copy ( DDS_DynamicTypeBuilderFactory  dtbf,
const DDS_DynamicType  type 
)
related

Create and return a new DDS_DynamicTypeBuilder object with a copy of the state of the given type.

All objects returned by this operation should eventually be deleted by calling DDS_DynamicTypeBuilderFactory_delete_type_builder. The initial state of the new type to create is described by the parameter 'type'.

Return values
nilIf parameter 'type' is nil

◆ DDS_DynamicTypeBuilderFactory_create_type_w_document()

COREDX_C_DYNTYPE_XML_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_type_w_document ( DDS_DynamicTypeBuilderFactory  dtbf,
const char *  document,
const char *  type_name,
const DDS_IncludePathSeq *  include_paths 
)
related

Create and return a new DDS_DynamicTypeBuilder object by parsing the type description contained in the given string.

Applications shall be able to reclaim resources associated with the type returned by this method by calling DDS_DynamicTypeBuilderFactory_delete_type_builder, just as if the resultant type was created by one of the create methods of this class.

Parameter document - A type description document, which shall be parsed to create the DDS_DynamicType object. Implementations shall minimally support the XML Type Description format for loaded documents and may support additional Type Descriptions. The 'document' parameter shall be a NUL terminated string containing the XML text of the document.

Parameter type_name - The fully qualified name of the type to be loaded from the document. If no type exists of this name in the document, the operation shall fail and return a nil result.

Parameter include_paths - A collection of URLs to directories to be searched for additional type description documents that may be included, directly or indirectly, by the document argument. Implementations shall minimally support the file: URL scheme and may support additional schemes.

Return values
nilIf an error occurs
Not Yet Supported:
This operation is not yet implemented.

◆ DDS_DynamicTypeBuilderFactory_create_type_w_type_object()

COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_type_w_type_object ( DDS_DynamicTypeBuilderFactory  dtbf,
const DDS_TypeObject *  type_object 
)
related

Create and return a new DDS_DynamicTypeBuilder object that describes a type identical to that described by the given TypeObject.

Subsequent changes to the new DDS_DynamicTypeBuilder object shall not impact the input TypeObject 'type_object'. All objects returned by this operation should eventually be deleted by calling DDS_DynamicTypeBuilderFactory_delete_type_builder.

Return values
nilIf the type_object parameter is invalid

◆ DDS_DynamicTypeBuilderFactory_create_type_w_uri()

COREDX_C_DYNTYPE_XML_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_type_w_uri ( DDS_DynamicTypeBuilderFactory  dtbf,
const char *  document_url,
const char *  type_name,
const DDS_IncludePathSeq *  include_paths 
)
related

Create and return a new DDS_DynamicTypeBuilder object by parsing the type description at the given URL.

Applications shall be able to reclaim resources associated with the type returned by this method by calling DDS_DynamicTypeBuilderFactory_delete_type_builder, just as if the resultant type was created by one of the create methods of this class.

Parameter document_uri - A URL that indicates a type description document, which shall be parsed to create the DDS_DynamicType object. Implementations shall minimally support the "file:" URL scheme and may support additional schemes. Implementations shall minimally support the XML Type Description format for loaded documents and may support additional Type Descriptions.

Parameter type_name - The fully qualified name of the type to be loaded from the document that is the target of the URL. If no type exists of this name in the document, the operation shall fail and return a nil result.

Parameter include_paths - A collection of URLs to directories to be searched for additional type description documents that may be included, directly or indirectly, by the document that is the target of document_url. The directory in which the target of document_url resides shall be considered on the inclusion search path implicitly and need not be included in this collection. Implementations shall minimally support the file: URL scheme and may support additional schemes.

Return values
nilIf an error occurs, or if any parameters are invalid
Not Yet Supported:
This operation is not yet implemented.

◆ DDS_DynamicTypeBuilderFactory_create_union_type()

COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_union_type ( DDS_DynamicTypeBuilderFactory  dtbf)
related

Create and return a new DDS_DynamicTypeBuilder object representing a union type.

This is a convenience routine, in place of calling DDS_DynamicTypeBuilder_create_type() directly. The union type of the result returned shall initially contain no members.

Return values
nilIn the case of an error

◆ DDS_DynamicTypeBuilderFactory_create_wstring_type()

COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilder DDS_DynamicTypeBuilderFactory_create_wstring_type ( DDS_DynamicTypeBuilderFactory  dtbf,
const unsigned int  bound 
)
related

Create and return a new DDS_DynamicTypeBuilder object representing a string type.

The element type of the result returned by DDS_DynamicTypeBuilderFactory_create_string_type shall be Char8. The element type of the result returned by create_wstring_type shall be Char32.

All string types having equal element types and equal bounds shall be considered equal. An implementation may therefore elect whether to always return a new object from this method or whether to pool objects and to return previously created type objects consistent with these rules.

The maximum number of elements that may be stored in a string of the new type is specified by parameter 'bound'. If this argument is equal to DDS_LENGTH_UNLIMITED, the string type shall be unbounded.

Return values
nilIf an error occurs

◆ DDS_DynamicTypeBuilderFactory_delete_instance()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilderFactory_delete_instance ( void  )
related

Reclaim any resources associated with the instance returned from DDS_DynamicTypeBuilderFactory_get_instance.

Return values
RETCODE_OKon success
RETCODE_ERRORif it fails

◆ DDS_DynamicTypeBuilderFactory_delete_type()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilderFactory_delete_type ( DDS_DynamicTypeBuilderFactory  dtbf,
DDS_DynamicType  type 
)
related

Destroy a DDS_DynamicType instance obtained through the DDS_DynamicTypeBuilderFactory_get_primitive_type operation.

Return values
DDS_RETCODE_OKon success
DDS_RETCODE_ALREADY_DELETEDif the type has previously been deleted and the middlware can detect that fact
DDS_RETCODE_ERRORon any other error

◆ DDS_DynamicTypeBuilderFactory_delete_type_builder()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeBuilderFactory_delete_type_builder ( DDS_DynamicTypeBuilderFactory  dtbf,
DDS_DynamicTypeBuilder  type_builder 
)
related

Destroy a DDS_DynamicTypeBuilder instance obtained through one of the create methods on the DDS_DynamicTypeBuilderFactory.

Return values
DDS_RETCODE_OKon success
DDS_RETCODE_ERRORon any other error

◆ DDS_DynamicTypeBuilderFactory_get_instance()

COREDX_C_DYNTYPE_API DDS_DynamicTypeBuilderFactory DDS_DynamicTypeBuilderFactory_get_instance ( void  )
related

Return the DDS_DynamicTypeBuilderFactory singleton instance.

Calling this operation is legal even after delete_instance has been called. In such a case, the implementation shall recreate or restore the state of the "singleton" as necessary in order to return a valid object to the caller. If an error occurs, this method shall return a nil value.

◆ DDS_DynamicTypeBuilderFactory_get_primitive_type()

COREDX_C_DYNTYPE_API DDS_DynamicType DDS_DynamicTypeBuilderFactory_get_primitive_type ( DDS_DynamicTypeBuilderFactory  dtbf,
const DDS_TypeKind  kind 
)
related

Retrieve a DDS_DynamicType object corresponding to the indicated primitive type kind.

The kind of the primitive type whose representation is to be returned is specified by parameter 'kind'.

Return values
nilif the given kind does not correspond to a primitive type

◆ DDS_DynamicTypeMember_equals()

COREDX_C_DYNTYPE_API unsigned char DDS_DynamicTypeMember_equals ( DDS_DynamicTypeMember  dtm,
const DDS_DynamicTypeMember  other 
)
related

Compare two DDS_DynamicTypeMember's.

Two type descriptors are considered equal if and only if if they belong to the same type and the values of all of the properties are equal in each of them.

◆ DDS_DynamicTypeMember_get_annotation()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeMember_get_annotation ( DDS_DynamicTypeMember  dtm,
DDS_AnnotationDescriptor descriptor,
const unsigned int  idx 
)
related

Access an annotation at the specified index. On success, the 'descriptor' parameter is set to the annotation.

Not Yet Supported:
This operation is not yet implemented.

◆ DDS_DynamicTypeMember_get_annotation_count()

COREDX_C_DYNTYPE_API unsigned int DDS_DynamicTypeMember_get_annotation_count ( DDS_DynamicTypeMember  dtm)
related

Return the number of annotations applied to this type.

Return values
uintthe number of annotations
Not Yet Supported:
This operation is not yet implemented.

◆ DDS_DynamicTypeMember_get_descriptor()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeMember_get_descriptor ( DDS_DynamicTypeMember  dtm,
DDS_MemberDescriptor descriptor 
)
related

This operation accesses the current state of this type.

It overwrites the application-provided 'descriptor' parameter.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter

◆ DDS_DynamicTypeMember_get_id()

COREDX_C_DYNTYPE_API DDS_MemberId DDS_DynamicTypeMember_get_id ( DDS_DynamicTypeMember  dtm)
related

This convenience operation provides the member ID of this member.

Its result shall be identical to the ID value that is a member of the descriptor property.

◆ DDS_DynamicTypeMember_get_name()

COREDX_C_DYNTYPE_API const char * DDS_DynamicTypeMember_get_name ( DDS_DynamicTypeMember  dtm)
related

This convenience operation provides the name of this member.

Its result shall be identical to the name string that is a member of the descriptor property.

◆ DDS_DynamicTypeSupport_create_type_support()

COREDX_C_DYNTYPE_API DDS_DynamicTypeSupport DDS_DynamicTypeSupport_create_type_support ( const DDS_DynamicType  type)
related

Create and return a new DDS_DynamicTypeSupport object capable of supporting the given type.

The new type support has a "copy" of the given 'type' parameter, such that subsequent changes to, or deletions of, the 'type' parameter do not impact the new type support.

Any object returned by this operation should eventually be deleted by calling DDS_DynamicTypeSupport_delete_type_support.

Parameter type - The type for which to create a type support.

Return values
nilIf an error occurs, or the parameter is invalid

◆ DDS_DynamicTypeSupport_delete_type_support()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_DynamicTypeSupport_delete_type_support ( DDS_DynamicTypeSupport  type_support)
related

Delete the given type support object, which was previously created by a call to DDS_DynamicTypeSupport_create_type_support.

Return values
DDS_RETCODE_BAD_PARAMETERinvalid parameter
DDS_RETCODE_OKon success

◆ DDS_DynamicTypeSupport_get_type()

COREDX_C_DYNTYPE_API DDS_DynamicType DDS_DynamicTypeSupport_get_type ( DDS_DynamicTypeSupport  dts)
related

Returns the DDS_DynamicType that is supported by this TypeSupport instance.

The application should not modify the returned DDS_DynamicType.

◆ DDS_DynamicTypeSupport_get_type_name()

COREDX_C_DYNTYPE_API const char * DDS_DynamicTypeSupport_get_type_name ( DDS_DynamicTypeSupport  dts)
related

Returns the name of the type supported by this TypeSupport instance.

The returned string is owned by the TypeSupport, and must not be free'd or modified.

◆ DDS_MemberDescriptor_copy_from()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_MemberDescriptor_copy_from ( DDS_MemberDescriptor to,
const DDS_MemberDescriptor from 
)
related

Overwrite the contents of the 'to' descriptor with those of the provided 'from' descriptor.

Subsequent calls to equals, passing the same argument as to this method, return true.

The 'from' descriptor shall not be changed by this operation.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter
DDS_RETCODE_ERRORin the case of any other error

◆ DDS_MemberDescriptor_equals()

COREDX_C_DYNTYPE_API unsigned char DDS_MemberDescriptor_equals ( DDS_MemberDescriptor md,
const DDS_MemberDescriptor other 
)
related

Compare two DDS_TypeDescriptor's.

Two type descriptors are considered equal if and only if the values of all of the properties identified in the table above are equal in each of them.

◆ DDS_MemberDescriptor_is_consistent()

COREDX_C_DYNTYPE_API unsigned char DDS_MemberDescriptor_is_consistent ( DDS_MemberDescriptor md)
related

Indicates whether the states of all of this descriptor’s properties are consistent.

The definitions of consistency for each property are given in the section corresponding to that property.

Return values
non-zeroif descriptor is consistent
zeroif descriptor is not consistent

◆ DDS_TypeDescriptor_copy_from()

COREDX_C_DYNTYPE_API DDS_ReturnCode_t DDS_TypeDescriptor_copy_from ( DDS_TypeDescriptor to,
const DDS_TypeDescriptor from 
)
related

Overwrite the contents of this descriptor with those of another descriptor.

Subsequent calls to equals, passing the same argument as to this method, return true. The other descriptor shall not be changed by this operation.

Return values
DDS_RETCODE_BAD_PARAMETERin the case of an invalid parameter
DDS_RETCODE_ERRORin the case of any other error

◆ DDS_TypeDescriptor_equals()

COREDX_C_DYNTYPE_API unsigned char DDS_TypeDescriptor_equals ( const DDS_TypeDescriptor td,
const DDS_TypeDescriptor other 
)
related

Compare two DDS_TypeDescriptor's.

Two type descriptors are considered equal if and only if the values of all of the properties identified in the table above are equal in each of them.

◆ DDS_TypeDescriptor_is_consistent()

COREDX_C_DYNTYPE_API unsigned char DDS_TypeDescriptor_is_consistent ( const DDS_TypeDescriptor td)
related

Indicates whether the states of all of this descriptor’s properties are consistent.

The definitions of consistency for each property are given in the section corresponding to that property.

Return values
non-zeroif descriptor is consistent
zeroif descriptor is not consistent

© 2009-2020 Twin Oaks Computing, Inc
Castle Rock, CO 80104
All rights reserved.