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

This class contains additional information of a CacheChange. More...

#include <WriteParams.hpp>

Public Member Functions

WriteParamssample_identity (const SampleIdentity &sample_id)
 Set the value of the sample_identity member.
 
WriteParamssample_identity (SampleIdentity &&sample_id)
 Set the value of the sample_identity member.
 
const SampleIdentitysample_identity () const
 Get the value of the sample_identity member.
 
SampleIdentitysample_identity ()
 Set the value of the sample_identity member.
 
WriteParamsrelated_sample_identity (const SampleIdentity &sample_id)
 Set the value of the related_sample_identity member of this class.
 
WriteParamsrelated_sample_identity (SampleIdentity &&sample_id)
 Set the related_sample_identity member of this class.
 
const SampleIdentityrelated_sample_identity () const
 Get the value of the related_sample_identity member.
 
SampleIdentityrelated_sample_identity ()
 Set the value of the related_sample_identity member.
 
Time_t source_timestamp () const
 Get the value of the source_timestamp member.
 
Time_tsource_timestamp ()
 Set the value of the source_timestamp member.
 
WriteParamssource_timestamp (const Time_t &timestamp)
 Set the source_timestamp member of this class.
 
WriteParamssource_timestamp (Time_t &&timestamp)
 Set the source_timestamp member of this class.
 

Static Public Member Functions

static WriteParams write_params_default () noexcept
 Default value for methods receiving a WriteParams.
 

Static Public Attributes

static WriteParams WRITE_PARAM_DEFAULT
 

Detailed Description

This class contains additional information of a CacheChange.

Member Function Documentation

◆ related_sample_identity() [1/4]

SampleIdentity & related_sample_identity ( )
inline

Set the value of the related_sample_identity member.

Returns
Reference to the related_sample_identity member.

◆ related_sample_identity() [2/4]

const SampleIdentity & related_sample_identity ( ) const
inline

Get the value of the related_sample_identity member.

Returns
Constant reference to the related_sample_identity member.

◆ related_sample_identity() [3/4]

WriteParams & related_sample_identity ( const SampleIdentity sample_id)
inline

Set the value of the related_sample_identity member of this class.

Parameters
sample_idNew value for the related_sample_identity member.
Returns
Reference to the modified object in order to allow daisy chaining.

◆ related_sample_identity() [4/4]

WriteParams & related_sample_identity ( SampleIdentity &&  sample_id)
inline

Set the related_sample_identity member of this class.

Parameters
sample_idNew value for the related_sample_identity member.
Returns
Reference to the modified object in order to allow daisy chaining.

◆ sample_identity() [1/4]

SampleIdentity & sample_identity ( )
inline

Set the value of the sample_identity member.

Returns
Reference to the sample_identity member.

◆ sample_identity() [2/4]

const SampleIdentity & sample_identity ( ) const
inline

Get the value of the sample_identity member.

Returns
Constant reference to the sample_identity member.

◆ sample_identity() [3/4]

WriteParams & sample_identity ( const SampleIdentity sample_id)
inline

Set the value of the sample_identity member.

Parameters
sample_idNew value for the sample_identity member.
Returns
Reference to the modified object in order to allow daisy chaining.

◆ sample_identity() [4/4]

WriteParams & sample_identity ( SampleIdentity &&  sample_id)
inline

Set the value of the sample_identity member.

Parameters
sample_idNew value for the sample_identity member.
Returns
Reference to the modified object in order to allow daisy chaining.

◆ source_timestamp() [1/4]

Time_t & source_timestamp ( )
inline

Set the value of the source_timestamp member.

Returns
Reference to the source_timestamp member.

◆ source_timestamp() [2/4]

Time_t source_timestamp ( ) const
inline

Get the value of the source_timestamp member.

Returns
Current value of the source_timestamp member.

◆ source_timestamp() [3/4]

WriteParams & source_timestamp ( const Time_t timestamp)
inline

Set the source_timestamp member of this class.

Parameters
timestampNew value for the source_timestamp member.
Returns
Reference to the modified object in order to allow daisy chaining.

◆ source_timestamp() [4/4]

WriteParams & source_timestamp ( Time_t &&  timestamp)
inline

Set the source_timestamp member of this class.

Parameters
timestampNew value for the source_timestamp member.
Returns
Reference to the modified object in order to allow daisy chaining.

◆ write_params_default()

static WriteParams write_params_default ( )
inlinestaticnoexcept

Default value for methods receiving a WriteParams.

Will contain the following values on its members:

Note
This should not return a reference to the static value if this value is meant to be read and written from different threads.

Member Data Documentation

◆ WRITE_PARAM_DEFAULT

WriteParams WRITE_PARAM_DEFAULT
static

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