Cyclone ISO C++ API Reference Guide
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
dds::sub::status::ViewState Class Reference

Class to hold sample ViewState information. More...

#include "DataState.hpp"

Inherits std::bitset< Bits >.

Public Types

typedef std::bitset< OMG_DDS_STATE_BIT_COUNTMaskType
 

Public Member Functions

 ViewState ()
 
 ViewState (const MaskType &src)
 
 ViewState (const ViewState &src)
 
 ViewState (uint32_t m)
 

Static Public Member Functions

static const ViewState any ()
 
static const ViewState new_view ()
 
static const ViewState not_new_view ()
 

Detailed Description

Class to hold sample ViewState information.

For each instance (identified by the key), the Data Distribution Service internally maintains a view_state relative to each DataReader. The ViewSate can either be NEW_VIEW_STATE or NOT_NEW_VIEW_STATE.

  • new_view
    • Either this is the first time that the DataReader has ever accessed samples of that instance, or else that the DataReader has accessed previous samples of the instance, but the instance has since been reborn (i.e. become not-alive and then alive again).
  • not_new_view
    • The DataReader has already accessed samples of the same instance and that the instance has not been reborn since.
See also
SampleInfo for more information

Definition at line 146 of file DataState.hpp.

Member Typedef Documentation

◆ MaskType

Convenience typedef for std::bitset<OMG_DDS_STATE_BIT_COUNT>.

Definition at line 152 of file DataState.hpp.

Constructor & Destructor Documentation

◆ ViewState() [1/4]

dds::sub::status::ViewState::ViewState ( )

Construct a ViewState with default MaskType.

◆ ViewState() [2/4]

dds::sub::status::ViewState::ViewState ( uint32_t  m)
explicit

Construct a ViewState with MaskType of i.

Parameters
mthe MaskType

◆ ViewState() [3/4]

dds::sub::status::ViewState::ViewState ( const ViewState src)

Copy constructor.

Construct a ViewState with existing ViewState.

Parameters
srcthe ViewState to copy from

◆ ViewState() [4/4]

dds::sub::status::ViewState::ViewState ( const MaskType src)

Construct a ViewState with existing MaskType.

Parameters
srcthe MaskType to copy from

Member Function Documentation

◆ any()

static const ViewState dds::sub::status::ViewState::any ( )
inlinestatic

Get any ViewState.

Either the sample has already been seen or not seen.

Returns
the any ViewState

◆ new_view()

static const ViewState dds::sub::status::ViewState::new_view ( )
inlinestatic

Get the NEW_VIEW_STATE.

new_view

  • Either this is the first time that the DataReader has ever accessed samples of that instance, or else that the DataReader has accessed previous samples of the instance, but the instance has since been reborn (i.e. become not-alive and then alive again).
Returns
the new_view ViewState

◆ not_new_view()

static const ViewState dds::sub::status::ViewState::not_new_view ( )
inlinestatic

Get the NOT_NEW_VIEW_STATE.

not_new_view

  • The DataReader has already accessed samples of the same instance and that the instance has not been reborn since.
Returns
the not_new_view ViewState

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