Cyclone ISO C++ API Reference Guide
dds::core::status::SampleRejectedState Class Reference

Class to contain the statistics about samples that have been rejected. More...

#include "State.hpp"

Inherits std::bitset< Bits >.

Public Types

typedef std::bitset< OMG_DDS_STATE_BIT_COUNTMaskType
 

Public Member Functions

 SampleRejectedState ()
 
 SampleRejectedState (const MaskType &src)
 
 SampleRejectedState (const SampleRejectedState &src)
 

Static Public Member Functions

static SampleRejectedState not_rejected ()
 
static SampleRejectedState rejected_by_instances_limit ()
 
static SampleRejectedState rejected_by_samples_limit ()
 
static SampleRejectedState rejected_by_samples_per_instance_limit ()
 

Detailed Description

Class to contain the statistics about samples that have been rejected.

See also
SampleInfo for more information

Definition at line 40 of file State.hpp.

Member Typedef Documentation

◆ MaskType

Convenience typedef for std::bitset<OMG_DDS_STATE_BIT_COUNT>.

Definition at line 46 of file State.hpp.

Constructor & Destructor Documentation

◆ SampleRejectedState() [1/3]

dds::core::status::SampleRejectedState::SampleRejectedState ( )

Construct an empty SampleRejectedState.

◆ SampleRejectedState() [2/3]

dds::core::status::SampleRejectedState::SampleRejectedState ( const SampleRejectedState src)

Copy constructor.

Construct an SampleRejectedState with existing SampleRejectedState.

Parameters
srcthe SampleRejectedState to copy from

◆ SampleRejectedState() [3/3]

dds::core::status::SampleRejectedState::SampleRejectedState ( const MaskType src)

Construct a SampleRejectedState with existing MaskType.

Parameters
srcthe MaskType to copy from

Member Function Documentation

◆ not_rejected()

static SampleRejectedState dds::core::status::SampleRejectedState::not_rejected ( )
inlinestatic

Get the NOT_REJECTED.

not_rejected

  • No sample has been rejected yet.
Returns
the not_rejected SampleRejectedState

Definition at line 79 of file State.hpp.

◆ rejected_by_instances_limit()

static SampleRejectedState dds::core::status::SampleRejectedState::rejected_by_instances_limit ( )
inlinestatic

Get the REJECTED_BY_INSTANCES_LIMIT.

rejected_by_instances_limit

  • The sample was rejected because it would exceed the maximum number of instances set by the ResourceLimits QosPolicy.
Returns
the rejected_by_instances_limit SampleRejectedState

Definition at line 109 of file State.hpp.

◆ rejected_by_samples_limit()

static SampleRejectedState dds::core::status::SampleRejectedState::rejected_by_samples_limit ( )
inlinestatic

Get the REJECTED_BY_SAMPLES_LIMIT.

rejected_by_samples_limit

  • The sample was rejected because it would exceed the maximum number of samples set by the ResourceLimits QosPolicy.
Returns
the rejected_by_samples_limit SampleRejectedState

Definition at line 94 of file State.hpp.

◆ rejected_by_samples_per_instance_limit()

static SampleRejectedState dds::core::status::SampleRejectedState::rejected_by_samples_per_instance_limit ( )
inlinestatic

Get the REJECTED_BY_SAMPLES_PER_INSTANCE_LIMIT.

rejected_by_samples_per_instance_limit

  • The sample was rejected because it would exceed the maximum number of samples per instance set by the ResourceLimits QosPolicy.
Returns
the rejected_by_samples_per_instance_limit SampleRejectedState

Definition at line 124 of file State.hpp.


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