CoreDX Data Distribution Service
The High Performance, Small Footprint DDS from Twin Oaks Computing, Inc
DDS_DynamicTypeBuilderFactory Struct Reference

An instance of this type is responsible for creating DDS_DynamicType and DDS_DynamicTypeSupport objects. More...

Related Functions

(Note that these are not member functions.)

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...
 
DDS_ReturnCode_t DDS_DynamicTypeBuilderFactory_create_key_annotation (DDS_DynamicTypeBuilderFactory dtbf, DDS_AnnotationDescriptor *ad)
 Initialize an AnnotationDescriptor to represent an '@key' annotation. More...
 

Detailed Description

An instance of this type is responsible for creating DDS_DynamicType and DDS_DynamicTypeSupport objects.

See also
DDS_DynamicType
DDS_DynamicTypeBuilder
DDS_DynamicTypeSupport

Friends And Related Function Documentation

◆ DDS_DynamicTypeBuilderFactory_create_key_annotation()

DDS_ReturnCode_t DDS_DynamicTypeBuilderFactory_create_key_annotation ( DDS_DynamicTypeBuilderFactory  dtbf,
DDS_AnnotationDescriptor ad 
)
related

Initialize an AnnotationDescriptor to represent an '@key' 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)

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