OpenDDS::DCPS::SendStateDataSampleListConstIterator Struct Reference

SendStateDataSampleList STL-style const iterator implementation. More...

#include <SendStateDataSampleList.h>

Collaboration diagram for OpenDDS::DCPS::SendStateDataSampleListConstIterator:

Public Types
typedef std::bidirectional_iterator_tag	iterator_category
typedef const DataSampleElement	value_type
typedef std::ptrdiff_t	difference_type
typedef const DataSampleElement *	pointer
typedef const DataSampleElement &	reference

Public Member Functions
	SendStateDataSampleListConstIterator ()
	Default constructor required by ForwardIterator concept. More...
	SendStateDataSampleListConstIterator (const DataSampleElement *head, const DataSampleElement *tail, const DataSampleElement *current)
	SendStateDataSampleListConstIterator (const SendStateDataSampleListIterator &iterator)
SendStateDataSampleListConstIterator &	operator++ ()
SendStateDataSampleListConstIterator	operator++ (int)
SendStateDataSampleListConstIterator &	operator-- ()
SendStateDataSampleListConstIterator	operator-- (int)
reference	operator* () const
pointer	operator-> () const
bool	operator== (const SendStateDataSampleListConstIterator &rhs) const
bool	operator!= (const SendStateDataSampleListConstIterator &rhs) const

Private Attributes
const DataSampleElement *	head_
const DataSampleElement *	tail_
const DataSampleElement *	current_

Detailed Description

SendStateDataSampleList STL-style const iterator implementation.

This class implements a STL-style const iterator for the OpenDDS SendStateDataSampleList class. The resulting iterator may be used with the STL generic algorithms. It is meant for iteration over the "send samples" in a SendStateDataSampleList.

Definition at line 99 of file SendStateDataSampleList.h.

Member Typedef Documentation

difference_type

typedef std::ptrdiff_t OpenDDS::DCPS::SendStateDataSampleListConstIterator::difference_type

Definition at line 103 of file SendStateDataSampleList.h.

iterator_category

typedef std::bidirectional_iterator_tag OpenDDS::DCPS::SendStateDataSampleListConstIterator::iterator_category

Definition at line 101 of file SendStateDataSampleList.h.

pointer

typedef const DataSampleElement* OpenDDS::DCPS::SendStateDataSampleListConstIterator::pointer

Definition at line 104 of file SendStateDataSampleList.h.

reference

typedef const DataSampleElement& OpenDDS::DCPS::SendStateDataSampleListConstIterator::reference

Definition at line 105 of file SendStateDataSampleList.h.

value_type

typedef const DataSampleElement OpenDDS::DCPS::SendStateDataSampleListConstIterator::value_type

Definition at line 102 of file SendStateDataSampleList.h.

Constructor & Destructor Documentation

SendStateDataSampleListConstIterator() [1/3]

OpenDDS::DCPS::SendStateDataSampleListConstIterator::SendStateDataSampleListConstIterator ( )

inline

Default constructor required by ForwardIterator concept.

Definition at line 108 of file SendStateDataSampleList.h.

References OpenDDS::DCPS::operator*().

{}

SendStateDataSampleListConstIterator() [2/3]

OpenDDS::DCPS::SendStateDataSampleListConstIterator::SendStateDataSampleListConstIterator	(	const DataSampleElement *	head,
		const DataSampleElement *	tail,
		const DataSampleElement *	current
	)

Definition at line 174 of file SendStateDataSampleList.cpp.

  : head_(head)
  , tail_(tail)
  , current_(current)
{
}

SendStateDataSampleListConstIterator() [3/3]

OpenDDS::DCPS::SendStateDataSampleListConstIterator::SendStateDataSampleListConstIterator

(

const SendStateDataSampleListIterator &

iterator

)

Definition at line 184 of file SendStateDataSampleList.cpp.

  : head_(iterator.head_)
  , tail_(iterator.tail_)
  , current_(iterator.current_)
{
}

