Fast RTPS  Version 2.6.1
Fast RTPS
StringSTypeDefn Class Referencefinal

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

#include <TypeIdentifierTypes.h>

Public Member Functions

RTPS_DllAPI StringSTypeDefn ()
 Default constructor. More...
 
RTPS_DllAPI ~StringSTypeDefn ()
 Default destructor. More...
 
RTPS_DllAPI StringSTypeDefn (const StringSTypeDefn &x)
 Copy constructor. More...
 
RTPS_DllAPI StringSTypeDefn (StringSTypeDefn &&x)
 Move constructor. More...
 
RTPS_DllAPI StringSTypeDefnoperator= (const StringSTypeDefn &x)
 Copy assignment. More...
 
RTPS_DllAPI StringSTypeDefnoperator= (StringSTypeDefn &&x)
 Move assignment. More...
 
RTPS_DllAPI void bound (SBound _bound)
 This function sets a value in member bound. More...
 
RTPS_DllAPI SBound bound () const
 This function returns the value of member bound. More...
 
RTPS_DllAPI SBoundbound ()
 This function returns a reference to member bound. 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 StringSTypeDefn &x, const fastdds::dds::TypeConsistencyEnforcementQosPolicy &consistency) const
 
RTPS_DllAPI bool consistent (const StringLTypeDefn &x, const fastdds::dds::TypeConsistencyEnforcementQosPolicy &consistency) const
 

Static Public Member Functions

static RTPS_DllAPI size_t getCdrSerializedSize (const StringSTypeDefn &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 StringSTypeDefn defined by the user in the IDL file.

Constructor & Destructor Documentation

◆ StringSTypeDefn() [1/3]

RTPS_DllAPI StringSTypeDefn ( )

Default constructor.

◆ ~StringSTypeDefn()

RTPS_DllAPI ~StringSTypeDefn ( )

Default destructor.

◆ StringSTypeDefn() [2/3]

RTPS_DllAPI StringSTypeDefn ( const StringSTypeDefn x)

Copy constructor.

Parameters
xReference to the object StringSTypeDefn that will be copied.

◆ StringSTypeDefn() [3/3]

RTPS_DllAPI StringSTypeDefn ( StringSTypeDefn &&  x)

Move constructor.

Parameters
xReference to the object StringSTypeDefn that will be copied.

Member Function Documentation

◆ bound() [1/3]

RTPS_DllAPI SBound& bound ( )
inline

This function returns a reference to member bound.

Returns
Reference to member bound

◆ bound() [2/3]

RTPS_DllAPI SBound bound ( ) const
inline

This function returns the value of member bound.

Returns
Value of member bound

◆ bound() [3/3]

RTPS_DllAPI void bound ( SBound  _bound)
inline

This function sets a value in member bound.

Parameters
_boundNew value for member bound

◆ consistent() [1/2]

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

◆ consistent() [2/2]

RTPS_DllAPI bool consistent ( const StringSTypeDefn 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.

◆ getCdrSerializedSize()

static RTPS_DllAPI size_t getCdrSerializedSize ( const StringSTypeDefn 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.

◆ operator=() [1/2]

RTPS_DllAPI StringSTypeDefn& operator= ( const StringSTypeDefn x)

Copy assignment.

Parameters
xReference to the object StringSTypeDefn that will be copied.

◆ operator=() [2/2]

RTPS_DllAPI StringSTypeDefn& operator= ( StringSTypeDefn &&  x)

Move assignment.

Parameters
xReference to the object StringSTypeDefn 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: