RTI Connext Modern C++ API Version 7.6.0
Public Member Functions | Static Public Member Functions | Related Functions | List of all members
rti::core::CoherentSetInfo Class Reference
RTI Connext DDS API Reference » Subscription Module » Data Samples

<<extension>> <<value-type>> A CoherentSampleInfo provides information about the coherent set associated with a sample. More...

#include "rti/core/CoherentSetInfo.hpp"

Public Member Functions

 CoherentSetInfo ()
 Create a default CoherentSampleInfo object. More...
 
 CoherentSetInfo (const Guid &the_group_guid, const SequenceNumber &the_coherent_set_sequence_number, const SequenceNumber &the_group_coherent_set_sequence_number, bool the_incomplete_coherent_set)
 Creates CoherentSampleInfo object with the specified parameters. More...
 
const Guid & group_guid () const
 Gets the coherent set group Guid. More...
 
Guid & group_guid ()
 Gets the coherent set group Guid. More...
 
CoherentSetInfo & group_guid (const Guid &value)
 Sets the coherent set group Guid. More...
 
const SequenceNumber & coherent_set_sequence_number () const
 Gets the coherent set sequence number that identifies a sample as part of a DataWriter coherent set. More...
 
SequenceNumber & coherent_set_sequence_number ()
 Gets the coherent set sequence number that identifies a sample as part of a DataWriter coherent set. More...
 
CoherentSetInfo & coherent_set_sequence_number (const SequenceNumber &value)
 Sets the coherent set sequence number that identifies a sample as part of a DataWriter coherent set. More...
 
const SequenceNumber & group_coherent_set_sequence_number () const
 Gets the group coherent set sequence number that identifies a sample as part of a group coherent set. More...
 
SequenceNumber & group_coherent_set_sequence_number ()
 Gets the group coherent set sequence number that identifies a sample as part of a group coherent set. More...
 
CoherentSetInfo & group_coherent_set_sequence_number (const SequenceNumber &value)
 Gets the group coherent set sequence number that identifies a sample as part of a group coherent set. More...
 
bool incomplete_coherent_set () const
 Indicates if a sample is part of an incomplete coherent set. More...
 
CoherentSetInfo & incomplete_coherent_set (bool value)
 Sets the incomplete coherent set status. More...
 

Static Public Member Functions

static CoherentSetInfo unknown ()
 An invalid or unknown coherent set info. More...
 

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &out, const CoherentSetInfo &csi)
 Prints a CoherentSetInfo to an output stream. More...
 

Detailed Description

<<extension>> <<value-type>> A CoherentSampleInfo provides information about the coherent set associated with a sample.

Constructor & Destructor Documentation

◆ CoherentSetInfo() [1/2]

rti::core::CoherentSetInfo::CoherentSetInfo ( )
inline

Create a default CoherentSampleInfo object.

◆ CoherentSetInfo() [2/2]

rti::core::CoherentSetInfo::CoherentSetInfo ( const Guid &  the_group_guid,
const SequenceNumber &  the_coherent_set_sequence_number,
const SequenceNumber &  the_group_coherent_set_sequence_number,
bool  the_incomplete_coherent_set 
)
inline

Creates CoherentSampleInfo object with the specified parameters.

Member Function Documentation

◆ group_guid() [1/3]

const Guid & rti::core::CoherentSetInfo::group_guid ( ) const
inline

Gets the coherent set group Guid.

This GUID identifies the dds::pub::DataWriter or the group of DataWriters publishing the coherent set, depending on the value of dds::core::policy::Presentation::access_scope in the dds::sub::Subscriber.

◆ group_guid() [2/3]

Guid & rti::core::CoherentSetInfo::group_guid ( )
inline

Gets the coherent set group Guid.

This GUID identifies the dds::pub::DataWriter or the group of DataWriters publishing the coherent set, depending on the value of dds::core::policy::Presentation::access_scope in the dds::sub::Subscriber.

◆ group_guid() [3/3]

CoherentSetInfo & rti::core::CoherentSetInfo::group_guid ( const Guid &  value)
inline

Sets the coherent set group Guid.

This GUID identifies the dds::pub::DataWriter or the group of DataWriters publishing the coherent set, depending on the value of dds::core::policy::Presentation::access_scope in the dds::sub::Subscriber.

◆ coherent_set_sequence_number() [1/3]

const SequenceNumber & rti::core::CoherentSetInfo::coherent_set_sequence_number ( ) const
inline

Gets the coherent set sequence number that identifies a sample as part of a DataWriter coherent set.

When dds::core::policy::Presentation::access_scope in the dds::sub::Subscriber is set to dds::core::policy::PresentationAccessScopeKind_def::INSTANCE or dds::core::policy::PresentationAccessScopeKind_def::TOPIC, the coherent set associated with a sample is identified by the pair (group_guid, coherent_set_sequence_number).

◆ coherent_set_sequence_number() [2/3]

SequenceNumber & rti::core::CoherentSetInfo::coherent_set_sequence_number ( )
inline

Gets the coherent set sequence number that identifies a sample as part of a DataWriter coherent set.

When dds::core::policy::Presentation::access_scope in the dds::sub::Subscriber is set to dds::core::policy::PresentationAccessScopeKind_def::INSTANCE or dds::core::policy::PresentationAccessScopeKind_def::TOPIC, the coherent set associated with a sample is identified by the pair (group_guid, coherent_set_sequence_number).

◆ coherent_set_sequence_number() [3/3]

CoherentSetInfo & rti::core::CoherentSetInfo::coherent_set_sequence_number ( const SequenceNumber &  value)
inline

Sets the coherent set sequence number that identifies a sample as part of a DataWriter coherent set.

This GUID identifies the dds::pub::DataWriter or the group of DataWriters publishing the coherent set, depending on the value of dds::core::policy::Presentation::access_scope in the dds::sub::Subscriber.

◆ group_coherent_set_sequence_number() [1/3]

const SequenceNumber & rti::core::CoherentSetInfo::group_coherent_set_sequence_number ( ) const
inline

Gets the group coherent set sequence number that identifies a sample as part of a group coherent set.

When dds::core::policy::Presentation::access_scope in the dds::sub::Subscriber is set to dds::core::policy::PresentationAccessScopeKind_def::GROUP, the coherent set associated with a sample is identified by the pair (group_guid, group_coherent_set_sequence_number).

◆ group_coherent_set_sequence_number() [2/3]

SequenceNumber & rti::core::CoherentSetInfo::group_coherent_set_sequence_number ( )
inline

Gets the group coherent set sequence number that identifies a sample as part of a group coherent set.

When dds::core::policy::Presentation::access_scope in the dds::sub::Subscriber is set to dds::core::policy::PresentationAccessScopeKind_def::GROUP, the coherent set associated with a sample is identified by the pair (group_guid, group_coherent_set_sequence_number).

◆ group_coherent_set_sequence_number() [3/3]

CoherentSetInfo & rti::core::CoherentSetInfo::group_coherent_set_sequence_number ( const SequenceNumber &  value)
inline

Gets the group coherent set sequence number that identifies a sample as part of a group coherent set.

This GUID identifies the dds::pub::DataWriter or the group of DataWriters publishing the coherent set, depending on the value of dds::core::policy::Presentation::access_scope in the dds::sub::Subscriber.

◆ incomplete_coherent_set() [1/2]

bool rti::core::CoherentSetInfo::incomplete_coherent_set ( ) const
inline

Indicates if a sample is part of an incomplete coherent set.

◆ incomplete_coherent_set() [2/2]

CoherentSetInfo & rti::core::CoherentSetInfo::incomplete_coherent_set ( bool  value)
inline

Sets the incomplete coherent set status.

◆ unknown()

static CoherentSetInfo rti::core::CoherentSetInfo::unknown ( )
inlinestatic

An invalid or unknown coherent set info.

Friends And Related Function Documentation

◆ operator<<()

std::ostream & operator<< ( std::ostream &  out,
const CoherentSetInfo &  csi 
)
related

Prints a CoherentSetInfo to an output stream.