CommonAnnotationParameter Class Reference

This class represents the structure CommonAnnotationParameter defined by the user in the IDL file. More...

#include <dds_xtypes_typeobject.hpp>

Public Member Functions
eProsima_user_DllExport	CommonAnnotationParameter ()
	Default constructor. More...
eProsima_user_DllExport	~CommonAnnotationParameter ()
	Default destructor. More...
eProsima_user_DllExport	CommonAnnotationParameter (const CommonAnnotationParameter &x)
	Copy constructor. More...
eProsima_user_DllExport	CommonAnnotationParameter (CommonAnnotationParameter &&x) noexcept
	Move constructor. More...
eProsima_user_DllExport CommonAnnotationParameter &	operator= (const CommonAnnotationParameter &x)
	Copy assignment. More...
eProsima_user_DllExport CommonAnnotationParameter &	operator= (CommonAnnotationParameter &&x) noexcept
	Move assignment. More...
eProsima_user_DllExport bool	operator== (const CommonAnnotationParameter &x) const
	Comparison operator. More...
eProsima_user_DllExport bool	operator!= (const CommonAnnotationParameter &x) const
	Comparison operator. More...
eProsima_user_DllExport void	member_flags (const AnnotationParameterFlag &_member_flags)
	This function copies the value in member member_flags. More...
eProsima_user_DllExport void	member_flags (AnnotationParameterFlag &&_member_flags)
	This function moves the value in member member_flags. More...
eProsima_user_DllExport const AnnotationParameterFlag &	member_flags () const
	This function returns a constant reference to member member_flags. More...
eProsima_user_DllExport AnnotationParameterFlag &	member_flags ()
	This function returns a reference to member member_flags. More...
eProsima_user_DllExport void	member_type_id (const TypeIdentifier &_member_type_id)
	This function copies the value in member member_type_id. More...
eProsima_user_DllExport void	member_type_id (TypeIdentifier &&_member_type_id)
	This function moves the value in member member_type_id. More...
eProsima_user_DllExport const TypeIdentifier &	member_type_id () const
	This function returns a constant reference to member member_type_id. More...
eProsima_user_DllExport TypeIdentifier &	member_type_id ()
	This function returns a reference to member member_type_id. More...

Detailed Description

This class represents the structure CommonAnnotationParameter defined by the user in the IDL file.

Constructor & Destructor Documentation

CommonAnnotationParameter() [1/3]

eProsima_user_DllExport CommonAnnotationParameter ( )

inline

Default constructor.

~CommonAnnotationParameter()

eProsima_user_DllExport ~CommonAnnotationParameter ( )

inline

Default destructor.

CommonAnnotationParameter() [2/3]

eProsima_user_DllExport CommonAnnotationParameter ( const CommonAnnotationParameter &  x )

inline

Copy constructor.

Parameters

x	Reference to the object CommonAnnotationParameter that will be copied.

CommonAnnotationParameter() [3/3]

eProsima_user_DllExport CommonAnnotationParameter ( CommonAnnotationParameter &&  x )

inlinenoexcept

Move constructor.

Parameters

x	Reference to the object CommonAnnotationParameter that will be copied.

Member Function Documentation

member_flags() [1/4]

eProsima_user_DllExport AnnotationParameterFlag& member_flags ( )

inline

This function returns a reference to member member_flags.

Returns

Reference to member member_flags

member_flags() [2/4]

eProsima_user_DllExport const AnnotationParameterFlag& member_flags ( ) const

inline

This function returns a constant reference to member member_flags.

Returns

Constant reference to member member_flags

member_flags() [3/4]

eProsima_user_DllExport void member_flags ( AnnotationParameterFlag &&  _member_flags )

inline

This function moves the value in member member_flags.

Parameters

_member_flags

New value to be moved in member member_flags

member_flags() [4/4]

eProsima_user_DllExport void member_flags ( const AnnotationParameterFlag &  _member_flags )

inline

This function copies the value in member member_flags.

Parameters

_member_flags

New value to be copied in member member_flags

member_type_id() [1/4]

eProsima_user_DllExport TypeIdentifier& member_type_id ( )

inline

This function returns a reference to member member_type_id.

Returns

Reference to member member_type_id

member_type_id() [2/4]

eProsima_user_DllExport const TypeIdentifier& member_type_id ( ) const

inline

This function returns a constant reference to member member_type_id.

Returns

Constant reference to member member_type_id

member_type_id() [3/4]

eProsima_user_DllExport void member_type_id ( const TypeIdentifier &  _member_type_id )

inline

This function copies the value in member member_type_id.

Parameters

_member_type_id

New value to be copied in member member_type_id

member_type_id() [4/4]

eProsima_user_DllExport void member_type_id ( TypeIdentifier &&  _member_type_id )

inline

This function moves the value in member member_type_id.

Parameters

_member_type_id

New value to be moved in member member_type_id

operator!=()

eProsima_user_DllExport bool operator!= ( const CommonAnnotationParameter &  x ) const

inline

Comparison operator.

Parameters

x	CommonAnnotationParameter object to compare.

operator=() [1/2]

eProsima_user_DllExport CommonAnnotationParameter& operator= ( CommonAnnotationParameter &&  x )

inlinenoexcept

Move assignment.

Parameters

x	Reference to the object CommonAnnotationParameter that will be copied.

operator=() [2/2]

eProsima_user_DllExport CommonAnnotationParameter& operator= ( const CommonAnnotationParameter &  x )

inline

Copy assignment.

Parameters

x	Reference to the object CommonAnnotationParameter that will be copied.

operator==()

eProsima_user_DllExport bool operator== ( const CommonAnnotationParameter &  x ) const

inline

Comparison operator.

Parameters

x	CommonAnnotationParameter object to compare.

---

The documentation for this class was generated from the following file:

• include/fastdds/dds/xtypes/type_representation/detail/dds_xtypes_typeobject.hpp