<<value-type>> Represents a runtime type. More...

#include "dds/core/xtypes/DynamicType.hpp"

Inheritance diagram for dds::core::xtypes::DynamicType:

Public Member Functions
dds::core::xtypes::TypeKind	kind () const
	Gets the type kind. More...

std::string	name () const
	Gets the name. More...

Related Functions
(Note that these are not member functions.)
bool	is_primitive_type (const DynamicType &t)
	Determines if a DynamicType is a PrimitiveType. More...

bool	is_constructed_type (const DynamicType &t)
	Determines if a DynamicType is a constructed type. More...

bool	is_collection_type (const DynamicType &t)
	Determines if a DynamicType is a CollectionType. More...

bool	is_aggregation_type (const DynamicType &t)
	Determines if a DynamicType is an aggregation type. More...

std::ostream &	operator<< (std::ostream &out, const DynamicType &type)
	<<extension>> Converts the DynamicType to a string. More...

void	print_idl (const DynamicType &type, unsigned int indent=0)
	<<extension>> Prints the IDL representation of this DynamicType to the standard output More...

std::ostream &	to_string (std::ostream &out, const DynamicType &type, const rti::core::xtypes::DynamicTypePrintFormatProperty &format=DynamicTypePrintFormatProperty())
	<<extension>> Writes the string representation of this DynamicType to an output stream. More...

std::string	to_string (const DynamicType &type, const rti::core::xtypes::DynamicTypePrintFormatProperty &format=DynamicTypePrintFormatProperty())
	<<extension>> Creates the string representation of this DynamicType to a string. More...

Detailed Description

<<value-type>> Represents a runtime type.

A DynamicType is a mechanism for representing a type at runtime. DynamicTypes allow the reflective manipulation of data (DynamicData) and the inspection of the type information about discovered readers and writers.

You can obtain a DynamicType in a few different ways:

Creating one by instantiating a subclass of dds::core::xtypes::DynamicType instance, such as dds::core::xtypes::StructType and adding members to it. For example:
using namespace dds::core::xtypes;
StructType point_type("Point");
point_type.add_member(Member("x", PrimitiveType<double>()));
point_type.add_member(Member("y", PrimitiveType<double>()));
From an IDL-generated type, using the rti::topic::dynamic_type trait type. <<extension>>
From an XML description, using dds::core::QosProvider::type().
Constructing it using tuples. <<C++11>> <<experimental>> <<extension>>
From a discovered DataReader or DataWriter, using the built-in topics.

For examples, see DynamicType and DynamicData Use Cases

This an abstract base class of all the types. This class contains all of the internal state—derived classes don't add any new state. That means that it is safe to copy a DynamicType without slicing.

To downcast a DynamicType into a concrete class, you can check its kind() and then apply a static_cast to the appropriate class.

For example, let's assume we have the following IDL type:

struct Bar {
    long x;
};
struct Foo {
    Bar bar;
    long y;
};

We obtain the type of Foo and want to know the type of its member bar:

// Get the DynamicType of the IDL-generated type Foo
const StructType& foo_type = rti::topic::dynamic_type<Foo>::get();
// Get the type of its member bar
const DynamicType& bar_type = foo_type.member("bar").type();
// Check type kind and downcast
if (bar_type.kind() == TypeKind::STRUCTURE_TYPE) {
    const StructType& bar_struct = static_cast<const StructType&>(bar_type);
}

See also: dds::core::xtypes::DynamicData, the class that represents data samples for a DynamicType; dds::topic::SubscriptionBuiltinTopicData::type() and dds::topic::PublicationBuiltinTopicData::type() to obtain the type of a remote subscription or publication; rti::topic::dynamic_type to obtain the equivalent DynamicType of an IDL-generated type; DynamicType and DynamicData Use Cases

Member Function Documentation

◆ kind()

dds::core::xtypes::TypeKind dds::core::xtypes::DynamicType::kind ( ) const

Gets the type kind.

◆ name()

std::string dds::core::xtypes::DynamicType::name ( ) const

Gets the name.

Friends And Related Function Documentation

◆ is_primitive_type()

bool is_primitive_type ( const DynamicType & t )

◆ is_constructed_type()

bool is_constructed_type ( const DynamicType & t )

This includes EnumType, AliasType, collection types and aggregation types.

See also: is_collection_type; is_aggregation_type

◆ is_collection_type()

bool is_collection_type ( const DynamicType & t )

This includes ArrayType, SequenceType, StringType, and WStringType.

◆ is_aggregation_type()

bool is_aggregation_type ( const DynamicType & t )

This includes StructType and UnionType.

◆ operator<<()

std::ostream & operator<<	(	std::ostream &	out,
		const DynamicType &	type
	)

This operator writes the DynamicType type to the ostream out using default values for DynamicTypePrintFormatProperty and returns a reference to out.

◆ print_idl()

void print_idl	(	const DynamicType &	type,
		unsigned int	indent = `0`
	)

◆ to_string() [1/2]

std::ostream & to_string	(	std::ostream &	out,
		const DynamicType &	type,
		const rti::core::xtypes::DynamicTypePrintFormatProperty &	format = `DynamicTypePrintFormatProperty()`
	)

Parameters

out	The output stream to which the string representation of the DynamicType should be printed.
type	The DynamicType to be printed.
format	The DynamicTypePrintFormatProperty used to define the format of the string.

Returns: A reference to out.

◆ to_string() [2/2]

std::string to_string	(	const DynamicType &	type,
		const rti::core::xtypes::DynamicTypePrintFormatProperty &	format = `DynamicTypePrintFormatProperty()`
	)