#include <DynamicTypeBuilderFactory.hpp>
Public Types | |
using | _ref_type = typename traits< DynamicTypeBuilderFactory >::ref_type |
Public Member Functions | |
virtual FASTDDS_EXPORTED_API traits< DynamicType >::ref_type | get_primitive_type (TypeKind kind)=0 |
Retrieves the cached DynamicType reference associated to a given primitive. | |
virtual FASTDDS_EXPORTED_API traits< DynamicTypeBuilder >::ref_type | create_type (traits< TypeDescriptor >::ref_type descriptor)=0 |
Creates a new DynamicTypeBuilder reference based on the given TypeDescriptor state. | |
virtual FASTDDS_EXPORTED_API traits< DynamicTypeBuilder >::ref_type | create_type_copy (traits< DynamicType >::ref_type type)=0 |
Creates a new DynamicTypeBuilder reference based on the given DynamicType reference. | |
virtual FASTDDS_EXPORTED_API traits< DynamicTypeBuilder >::ref_type | create_type_w_type_object (const xtypes::TypeObject &type_object)=0 |
Creates a new DynamicTypeBuilder reference based on the given xtypes::TypeObject instance. | |
virtual FASTDDS_EXPORTED_API traits< DynamicTypeBuilder >::ref_type | create_string_type (uint32_t bound)=0 |
Creates a new DynamicTypeBuilder reference representing a bounded string type. | |
virtual FASTDDS_EXPORTED_API traits< DynamicTypeBuilder >::ref_type | create_wstring_type (uint32_t bound)=0 |
Creates a new DynamicTypeBuilder reference representing a bounded wstring type. | |
virtual FASTDDS_EXPORTED_API traits< DynamicTypeBuilder >::ref_type | create_sequence_type (traits< DynamicType >::ref_type element_type, uint32_t bound)=0 |
Creates a new DynamicTypeBuilder reference representing a sequence. | |
virtual FASTDDS_EXPORTED_API traits< DynamicTypeBuilder >::ref_type | create_array_type (traits< DynamicType >::ref_type element_type, const BoundSeq &bound)=0 |
Creates a new DynamicTypeBuilder reference representing an array. | |
virtual FASTDDS_EXPORTED_API traits< DynamicTypeBuilder >::ref_type | create_map_type (traits< DynamicType >::ref_type key_element_type, traits< DynamicType >::ref_type element_type, uint32_t bound)=0 |
Creates a new DynamicTypeBuilder reference representing a map. | |
virtual FASTDDS_EXPORTED_API traits< DynamicTypeBuilder >::ref_type | create_bitmask_type (uint32_t bound)=0 |
Creates a new DynamicTypeBuilder reference representing a bitmask. | |
virtual FASTDDS_EXPORTED_API traits< DynamicTypeBuilder >::ref_type | create_type_w_uri (const std::string &document_url, const std::string &type_name, const IncludePathSeq &include_paths)=0 |
Creates a new DynamicTypeBuilder reference by parsing the type description at the given URL. | |
virtual FASTDDS_EXPORTED_API traits< DynamicTypeBuilder >::ref_type | create_type_w_document (const std::string &document, const std::string &type_name, const IncludePathSeq &include_paths)=0 |
Creates a new DynamicTypeBuilder reference by parsing the type description contained in the given string. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | delete_type (traits< DynamicType >::ref_type &type)=0 |
Resets the internal reference if it is cached. | |
Static Public Member Functions | |
static FASTDDS_EXPORTED_API traits< DynamicTypeBuilderFactory >::ref_type | get_instance () |
Returns the singleton factory object. | |
static FASTDDS_EXPORTED_API ReturnCode_t | delete_instance () |
Resets the singleton reference. | |
Protected Member Functions | |
DynamicTypeBuilderFactory ()=default | |
virtual | ~DynamicTypeBuilderFactory ()=default |
traits< DynamicTypeBuilderFactory >::ref_type | _this () |
using _ref_type = typename traits<DynamicTypeBuilderFactory>::ref_type |
|
protecteddefault |
|
protectedvirtualdefault |
|
protected |
|
pure virtual |
Creates a new DynamicTypeBuilder reference representing an array.
[in] | element_type | DynamicType reference which becomes the element type |
[in] | bound | uint32_t sequence representing the desired dimensions. |
|
pure virtual |
Creates a new DynamicTypeBuilder reference representing a bitmask.
[in] | bound | uint32_t representing the maximum number of elements that may be stored. |
|
pure virtual |
Creates a new DynamicTypeBuilder reference representing a map.
[in] | key_element_type | DynamicType reference which becomes the map's key type |
[in] | element_type | DynamicType reference which becomes the map's value type |
[in] | bound | uint32_t representing the maximum number of elements that may be stored. If the value is equal to LENGTH_UNLIMITED, the map type shall be considered to be unbounded. |
|
pure virtual |
Creates a new DynamicTypeBuilder reference representing a sequence.
[in] | element_type | DynamicType reference which becomes the element type |
[in] | bound | uint32_t representing the maximum number of elements that may be stored. If the value is equal to LENGTH_UNLIMITED, the sequence type shall be considered to be unbounded. |
|
pure virtual |
Creates a new DynamicTypeBuilder reference representing a bounded string type.
[in] | bound | uint32_t representing the maximum number of elements that may be stored. If the value is equal to LENGTH_UNLIMITED, the string type shall be considered to be unbounded. |
|
pure virtual |
Creates a new DynamicTypeBuilder reference based on the given TypeDescriptor state.
[in] | descriptor | TypeDescriptor to be copied. |
|
pure virtual |
Creates a new DynamicTypeBuilder reference based on the given DynamicType reference.
[in] | type | DynamicType reference to be used. |
|
pure virtual |
Creates a new DynamicTypeBuilder reference by parsing the type description contained in the given string.
[in] | document | containing the type description. |
[in] | type_name | Fully qualified name of the type to be loaded from the string. |
[in] | include_paths | A collection of URLs to directories to be searched for additional type description documents. |
|
pure virtual |
Creates a new DynamicTypeBuilder reference based on the given xtypes::TypeObject instance.
[in] | type_object | xtypes::TypeObject instance to be used. |
|
pure virtual |
Creates a new DynamicTypeBuilder reference by parsing the type description at the given URL.
[in] | document_url | pointing to the url containing the type description. |
[in] | type_name | Fully qualified name of the type to be loaded from the document. |
[in] | include_paths | A collection of URLs to directories to be searched for additional type description documents. |
|
pure virtual |
Creates a new DynamicTypeBuilder reference representing a bounded wstring type.
[in] | bound | uint32_t representing the maximum number of elements that may be stored. If the value is equal to LENGTH_UNLIMITED, the wstring type shall be considered to be unbounded. |
|
static |
Resets the singleton reference.
RETCODE_BAD_PARAMETER | if singleton reference is currently nil. |
RETCODE_OK | otherwise. |
|
pure virtual |
Resets the internal reference if it is cached.
[in] | type | DynamicType reference whose internal cached reference to reset. |
RETCODE_OK | is always returned. |
|
static |
Returns the singleton factory object.
|
pure virtual |
Retrieves the cached DynamicType reference associated to a given primitive.
[in] | kind | Type identifying the primitive type to retrieve. |