scl::stream::Stream< T > Class Template Reference

Class representing a stream of data. More...

#include "Stream.h"

Collaboration diagram for scl::stream::Stream< T >:

Public Types
using	iterator_type = details::iterator::BaseStreamIterator< T >
	The type of iterator used by this stream. More...
using	it_t = typename details::iterator::OpStreamIterator< T >::parent_type
	The type of pointer to the iterator used by this stream. More...
using	value_type = typename iterator_type::value_type
	value_type The value type used by this stream More...

Public Member Functions
	Stream (iterator_type *iterator)
	Construct a stream a raw pointer to an iterator. More...
it_t	it () const
	Get a reference to the underlying iterator. More...

Protected Attributes
it_t	iterator
	The iterator used to get values. More...

Detailed Description

template<class T>
class scl::stream::Stream< T >

Class representing a stream of data.

Template Parameters

T	being the type of data

Definition at line 15 of file Stream.h.

Member Typedef Documentation

it_t

template<class T>

scl::stream::Stream< T >::it_t

The type of pointer to the iterator used by this stream.

Definition at line 28 of file Stream.h.

iterator_type

template<class T>

scl::stream::Stream< T >::iterator_type

The type of iterator used by this stream.

Definition at line 22 of file Stream.h.

value_type

template<class T>

using scl::stream::Stream< T >::value_type = typename iterator_type::value_type

value_type The value type used by this stream

Definition at line 34 of file Stream.h.

Constructor & Destructor Documentation

Stream()

template<class T>

scl::stream::Stream< T >::Stream ( iterator_type *  iterator )

inlineexplicit

Construct a stream a raw pointer to an iterator.

Parameters

iterator

being a pointer to an iterator

Definition at line 40 of file Stream.h.

Member Function Documentation

it()

template<class T>

it_t scl::stream::Stream< T >::it ( ) const

inline

Get a reference to the underlying iterator.

Returns

the underlying iterator

Definition at line 48 of file Stream.h.

Member Data Documentation

iterator

template<class T>

scl::stream::Stream< T >::iterator

protected

The iterator used to get values.

Definition at line 55 of file Stream.h.

---

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

• include/scl/stream/Stream.h