OpenDDS::DCPS::SendStateDataSampleListIterator Struct Reference

SendStateDataSampleList STL-style iterator implementation. More...

#include <SendStateDataSampleList.h>

Collaboration diagram for OpenDDS::DCPS::SendStateDataSampleListIterator:

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

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

Private Attributes
DataSampleElement *	head_
DataSampleElement *	tail_
DataSampleElement *	current_

Friends
class	SendStateDataSampleListConstIterator

Detailed Description

SendStateDataSampleList STL-style iterator implementation.

This class implements a STL-style 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 43 of file SendStateDataSampleList.h.

Member Typedef Documentation

difference_type

typedef std::ptrdiff_t OpenDDS::DCPS::SendStateDataSampleListIterator::difference_type

Definition at line 47 of file SendStateDataSampleList.h.

iterator_category

typedef std::bidirectional_iterator_tag OpenDDS::DCPS::SendStateDataSampleListIterator::iterator_category

Definition at line 45 of file SendStateDataSampleList.h.

pointer

typedef value_type* OpenDDS::DCPS::SendStateDataSampleListIterator::pointer

Definition at line 48 of file SendStateDataSampleList.h.

reference

typedef value_type& OpenDDS::DCPS::SendStateDataSampleListIterator::reference

Definition at line 49 of file SendStateDataSampleList.h.

value_type

typedef DataSampleElement OpenDDS::DCPS::SendStateDataSampleListIterator::value_type

Definition at line 46 of file SendStateDataSampleList.h.

Constructor & Destructor Documentation

SendStateDataSampleListIterator() [1/2]

OpenDDS::DCPS::SendStateDataSampleListIterator::SendStateDataSampleListIterator ( )

inline

Default constructor required by ForwardIterator concept.

Definition at line 52 of file SendStateDataSampleList.h.

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

{}

SendStateDataSampleListIterator() [2/2]

OpenDDS::DCPS::SendStateDataSampleListIterator::SendStateDataSampleListIterator	(	DataSampleElement *	head,
		DataSampleElement *	tail,
		DataSampleElement *	current
	)

This constructor is used when constructing an "end" iterator.

Definition at line 109 of file SendStateDataSampleList.cpp.

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

Member Function Documentation

operator!=()

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

inline

Definition at line 77 of file SendStateDataSampleList.h.

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

operator*()

SendStateDataSampleListIterator::reference OpenDDS::DCPS::SendStateDataSampleListIterator::operator*

(

void

)

Definition at line 158 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]

SendStateDataSampleListIterator & OpenDDS::DCPS::SendStateDataSampleListIterator::operator++

(

void

)

Definition at line 120 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]

SendStateDataSampleListIterator OpenDDS::DCPS::SendStateDataSampleListIterator::operator++

(

int

)

Definition at line 130 of file SendStateDataSampleList.cpp.

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

operator--() [1/2]

SendStateDataSampleListIterator & OpenDDS::DCPS::SendStateDataSampleListIterator::operator--

(

void

)

Definition at line 138 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]

SendStateDataSampleListIterator OpenDDS::DCPS::SendStateDataSampleListIterator::operator--

(

int

)

Definition at line 150 of file SendStateDataSampleList.cpp.

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

operator->()

SendStateDataSampleListIterator::pointer OpenDDS::DCPS::SendStateDataSampleListIterator::operator->

(

void

)

Definition at line 169 of file SendStateDataSampleList.cpp.

References current_.

{
  return this->current_;
}

operator==()

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

inline

Definition at line 70 of file SendStateDataSampleList.h.

References current_, head_, head_, and tail_.

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

Friends And Related Function Documentation

SendStateDataSampleListConstIterator

friend class SendStateDataSampleListConstIterator

friend

Definition at line 86 of file SendStateDataSampleList.h.

Member Data Documentation

current_

DataSampleElement* OpenDDS::DCPS::SendStateDataSampleListIterator::current_

private

Definition at line 84 of file SendStateDataSampleList.h.

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

head_

DataSampleElement* OpenDDS::DCPS::SendStateDataSampleListIterator::head_

private

Definition at line 82 of file SendStateDataSampleList.h.

Referenced by operator==().

tail_

DataSampleElement* OpenDDS::DCPS::SendStateDataSampleListIterator::tail_

private

Definition at line 83 of file SendStateDataSampleList.h.

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

---

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

• SendStateDataSampleList.h
• SendStateDataSampleList.cpp