<<value-type>> Represents an IDL enum type More...

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

Inheritance diagram for dds::core::xtypes::EnumType:

Public Member Functions
	EnumType (const std::string &name)
	Creates an empty enum type. More...

template<typename Container >
	EnumType (const std::string &the_name, const Container &the_members)
	Creates an enum with the members in a container. More...

template<typename MemberIter >
	EnumType (const std::string &the_name, MemberIter begin, MemberIter end)
	Creates a enum with the members in an iterator range. More...

	EnumType (const std::string &the_name, std::initializer_list< EnumMember > the_members)
	Creates an enum with the members in an initializer_list. More...

MemberIndex	find_member_by_ordinal (int32_t ordinal) const
	Gets the index of the member with this ordinal value. More...

EnumType &	add_member (const EnumMember &member)
	Adds a member at the end. More...

template<typename Container >
EnumType &	add_members (const Container &the_members)
	Adds all the members of a container at the end. More...

EnumType &	add_members (std::initializer_list< EnumMember > the_members)
	Adds all the members of an initializer_list at the end. More...

template<typename MemberIter >
EnumType &	add_members (MemberIter begin, MemberIter end)
	Adds all the members in an iterator range at the end. More...

Public Member Functions inherited from dds::core::xtypes::AbstractConstructedType< EnumMember >
dds::core::xtypes::ExtensibilityKind	extensibility_kind () const
	Gets the extensibility kind. More...

size_t	member_count () const
	Gets the number of members. More...

const EnumMember &	member (MemberIndex index) const
	Gets a member by its index. More...

const EnumMember &	member (const std::string &name) const
	Gets a member by its name. More...

MemberIndex	find_member_by_name (const std::string &name) const
	Obtains the member index from its name. More...

std::vector< EnumMember >	members () const
	Gets a copy of all the members. More...

uint32_t	cdr_serialized_sample_max_size (dds::core::policy::DataRepresentationId representation_id=DDS_AUTO_DATA_REPRESENTATION) const
	Gets the maximum serialized size of samples of this type. More...

uint32_t	cdr_serialized_sample_min_size (dds::core::policy::DataRepresentationId representation_id=DDS_AUTO_DATA_REPRESENTATION) const
	Gets the minimum serialized size of samples of this type. More...

uint32_t	cdr_serialized_sample_key_max_size (dds::core::policy::DataRepresentationId representation_id=DDS_AUTO_DATA_REPRESENTATION) const
	Gets the maximum serialized size of sample keys of this type. 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...

Additional Inherited Members
Public Types inherited from dds::core::xtypes::AbstractConstructedType< EnumMember >
typedef EnumMember	Member
	The member type (specified by the subclasses of this class) More...

typedef uint32_t	MemberIndex
	The member index type. More...

Static Public Attributes inherited from dds::core::xtypes::AbstractConstructedType< EnumMember >
static OMG_DDS_API_CLASS_VARIABLE const MemberIndex	INVALID_INDEX
	Indicates that a member doesn't exist. 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 an IDL enum type

Examples: Foo.hpp.

Constructor & Destructor Documentation

◆ EnumType() [1/4]

dds::core::xtypes::EnumType::EnumType ( const std::string & name )

Creates an empty enum type.

Members can be added after creation.

Parameters

name	The name of the type

◆ EnumType() [2/4]

template<typename Container >

dds::core::xtypes::EnumType::EnumType	(	const std::string &	the_name,
		const Container &	the_members
	)

inline

Creates an enum with the members in a container.

Template Parameters

Container A container that provides the member functions begin() and end() to iterate over EnumMember elements.

Parameters

the_name	The name of the type
the_members	A container with the members for this enum type

◆ EnumType() [3/4]

template<typename MemberIter >

dds::core::xtypes::EnumType::EnumType	(	const std::string &	the_name,
		MemberIter	begin,
		MemberIter	end
	)

inline

Creates a enum with the members in an iterator range.

Template Parameters

MemberIter A forward iterator of EnumMember elements

Parameters

the_name	The name of the type
begin	The beginning of the range of EnumMembers
end	The end of the range of EnumMembers

◆ EnumType() [4/4]

dds::core::xtypes::EnumType::EnumType	(	const std::string &	the_name,
		std::initializer_list< EnumMember >	the_members
	)

Creates an enum with the members in an initializer_list.

Parameters

the_name	The name of the type
the_members	An ininitalizer_list of EnumMembers

Member Function Documentation

◆ find_member_by_ordinal()

MemberIndex dds::core::xtypes::EnumType::find_member_by_ordinal ( int32_t ordinal ) const

Gets the index of the member with this ordinal value.

Returns: The index (which can be passed to member(uint32_t) of the member with this ordinal value or INVALID_INDEX if that ordinal doesn't exist

◆ add_member()

EnumType & dds::core::xtypes::EnumType::add_member ( const EnumMember & member )

Adds a member at the end.

◆ add_members() [1/3]

template<typename Container >

EnumType & dds::core::xtypes::EnumType::add_members ( const Container & the_members )

inline

Adds all the members of a container at the end.

◆ add_members() [2/3]

EnumType & dds::core::xtypes::EnumType::add_members ( std::initializer_list< EnumMember > the_members )

Adds all the members of an initializer_list at the end.

◆ add_members() [3/3]

template<typename MemberIter >

EnumType & dds::core::xtypes::EnumType::add_members	(	MemberIter	begin,
		MemberIter	end
	)

inline

Adds all the members in an iterator range at the end.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EnumType() [1/4]

◆ EnumType() [2/4]

◆ EnumType() [3/4]

◆ EnumType() [4/4]

Member Function Documentation

◆ find_member_by_ordinal()

◆ add_member()

◆ add_members() [1/3]

◆ add_members() [2/3]

◆ add_members() [3/3]