rti::sub::ValidLoanedSamples< T > Class Template Reference

<<extension>> <<C++11>> <<move-only-type>> Provides access to only those samples that contain valid data More...

#include <LoanedSamplesImpl.hpp>

Public Types
typedef ValidSampleIterator< T >	iterator
	The iterator type that ValidLoanedSamples provides.
typedef ValidSampleIterator< T >	const_iterator
	The const-iterator type that ValidLoanedSamples provides.
typedef ValidSampleIterator< T > ::value_type	value_type
	This collection's value type, LoanedSample<T>

Public Member Functions
	ValidLoanedSamples (LoanedSamples< T > &&loaned_samples)
	Constructor from an rvalue LoanedSamples.
	ValidLoanedSamples (ValidLoanedSamples< T > &&other)
	Move constructor.
iterator	begin ()
	Returns a forward iterator to the first valid-data sample.
const_iterator	begin () const
	Returns a forward const iterator to the first valid-data sample.
iterator	end ()
	Returns a forward iterator that indicates the end of the collection.
const_iterator	end () const
	Returns a forward const iterator that indicates the end of the collection.

Related Functions
(Note that these are not member functions.)
template<typename T >
ValidLoanedSamples< T >::iterator	begin (ValidLoanedSamples< T > &ls)
template<typename T >
ValidLoanedSamples< T > ::const_iterator	begin (const ValidLoanedSamples< T > &ls)
template<typename T >
ValidLoanedSamples< T >::iterator	end (ValidLoanedSamples< T > &ls)
template<typename T >
ValidLoanedSamples< T > ::const_iterator	end (const ValidLoanedSamples< T > &ls)
template<typename T >
void	swap (ValidLoanedSamples< T > &ls1, ValidLoanedSamples< T > &ls2) throw()

Detailed Description

template<typename T>
class rti::sub::ValidLoanedSamples< T >

<<extension>> <<C++11>> <<move-only-type>> Provides access to only those samples that contain valid data

Template Parameters

T	The topic-type. It has to match the type of the DataReader.

An instance of ValidLoanedSamples is a wrapper that takes an existing LoanedSamples and provides forward iterators that only access samples with valid data.

The typical way to use this collection is through the function rti::sub::valid_data, which transforms a dds::sub::LoanedSamples into a ValidLoanedSamples.

For more information and a code example, see rti::sub::valid_data(LoanedSamples<T>&&)

See Also

Reading data samples

Member Typedef Documentation

template<typename T>

typedef ValidSampleIterator<T> rti::sub::ValidLoanedSamples< T >::iterator

The iterator type that ValidLoanedSamples provides.

template<typename T>

typedef ValidSampleIterator<T> rti::sub::ValidLoanedSamples< T >::const_iterator

The const-iterator type that ValidLoanedSamples provides.

template<typename T>

typedef ValidSampleIterator<T>::value_type rti::sub::ValidLoanedSamples< T >::value_type

This collection's value type, LoanedSample<T>

Constructor & Destructor Documentation

template<typename T>

rti::sub::ValidLoanedSamples< T >::ValidLoanedSamples ( LoanedSamples< T > &&  loaned_samples )

inline

Constructor from an rvalue LoanedSamples.

The only way to create a ValidLoanedSamples is through moving an existing LoanedSamples.

Postcondition

loaned_samples is invalid should not be used; this ValidLoanedSamples now owns it.

Note

This constructor should not be used directly, the function rti::sub::valid_data(LoanedSamples<T>&&) is more convenient since it can deduce the template type.

template<typename T>

rti::sub::ValidLoanedSamples< T >::ValidLoanedSamples ( ValidLoanedSamples< T > &&  other )

inline

Move constructor.

A ValidLoanedSamples, just like LoanedSamples can be moved but not copied.

Member Function Documentation

template<typename T>

iterator rti::sub::ValidLoanedSamples< T >::begin ( )

inline

Returns a forward iterator to the first valid-data sample.

template<typename T>

const_iterator rti::sub::ValidLoanedSamples< T >::begin ( ) const

inline

Returns a forward const iterator to the first valid-data sample.

template<typename T>

iterator rti::sub::ValidLoanedSamples< T >::end ( )

inline

Returns a forward iterator that indicates the end of the collection.

template<typename T>

const_iterator rti::sub::ValidLoanedSamples< T >::end ( ) const

inline

Returns a forward const iterator that indicates the end of the collection.

Friends And Related Function Documentation

template<typename T >

ValidLoanedSamples< T >::iterator begin ( ValidLoanedSamples< T > &  ls )

related

See Also

ValidLoanedSamples::begin()

template<typename T >

ValidLoanedSamples< T >::const_iterator begin ( const ValidLoanedSamples< T > &  ls )

related

See Also

ValidLoanedSamples::begin()

template<typename T >

ValidLoanedSamples< T >::iterator end ( ValidLoanedSamples< T > &  ls )

related

See Also

ValidLoanedSamples::end()

template<typename T >

ValidLoanedSamples< T >::const_iterator end ( const ValidLoanedSamples< T > &  ls )

related

See Also

ValidLoanedSamples::end()

template<typename T >

void swap ( ValidLoanedSamples< T > &  ls1, ValidLoanedSamples< T > &  ls2  ) throw()

related

See Also

ValidLoanedSamples::swap()