An instance of this type is responsible for creating DynamicType objects. More...

Inherits DDS.DynamicTypeBuilderFactory.

Public Member Functions
DynamicType	get_primitive_type (short kind)
	Retrieve a DynamicType object corresponding to the indicated primitive type kind. More...

DynamicTypeBuilder	create_type (DDS.TypeDescriptor descriptor)
	Create and return a new DDS_DynamicTypeBuilder object as described by the given type descriptor. More...

DynamicTypeBuilder	create_type_copy (DDS.DynamicType type)
	Create and return a new DDS_DynamicTypeBuilder object with a copy of the state of the given type. More...

DynamicTypeBuilder	create_type_w_type_object (DDS.TypeObject type_object)
	Create and return a new DynamicTypeBuilder object that describes a type identical to that described by the given TypeObject. More...

DynamicTypeBuilder	create_string_type (int bound)
	Create and return a new DynamicTypeBuilder object representing a string type. More...

DynamicTypeBuilder	create_wstring_type (int bound)
	Create and return a new DynamicTypeBuilder object representing a string type. More...

DynamicTypeBuilder	create_sequence_type (DDS.DynamicType element_type, int bound)
	Create and return a new DynamicTypeBuilder object representing a sequence type. More...

DynamicTypeBuilder	create_array_type (DDS.DynamicType element_type, int[] bound)
	Create and return a new DynamicTypeBuilder object representing an array type. More...

DynamicTypeBuilder	create_map_type (DDS.DynamicType key_element_type, DDS.DynamicType element_type, int bound)
	Create and return a new DynamicTypeBuilder object representing a map type. More...

DynamicTypeBuilder	create_bitset_type (int bound)
	Create and return a new DynamicTypeBuilder object representing a bit set type. More...

DynamicTypeBuilder	create_enumeration_type (int bound)
	Create and return a new DynamicTypeBuilder object representing a enumeration type. More...

DynamicTypeBuilder	create_alias_type (DDS.DynamicType base_type)
	Create and return a new DynamicTypeBuilder object representing a 'alias' type. More...

DynamicTypeBuilder	create_structure_type (DDS.DynamicType base_type)
	Create and return a new DynamicTypeBuilder object representing a structure type. More...

DynamicTypeBuilder	create_union_type ()
	Create and return a new DynamicTypeBuilder object representing a union type. More...

DynamicTypeBuilder	create_type_w_uri (String document_url, String type_name, String[] include_paths)
	Create and return a new DynamicTypeBuilder object by parsing the type description at the given URL. More...

DynamicTypeBuilder	create_type_w_document (String document, String type_name, String[] include_paths)
	Create and return a new DynamicTypeBuilder object by parsing the type description contained in the given string. More...

ReturnCode_t	delete_type (DDS.DynamicType type)
	Destroy a DynamicType instance obtained through the DynamicTypeBuilderFactory::get_primitive_type operation. More...

ReturnCode_t	delete_type_builder (DDS.DynamicTypeBuilder dtb)
	Destroy a DynamicTypeBuilder instance obtained through one of the create methods on the DynamicTypeBuilderFactory. More...

Static Public Member Functions
static DDS.DynamicTypeBuilderFactory	get_instance ()
	Return the DDS_DynamicTypeBuilderFactory singleton instance. More...

static ReturnCode_t	delete_instance ()
	Reclaim any resources associated with the instance returned from DynamicTypeBuilderFactory::get_instance. More...

Detailed Description

An instance of this type is responsible for creating DynamicType objects.

See also: DynamicType; DynamicTypeBuilder; DynamicTypeSupport

Member Function Documentation

◆ create_alias_type()

DynamicTypeBuilder com.toc.coredx.dynamictype.DynamicTypeBuilderFactory.create_alias_type ( DDS.DynamicType base_type )

Create and return a new DynamicTypeBuilder object representing a 'alias' type.