Member Function Documentation

operator!=()

bool OpenDDS::DCPS::SendStateDataSampleListConstIterator::operator!= ( const SendStateDataSampleListConstIterator &  rhs ) const

inline

Definition at line 131 of file SendStateDataSampleList.h.

                                                                    {
    return !(*this == rhs);
  }

operator*()

SendStateDataSampleListConstIterator::reference OpenDDS::DCPS::SendStateDataSampleListConstIterator::operator*

(

void

)

const

Definition at line 231 of file SendStateDataSampleList.cpp.

References current_.

{
  // Hopefully folks will be smart enough to not dereference a
  // null iterator.  Such a case should only exist for an "end"
  // iterator.  Otherwise we may want to throw an exception here.
  // assert (this->current_ != 0);

  return *(this->current_);
}

operator++() [1/2]

SendStateDataSampleListConstIterator & OpenDDS::DCPS::SendStateDataSampleListConstIterator::operator++

(

void

)

Definition at line 193 of file SendStateDataSampleList.cpp.

References current_, and OpenDDS::DCPS::DataSampleElement::next_send_sample_.

{
  if (this->current_) {
    this->current_ = this->current_->next_send_sample_;
  }

  return *this;
}

operator++() [2/2]

SendStateDataSampleListConstIterator OpenDDS::DCPS::SendStateDataSampleListConstIterator::operator++

(

int

)

Definition at line 203 of file SendStateDataSampleList.cpp.

{
  SendStateDataSampleListConstIterator tmp(*this);
  ++(*this);
  return tmp;
}

operator--() [1/2]

SendStateDataSampleListConstIterator & OpenDDS::DCPS::SendStateDataSampleListConstIterator::operator--

(

void

)

Definition at line 211 of file SendStateDataSampleList.cpp.

References current_, OpenDDS::DCPS::DataSampleElement::previous_send_sample_, and tail_.

{
  if (this->current_) {
    this->current_ = this->current_->previous_send_sample_;
  } else {
    this->current_ = this->tail_;
  }

  return *this;
}

operator--() [2/2]

SendStateDataSampleListConstIterator OpenDDS::DCPS::SendStateDataSampleListConstIterator::operator--

(

int

)

Definition at line 223 of file SendStateDataSampleList.cpp.

{
  SendStateDataSampleListConstIterator tmp(*this);
  --(*this);
  return tmp;
}

operator->()

SendStateDataSampleListConstIterator::pointer OpenDDS::DCPS::SendStateDataSampleListConstIterator::operator->

(

void

)

const

Definition at line 242 of file SendStateDataSampleList.cpp.

References current_, and OPENDDS_END_VERSIONED_NAMESPACE_DECL.

{
  return this->current_;
}

operator==()

bool OpenDDS::DCPS::SendStateDataSampleListConstIterator::operator== ( const SendStateDataSampleListConstIterator &  rhs ) const

inline

Definition at line 124 of file SendStateDataSampleList.h.

References current_, head_, head_, and tail_.

                                                                    {
    return this->head_ == rhs.head_
      && this->tail_ == rhs.tail_
      && this->current_ == rhs.current_;
  }

Member Data Documentation

current_

const DataSampleElement* OpenDDS::DCPS::SendStateDataSampleListConstIterator::current_

private

Definition at line 138 of file SendStateDataSampleList.h.

Referenced by operator*(), operator++(), operator--(), operator->(), and operator==().

head_

const DataSampleElement* OpenDDS::DCPS::SendStateDataSampleListConstIterator::head_

private

Definition at line 136 of file SendStateDataSampleList.h.

Referenced by operator==().

tail_

const DataSampleElement* OpenDDS::DCPS::SendStateDataSampleListConstIterator::tail_

private

Definition at line 137 of file SendStateDataSampleList.h.

Referenced by operator--(), and operator==().

---

The documentation for this struct was generated from the following files:

• SendStateDataSampleList.h
• SendStateDataSampleList.cpp