dds::core::xtypes::Member Class Reference

<<value-type>> Represents a StructType member More...

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

Public Member Functions
	Member (const std::string &name, const DynamicTypeImpl &type)
	Creates a member consisting of a name and a type.
	Member (const std::string &name, DynamicTypeImpl &&type)
	<<C++11>> Creates a member consisting of a name and a type.
const dds::core::string &	name () const
	Gets the name.
dds::core::string &	name ()
	Gets the member name.
const DynamicType &	type ()
	Gets the member type.
bool	is_key () const
	Checks if a member is a key.
bool	is_optional () const
	Checks if a member is optional.
bool	is_bitset () const
	Checks if a member is a bitset.
bool	has_bitbound () const
	Unsupported, always returns false.
int32_t	get_bitbound () const
	Unsupported, always returns 32.
Member &	name (const dds::core::string &value)
	Sets the member name.
Member &	key (bool value)
	Sets the key annotation of a member.
Member &	optional (bool value)
	Sets the optional annotation of a member.
Member &	id (int32_t value)
	Sets the ID annotation of a member.
Member &	pointer (bool value)
	<<extension>> Makes a member a pointer

Detailed Description

<<value-type>> Represents a StructType member

Encapsulates the name and type of a StructType member along with several IDL annotations (key, optional, bitset, bitbound, id).

Constructor & Destructor Documentation

dds::core::xtypes::Member::Member	(	const std::string &	name,
		const DynamicTypeImpl &	type
	)

Creates a member consisting of a name and a type.

dds::core::xtypes::Member::Member ( const std::string &  name, DynamicTypeImpl &&  type  )

inline

<<C++11>> Creates a member consisting of a name and a type.

The type is moved.

Member Function Documentation

const dds::core::string& dds::core::xtypes::Member::name

(

)

const

Gets the name.

dds::core::string& dds::core::xtypes::Member::name

(

)

Gets the member name.

const DynamicType& dds::core::xtypes::Member::type

(

)

Gets the member type.

bool dds::core::xtypes::Member::is_key

(

)

const

Checks if a member is a key.

This corresponds to the @Key IDL member annotation

bool dds::core::xtypes::Member::is_optional

(

)

const

Checks if a member is optional.

This corresponds to the @Optional IDL member annotation

bool dds::core::xtypes::Member::is_bitset

(

)

const

Checks if a member is a bitset.

bool dds::core::xtypes::Member::has_bitbound

(

)

const

Unsupported, always returns false.

int32_t dds::core::xtypes::Member::get_bitbound

(

)

const

Unsupported, always returns 32.

Member& dds::core::xtypes::Member::name

(

const dds::core::string &

value

)

Sets the member name.

Member& dds::core::xtypes::Member::key

(

bool

value

)

Sets the key annotation of a member.

Postcondition

If optional() was true and key is set to true, optional() becomes false, because a member can't be both a key and optional.

[default] false

Member& dds::core::xtypes::Member::optional

(

bool

value

)

Sets the optional annotation of a member.

Postcondition

If key() was true and optional is set to true, key() becomes false, because a member can't be both a key and optional.

[default] false

Member& dds::core::xtypes::Member::id

(

int32_t

value

)

Sets the ID annotation of a member.

[default] Automatically assigned as the ID of the previous member plus one previous member

Member& dds::core::xtypes::Member::pointer

(

bool

value

)

<<extension>> Makes a member a pointer

[default] false