Fast RTPS  Version 2.7.1
Fast RTPS
StronglyConnectedComponentId Class Referencefinal

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

#include <TypeIdentifierTypes.h>

Public Member Functions

RTPS_DllAPI StronglyConnectedComponentId ()
 Default constructor. More...
 
RTPS_DllAPI ~StronglyConnectedComponentId ()
 Default destructor. More...
 
RTPS_DllAPI StronglyConnectedComponentId (const StronglyConnectedComponentId &x)
 Copy constructor. More...
 
RTPS_DllAPI StronglyConnectedComponentId (StronglyConnectedComponentId &&x)
 Move constructor. More...
 
RTPS_DllAPI StronglyConnectedComponentIdoperator= (const StronglyConnectedComponentId &x)
 Copy assignment. More...
 
RTPS_DllAPI StronglyConnectedComponentIdoperator= (StronglyConnectedComponentId &&x)
 Move assignment. More...
 
RTPS_DllAPI void sc_component_id (const TypeObjectHashId &_sc_component_id)
 This function copies the value in member sc_component_id. More...
 
RTPS_DllAPI void sc_component_id (TypeObjectHashId &&_sc_component_id)
 This function moves the value in member sc_component_id. More...
 
RTPS_DllAPI const TypeObjectHashIdsc_component_id () const
 This function returns a constant reference to member sc_component_id. More...
 
RTPS_DllAPI TypeObjectHashIdsc_component_id ()
 This function returns a reference to member sc_component_id. More...
 
RTPS_DllAPI void scc_length (int32_t _scc_length)
 This function sets a value in member scc_length. More...
 
RTPS_DllAPI int32_t scc_length () const
 This function returns the value of member scc_length. More...
 
RTPS_DllAPI int32_t & scc_length ()
 This function returns a reference to member scc_length. More...
 
RTPS_DllAPI void scc_index (int32_t _scc_index)
 This function sets a value in member scc_index. More...
 
RTPS_DllAPI int32_t scc_index () const
 This function returns the value of member scc_index. More...
 
RTPS_DllAPI int32_t & scc_index ()
 This function returns a reference to member scc_index. 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 StronglyConnectedComponentId &x, const fastdds::dds::TypeConsistencyEnforcementQosPolicy &consistency) const
 

Static Public Member Functions

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

Constructor & Destructor Documentation

◆ StronglyConnectedComponentId() [1/3]

Default constructor.

◆ ~StronglyConnectedComponentId()

RTPS_DllAPI ~StronglyConnectedComponentId ( )

Default destructor.

◆ StronglyConnectedComponentId() [2/3]

Copy constructor.

Parameters
xReference to the object StronglyConnectedComponentId that will be copied.

◆ StronglyConnectedComponentId() [3/3]

Move constructor.

Parameters
xReference to the object StronglyConnectedComponentId that will be copied.

Member Function Documentation

◆ consistent()

RTPS_DllAPI bool consistent ( const StronglyConnectedComponentId 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 StronglyConnectedComponentId 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 StronglyConnectedComponentId& operator= ( const StronglyConnectedComponentId x)

Copy assignment.

Parameters
xReference to the object StronglyConnectedComponentId that will be copied.

◆ operator=() [2/2]

Move assignment.

Parameters
xReference to the object StronglyConnectedComponentId that will be copied.

◆ sc_component_id() [1/4]

RTPS_DllAPI TypeObjectHashId& sc_component_id ( )
inline

This function returns a reference to member sc_component_id.

Returns
Reference to member sc_component_id

◆ sc_component_id() [2/4]

RTPS_DllAPI const TypeObjectHashId& sc_component_id ( ) const
inline

This function returns a constant reference to member sc_component_id.

Returns
Constant reference to member sc_component_id

◆ sc_component_id() [3/4]

RTPS_DllAPI void sc_component_id ( const TypeObjectHashId _sc_component_id)
inline

This function copies the value in member sc_component_id.

Parameters
_sc_component_idNew value to be copied in member sc_component_id

◆ sc_component_id() [4/4]

RTPS_DllAPI void sc_component_id ( TypeObjectHashId &&  _sc_component_id)
inline

This function moves the value in member sc_component_id.

Parameters
_sc_component_idNew value to be moved in member sc_component_id

◆ scc_index() [1/3]

RTPS_DllAPI int32_t& scc_index ( )
inline

This function returns a reference to member scc_index.

Returns
Reference to member scc_index

◆ scc_index() [2/3]

RTPS_DllAPI int32_t scc_index ( ) const
inline

This function returns the value of member scc_index.

Returns
Value of member scc_index

◆ scc_index() [3/3]

RTPS_DllAPI void scc_index ( int32_t  _scc_index)
inline

This function sets a value in member scc_index.

Parameters
_scc_indexNew value for member scc_index

◆ scc_length() [1/3]

RTPS_DllAPI int32_t& scc_length ( )
inline

This function returns a reference to member scc_length.

Returns
Reference to member scc_length

◆ scc_length() [2/3]

RTPS_DllAPI int32_t scc_length ( ) const
inline

This function returns the value of member scc_length.

Returns
Value of member scc_length

◆ scc_length() [3/3]

RTPS_DllAPI void scc_length ( int32_t  _scc_length)
inline

This function sets a value in member scc_length.

Parameters
_scc_lengthNew value for member scc_length

◆ 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: