Fast RTPS  Version 2.6.1
Fast RTPS
PlainArraySElemDefn Class Referencefinal

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

#include <TypeIdentifierTypes.h>

Public Member Functions

RTPS_DllAPI PlainArraySElemDefn ()
 Default constructor. More...
 
RTPS_DllAPI ~PlainArraySElemDefn ()
 Default destructor. More...
 
RTPS_DllAPI PlainArraySElemDefn (const PlainArraySElemDefn &x)
 Copy constructor. More...
 
RTPS_DllAPI PlainArraySElemDefn (PlainArraySElemDefn &&x)
 Move constructor. More...
 
RTPS_DllAPI PlainArraySElemDefnoperator= (const PlainArraySElemDefn &x)
 Copy assignment. More...
 
RTPS_DllAPI PlainArraySElemDefnoperator= (PlainArraySElemDefn &&x)
 Move assignment. More...
 
RTPS_DllAPI void header (const PlainCollectionHeader &_header)
 This function copies the value in member header. More...
 
RTPS_DllAPI void header (PlainCollectionHeader &&_header)
 This function moves the value in member header. More...
 
RTPS_DllAPI const PlainCollectionHeaderheader () const
 This function returns a constant reference to member header. More...
 
RTPS_DllAPI PlainCollectionHeaderheader ()
 This function returns a reference to member header. More...
 
RTPS_DllAPI void array_bound_seq (const SBoundSeq &_array_bound_seq)
 This function copies the value in member array_bound_seq. More...
 
RTPS_DllAPI void array_bound_seq (SBoundSeq &&_array_bound_seq)
 This function moves the value in member array_bound_seq. More...
 
RTPS_DllAPI const SBoundSeqarray_bound_seq () const
 This function returns a constant reference to member array_bound_seq. More...
 
RTPS_DllAPI SBoundSeqarray_bound_seq ()
 This function returns a reference to member array_bound_seq. More...
 
RTPS_DllAPI void element_identifier (const TypeIdentifier *_element_identifier)
 This function sets a value in member element_identifier. More...
 
RTPS_DllAPI const TypeIdentifierelement_identifier () const
 This function returns the value of member element_identifier. More...
 
RTPS_DllAPI TypeIdentifierelement_identifier ()
 This function returns a reference to member element_identifier. More...
 
RTPS_DllAPI void serialize (eprosima::fastcdr::Cdr &cdr) const
 This function serializes an object using CDR serialization. More...
 
RTPS_DllAPI void deserialize (eprosima::fastcdr::Cdr &cdr)
 This function deserializes an object using CDR serialization. More...
 
RTPS_DllAPI bool consistent (const PlainArraySElemDefn &x, const fastdds::dds::TypeConsistencyEnforcementQosPolicy &consistency) const
 

Static Public Member Functions

static RTPS_DllAPI size_t getCdrSerializedSize (const PlainArraySElemDefn &data, size_t current_alignment=0)
 This function returns the serialized size of a data depending on the buffer alignment. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ PlainArraySElemDefn() [1/3]

RTPS_DllAPI PlainArraySElemDefn ( )

Default constructor.

◆ ~PlainArraySElemDefn()

RTPS_DllAPI ~PlainArraySElemDefn ( )

Default destructor.

◆ PlainArraySElemDefn() [2/3]

RTPS_DllAPI PlainArraySElemDefn ( const PlainArraySElemDefn x)

Copy constructor.

Parameters
xReference to the object PlainArraySElemDefn that will be copied.

◆ PlainArraySElemDefn() [3/3]

Move constructor.

Parameters
xReference to the object PlainArraySElemDefn that will be copied.

Member Function Documentation

◆ array_bound_seq() [1/4]

RTPS_DllAPI SBoundSeq& array_bound_seq ( )
inline

This function returns a reference to member array_bound_seq.

Returns
Reference to member array_bound_seq

◆ array_bound_seq() [2/4]

RTPS_DllAPI const SBoundSeq& array_bound_seq ( ) const
inline

This function returns a constant reference to member array_bound_seq.

Returns
Constant reference to member array_bound_seq

◆ array_bound_seq() [3/4]

RTPS_DllAPI void array_bound_seq ( const SBoundSeq _array_bound_seq)
inline

This function copies the value in member array_bound_seq.

Parameters
_array_bound_seqNew value to be copied in member array_bound_seq

◆ array_bound_seq() [4/4]

RTPS_DllAPI void array_bound_seq ( SBoundSeq &&  _array_bound_seq)
inline

This function moves the value in member array_bound_seq.

Parameters
_array_bound_seqNew value to be moved in member array_bound_seq

◆ consistent()

RTPS_DllAPI bool consistent ( const PlainArraySElemDefn x,
const fastdds::dds::TypeConsistencyEnforcementQosPolicy &  consistency 
) const

◆ deserialize()

RTPS_DllAPI void deserialize ( eprosima::fastcdr::Cdr &  cdr)

This function deserializes an object using CDR serialization.

Parameters
cdrCDR serialization object.

◆ element_identifier() [1/3]

RTPS_DllAPI TypeIdentifier* element_identifier ( )
inline

This function returns a reference to member element_identifier.

Returns
Reference to member element_identifier

◆ element_identifier() [2/3]

RTPS_DllAPI const TypeIdentifier* element_identifier ( ) const
inline

This function returns the value of member element_identifier.

Returns
Value of member element_identifier

◆ element_identifier() [3/3]

RTPS_DllAPI void element_identifier ( const TypeIdentifier _element_identifier)

This function sets a value in member element_identifier.

Parameters
_element_identifierNew value for member element_identifier

◆ getCdrSerializedSize()

static RTPS_DllAPI size_t getCdrSerializedSize ( const PlainArraySElemDefn data,
size_t  current_alignment = 0 
)
static

This function returns the serialized size of a data depending on the buffer alignment.

Parameters
dataData which is calculated its serialized size.
current_alignmentBuffer alignment.
Returns
Serialized size.

◆ header() [1/4]

RTPS_DllAPI PlainCollectionHeader& header ( )
inline

This function returns a reference to member header.

Returns
Reference to member header

◆ header() [2/4]

RTPS_DllAPI const PlainCollectionHeader& header ( ) const
inline

This function returns a constant reference to member header.

Returns
Constant reference to member header

◆ header() [3/4]

RTPS_DllAPI void header ( const PlainCollectionHeader _header)
inline

This function copies the value in member header.

Parameters
_headerNew value to be copied in member header

◆ header() [4/4]

RTPS_DllAPI void header ( PlainCollectionHeader &&  _header)
inline

This function moves the value in member header.

Parameters
_headerNew value to be moved in member header

◆ operator=() [1/2]

RTPS_DllAPI PlainArraySElemDefn& operator= ( const PlainArraySElemDefn x)

Copy assignment.

Parameters
xReference to the object PlainArraySElemDefn that will be copied.

◆ operator=() [2/2]

RTPS_DllAPI PlainArraySElemDefn& operator= ( PlainArraySElemDefn &&  x)

Move assignment.

Parameters
xReference to the object PlainArraySElemDefn that will be copied.

◆ serialize()

RTPS_DllAPI void serialize ( eprosima::fastcdr::Cdr &  cdr) const

This function serializes an object using CDR serialization.

Parameters
cdrCDR serialization object.

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