<<value-type>> Represents and IDL typedef More...

#include <dds/core/xtypes/AliasType.hpp>

Inheritance diagram for dds::core::xtypes::AliasType:

Public Member Functions
	AliasType (const std::string &name, const DynamicTypeImpl &related_type, bool is_pointer=false)
	Creates an alias with a name and a related type. More...

const dds::core::xtypes::DynamicType &	related_type () const
	Gets the related type. More...

bool	is_pointer () const
	<<extension>> Gets whether this alias makes related_type a pointer. More...

Public Member Functions inherited from dds::core::xtypes::DynamicType
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.)
const dds::core::xtypes::DynamicType &	resolve_alias (const dds::core::xtypes::DynamicType &type)
	<<extension>> If the type is an alias returns its related type recursively until it is not an alias. More...

Related Functions inherited from dds::core::xtypes::DynamicType
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 and IDL typedef

Constructor & Destructor Documentation

◆ AliasType()

dds::core::xtypes::AliasType::AliasType	(	const std::string &	name,
		const DynamicTypeImpl &	related_type,
		bool	is_pointer = `false`
	)

Creates an alias with a name and a related type.

Parameters

name	The name of this alias
related_type	The aliased type
is_pointer	Whether this alias makes the type a pointer

For example, to create the following two IDL aliases:

typedef long my_long;

typedef long * my_long_ptr;

We can use the following code:

AliasType my_long("my_long", primitive_type<int32_t>());

AliasType my_long_ptr("my_long_ptr", primitive_type<int32_t>(), true);

Member Function Documentation

◆ related_type()

const dds::core::xtypes::DynamicType& dds::core::xtypes::AliasType::related_type ( ) const

Gets the related type.

◆ is_pointer()

bool dds::core::xtypes::AliasType::is_pointer ( ) const

<<extension>> Gets whether this alias makes related_type a pointer.

Friends And Related Function Documentation

◆ resolve_alias()

const dds::core::xtypes::DynamicType & resolve_alias ( const dds::core::xtypes::DynamicType & type )

Public Member Functions

Related Functions