All objects returned by this operation should eventually be deleted by calling DynamicTypeBuilderFactory::delete_type_builder.

Parameter base_type - The type to which the alias should refer.

Return values

nil	If an error occurs, for example if the bound is out of range.

◆ create_array_type()

DynamicTypeBuilder com.toc.coredx.dynamictype.DynamicTypeBuilderFactory.create_array_type	(	DDS.DynamicType	element_type,
		int []	bound
	)

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

All objects returned by this operation should eventually be deleted by calling 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.

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

nil	If any parameters are invalid or an error occurs.

◆ create_bitset_type()

DynamicTypeBuilder com.toc.coredx.dynamictype.DynamicTypeBuilderFactory.create_bitset_type ( int bound )

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

All objects returned by this operation should eventually be deleted by calling DynamicTypeBuilderFactory::delete_type_builder.

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

Return values

nil	If an error occurs, for example if the bound is out of range.

◆ create_enumeration_type()

DynamicTypeBuilder com.toc.coredx.dynamictype.DynamicTypeBuilderFactory.create_enumeration_type ( int bound )

Create and return a new DynamicTypeBuilder object representing a enumeration type.

All objects returned by this operation should eventually be deleted by calling DynamicTypeBuilderFactory::delete_type_builder.

Parameter bound - The number of bits in the enumeration type (will be rounded up to 8, 16, or 32).

Return values

nil	If an error occurs, for example if the bound is out of range.

◆ create_map_type()

DynamicTypeBuilder com.toc.coredx.dynamictype.DynamicTypeBuilderFactory.create_map_type	(	DDS.DynamicType	key_element_type,
		DDS.DynamicType	element_type,
		int	bound
	)

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

All objects returned by this operation should eventually be deleted by calling DynamicTypeBuilderFactory::delete_type_builder.

All map types having equal key and value element types and equal bounds shall be considered equal.

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

nil	If an error occurs, or any parameter is invalid

◆ create_sequence_type()

DynamicTypeBuilder com.toc.coredx.dynamictype.DynamicTypeBuilderFactory.create_sequence_type	(	DDS.DynamicType	element_type,
		int	bound
	)

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

All objects returned by this operation should eventually be deleted by calling DynamicTypeBuilderFactory::delete_type_builder.

All sequence types having equal element types and equal bounds shall be considered equal.

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

nil	If an error occurs, or any parameters are invalid

◆ create_string_type()

DynamicTypeBuilder com.toc.coredx.dynamictype.DynamicTypeBuilderFactory.create_string_type ( int bound )

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

The element type of the result returned by this operation is Char8.

All string types having equal element types and equal bounds shall be considered equal.

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 LENGTH_UNLIMITED, the string type shall be unbounded.

Return values

nil	If an error occurs

◆ create_structure_type()

DynamicTypeBuilder com.toc.coredx.dynamictype.DynamicTypeBuilderFactory.create_structure_type ( DDS.DynamicType base_type )

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

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

Return values

nil	In the case of an error

◆ create_type()

DynamicTypeBuilder com.toc.coredx.dynamictype.DynamicTypeBuilderFactory.create_type ( DDS.TypeDescriptor descriptor )

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 DynamicTypeBuilderFactory::delete_type.

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

Return values

nil	If the descriptor parameter is nil or inconsistent (as indicated by its is_consistent operation)

◆ create_type_copy()

DynamicTypeBuilder com.toc.coredx.dynamictype.DynamicTypeBuilderFactory.create_type_copy ( DDS.DynamicType type )

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 DynamicTypeBuilderFactory::delete_type_builder. The initial state of the new type to create is described by the parameter 'type'.

Return values

nil	If parameter 'type' is nil

◆ create_type_w_document()

DynamicTypeBuilder com.toc.coredx.dynamictype.DynamicTypeBuilderFactory.create_type_w_document	(	String	document,
		String	type_name,
		String []	include_paths
	)

Create and return a new 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 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 DynamicType object. 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. 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

