DDS::SampleIterator< T, IsConst > Class Template Reference

Provides a means to iterate over a collection of Samples. More...

Public Types
typedef details::if_< IsConst, typename dds_type_traits< T >::ConstSampleIteratorValueType, typename dds_type_traits< T >::SampleIteratorValueType >::type	value_type
typedef std::ptrdiff_t	difference_type

Public Member Functions
	SampleIterator ()
	Default constructor.
	SampleIterator (Seq &seq, InfoSeq &info_seq, int position=0)
	Construct from data and info sequences.
	SampleIterator (const SampleIterator< T, false > &si)
	Copy constructor.
SampleIterator &	operator= (const SampleIterator< T, false > &si)
	Assignment operator.
value_type	operator* () const
	Dereference operator. The returned object will be of SampleRef<T>
value_type	operator-> () const
	Pointer operator The returned object will be of SampleRef<T>
value_type	operator[] (difference_type offset) const
	Array subscript The returned object will be of SampleRef<T>
SampleIterator &	operator++ ()
	Prefix increment operator.
SampleIterator	operator++ (int)
	Postfix increment operator.
SampleIterator &	operator-- ()
	Prefix decrement operator.
SampleIterator	operator-- (int)
	Postfix decrement operator.
SampleIterator &	operator-= (difference_type i)
	In-place subtraction.
SampleIterator &	operator+= (difference_type i)
	In-place addition.
SampleIterator	operator- (difference_type i) const
	Subtraction operator.
SampleIterator	operator+ (difference_type i) const
	Addition operator.
difference_type	operator- (const SampleIterator &s2) const
	Subtraction operator.
bool	operator< (const SampleIterator &s2) const
	Less than comparison.
bool	operator> (const SampleIterator &s2) const
	Greater than comparison.
bool	operator<= (const SampleIterator &s2) const
	Less than or equal comparison.
bool	operator>= (const SampleIterator &s2) const
	Greater than or equal comparison.
bool	operator== (const SampleIterator &s2) const
	Equality comparison.
bool	operator!= (const SampleIterator &s2) const
	Inequality comparison.
bool	is_end () const
	Test if iterator is at the end of the data.

Detailed Description

template<typename T, bool IsConst>
class DDS::SampleIterator< T, IsConst >

Provides a means to iterate over a collection of Samples.

See also

LoanedSamples

SharedSamples

Member Typedef Documentation

template<typename T, bool IsConst>

typedef std::ptrdiff_t DDS::SampleIterator< T, IsConst >::difference_type

difference_type typedef

template<typename T, bool IsConst>

typedef details::if_<IsConst, typename dds_type_traits<T>::ConstSampleIteratorValueType, typename dds_type_traits<T>::SampleIteratorValueType>::type DDS::SampleIterator< T, IsConst >::value_type

value_type typedef. Is SampleRef<T> or SampleRef<const T>