Fast DDS  Version 3.1.0
Fast DDS
Loading...
Searching...
No Matches
CompleteAnnotationParameter Class Reference

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

#include <dds_xtypes_typeobject.hpp>

Public Member Functions

eProsima_user_DllExport CompleteAnnotationParameter ()
 Default constructor.
 
eProsima_user_DllExport ~CompleteAnnotationParameter ()
 Default destructor.
 
eProsima_user_DllExport CompleteAnnotationParameter (const CompleteAnnotationParameter &x)
 Copy constructor.
 
eProsima_user_DllExport CompleteAnnotationParameter (CompleteAnnotationParameter &&x) noexcept
 Move constructor.
 
eProsima_user_DllExport CompleteAnnotationParameteroperator= (const CompleteAnnotationParameter &x)
 Copy assignment.
 
eProsima_user_DllExport CompleteAnnotationParameteroperator= (CompleteAnnotationParameter &&x) noexcept
 Move assignment.
 
eProsima_user_DllExport bool operator== (const CompleteAnnotationParameter &x) const
 Comparison operator.
 
eProsima_user_DllExport bool operator!= (const CompleteAnnotationParameter &x) const
 Comparison operator.
 
eProsima_user_DllExport void common (const CommonAnnotationParameter &_common)
 This function copies the value in member common.
 
eProsima_user_DllExport void common (CommonAnnotationParameter &&_common)
 This function moves the value in member common.
 
eProsima_user_DllExport const CommonAnnotationParametercommon () const
 This function returns a constant reference to member common.
 
eProsima_user_DllExport CommonAnnotationParametercommon ()
 This function returns a reference to member common.
 
eProsima_user_DllExport void name (const MemberName &_name)
 This function copies the value in member name.
 
eProsima_user_DllExport void name (MemberName &&_name)
 This function moves the value in member name.
 
eProsima_user_DllExport const MemberNamename () const
 This function returns a constant reference to member name.
 
eProsima_user_DllExport MemberNamename ()
 This function returns a reference to member name.
 
eProsima_user_DllExport void default_value (const AnnotationParameterValue &_default_value)
 This function copies the value in member default_value.
 
eProsima_user_DllExport void default_value (AnnotationParameterValue &&_default_value)
 This function moves the value in member default_value.
 
eProsima_user_DllExport const AnnotationParameterValuedefault_value () const
 This function returns a constant reference to member default_value.
 
eProsima_user_DllExport AnnotationParameterValuedefault_value ()
 This function returns a reference to member default_value.
 

Detailed Description

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

Constructor & Destructor Documentation

◆ CompleteAnnotationParameter() [1/3]

eProsima_user_DllExport CompleteAnnotationParameter ( )
inline

Default constructor.

◆ ~CompleteAnnotationParameter()

eProsima_user_DllExport ~CompleteAnnotationParameter ( )
inline

Default destructor.

◆ CompleteAnnotationParameter() [2/3]

eProsima_user_DllExport CompleteAnnotationParameter ( const CompleteAnnotationParameter x)
inline

Copy constructor.

Parameters
xReference to the object CompleteAnnotationParameter that will be copied.

◆ CompleteAnnotationParameter() [3/3]

eProsima_user_DllExport CompleteAnnotationParameter ( CompleteAnnotationParameter &&  x)
inlinenoexcept

Move constructor.

Parameters
xReference to the object CompleteAnnotationParameter that will be copied.

Member Function Documentation

◆ common() [1/4]

eProsima_user_DllExport CommonAnnotationParameter & common ( )
inline

This function returns a reference to member common.

Returns
Reference to member common

◆ common() [2/4]

eProsima_user_DllExport const CommonAnnotationParameter & common ( ) const
inline

This function returns a constant reference to member common.

Returns
Constant reference to member common

◆ common() [3/4]

eProsima_user_DllExport void common ( CommonAnnotationParameter &&  _common)
inline

This function moves the value in member common.

Parameters
_commonNew value to be moved in member common

◆ common() [4/4]

eProsima_user_DllExport void common ( const CommonAnnotationParameter _common)
inline

This function copies the value in member common.

Parameters
_commonNew value to be copied in member common

◆ default_value() [1/4]

eProsima_user_DllExport AnnotationParameterValue & default_value ( )
inline

This function returns a reference to member default_value.

Returns
Reference to member default_value

◆ default_value() [2/4]

eProsima_user_DllExport const AnnotationParameterValue & default_value ( ) const
inline

This function returns a constant reference to member default_value.

Returns
Constant reference to member default_value

◆ default_value() [3/4]

eProsima_user_DllExport void default_value ( AnnotationParameterValue &&  _default_value)
inline

This function moves the value in member default_value.

Parameters
_default_valueNew value to be moved in member default_value

◆ default_value() [4/4]

eProsima_user_DllExport void default_value ( const AnnotationParameterValue _default_value)
inline

This function copies the value in member default_value.

Parameters
_default_valueNew value to be copied in member default_value

◆ name() [1/4]

eProsima_user_DllExport MemberName & name ( )
inline

This function returns a reference to member name.

Returns
Reference to member name

◆ name() [2/4]

eProsima_user_DllExport const MemberName & name ( ) const
inline

This function returns a constant reference to member name.

Returns
Constant reference to member name

◆ name() [3/4]

eProsima_user_DllExport void name ( const MemberName _name)
inline

This function copies the value in member name.

Parameters
_nameNew value to be copied in member name

◆ name() [4/4]

eProsima_user_DllExport void name ( MemberName &&  _name)
inline

This function moves the value in member name.

Parameters
_nameNew value to be moved in member name

◆ operator!=()

eProsima_user_DllExport bool operator!= ( const CompleteAnnotationParameter x) const
inline

Comparison operator.

Parameters
xCompleteAnnotationParameter object to compare.

◆ operator=() [1/2]

eProsima_user_DllExport CompleteAnnotationParameter & operator= ( CompleteAnnotationParameter &&  x)
inlinenoexcept

Move assignment.

Parameters
xReference to the object CompleteAnnotationParameter that will be copied.

◆ operator=() [2/2]

eProsima_user_DllExport CompleteAnnotationParameter & operator= ( const CompleteAnnotationParameter x)
inline

Copy assignment.

Parameters
xReference to the object CompleteAnnotationParameter that will be copied.

◆ operator==()

eProsima_user_DllExport bool operator== ( const CompleteAnnotationParameter x) const
inline

Comparison operator.

Parameters
xCompleteAnnotationParameter object to compare.

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