nil	If an error occurs

Not Yet Supported:: This operation is not yet implemented.

◆ create_type_w_type_object()

DynamicTypeBuilder com.toc.coredx.dynamictype.DynamicTypeBuilderFactory.create_type_w_type_object ( DDS.TypeObject type_object )

Create and return a new 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 DynamicTypeBuilderFactory::delete_type_builder.

Return values

nil	If the type_object parameter is invalid

◆ create_type_w_uri()

DynamicTypeBuilder com.toc.coredx.dynamictype.DynamicTypeBuilderFactory.create_type_w_uri	(	String	document_url,
		String	type_name,
		String []	include_paths
	)

Create and return a new 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 DynamicTypeBuilderFactory::delete_type_builder, just as if the resultant type was created by one of the create methods of this class.

Parameter document_url - A URL that indicates a type description document, which shall be parsed to create the 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

nil	If an error occurs, or if any parameters are invalid

Not Yet Supported:: This operation is not yet implemented.

◆ create_union_type()

DynamicTypeBuilder com.toc.coredx.dynamictype.DynamicTypeBuilderFactory.create_union_type ( )

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

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

Return values

nil	In the case of an error

◆ create_wstring_type()

DynamicTypeBuilder com.toc.coredx.dynamictype.DynamicTypeBuilderFactory.create_wstring_type ( int bound )

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

The element type of the result returned by this operation is Char32.

All string types having equal element types and equal bounds shall be considered equal.

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 LENGTH_UNLIMITED, the string type shall be unbounded.

Return values

nil	If an error occurs

◆ delete_instance()

static ReturnCode_t com.toc.coredx.dynamictype.DynamicTypeBuilderFactory.delete_instance ( )

static

Reclaim any resources associated with the instance returned from DynamicTypeBuilderFactory::get_instance.

Return values

RETCODE_OK	on success
RETCODE_ERROR	if it fails

◆ delete_type()

ReturnCode_t com.toc.coredx.dynamictype.DynamicTypeBuilderFactory.delete_type ( DDS.DynamicType type )

Destroy a DynamicType instance obtained through the DynamicTypeBuilderFactory::get_primitive_type operation.

Return values

RETCODE_OK	on success
RETCODE_ALREADY_DELETED	if the type has previously been deleted and the middlware can detect that fact
RETCODE_ERROR	on any other error

◆ delete_type_builder()

ReturnCode_t com.toc.coredx.dynamictype.DynamicTypeBuilderFactory.delete_type_builder ( DDS.DynamicTypeBuilder dtb )

Destroy a DynamicTypeBuilder instance obtained through one of the create methods on the DynamicTypeBuilderFactory.

Return values

RETCODE_OK	on success
RETCODE_ERROR	on any other error

◆ get_instance()

static DDS.DynamicTypeBuilderFactory com.toc.coredx.dynamictype.DynamicTypeBuilderFactory.get_instance ( )

static

Return the DDS_DynamicTypeBuilderFactory singleton instance.

Calling this operation is legal even after DynamicTypeBuilderFactory::delete_instance has been called.

In such a case, the implementation will 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.

◆ get_primitive_type()

DynamicType com.toc.coredx.dynamictype.DynamicTypeBuilderFactory.get_primitive_type ( short kind )

Retrieve a 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

nil	if the given kind does not correspond to a primitive type

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ create_alias_type()

◆ create_array_type()

◆ create_bitset_type()

◆ create_enumeration_type()

◆ create_map_type()

◆ create_sequence_type()

◆ create_string_type()

◆ create_structure_type()

◆ create_type()

◆ create_type_copy()

◆ create_type_w_document()

◆ create_type_w_type_object()

◆ create_type_w_uri()

◆ create_union_type()

◆ create_wstring_type()

◆ delete_instance()

◆ delete_type()

◆ delete_type_builder()

◆ get_instance()

◆ get_primitive_type()