C/C++ User's Journal Synesis Software STLSoft - ... Robust, Lightweight, Cross-platform, Template Software ... ATLSTL - where the Standard Template Library meets the Active Template Library COMSTL - where the Standard Template Library meets the Component Object Model UNIXSTL - Template Software for the UNIX Operating System WinSTL - where the Standard Template Library meets the Win32 API

Main Page   Modules   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

basic_root_sequence Class Template Reference
[recls.stl]

Presents an STL-like sequence interface over the items on the file-system. More...

#include <reclstl_root_sequence.h>

List of all members.

Types

typedef C char_type
 The character type.

typedef T traits_type
 The traits type.

typedef A allocator_type
 The allocator type.

typedef basic_root_sequence<
C, T, A > 
class_type
 The current parameterisation of the type.

typedef char_type const * value_type
 The value type.

typedef sequence_type::const_iterator const_iterator
 The non-mutating (const) iterator type supporting the Input Iterator concept.

typedef value_typereference
 The reference type.

typedef value_type const & const_reference
 The non-mutable (const) reference type.

typedef size_t size_type
 The size type.


State

size_type size () const
 Returns the number of items in the sequence.

recls_bool_t empty () const
 Indicates whether the sequence is empty.

size_type max_size ()
 Returns the maximum number of items in the sequence.


Public Methods

Construction
 basic_root_sequence ()
 Default constructor.

 ~basic_root_sequence ()
 Destructor.

Iteration
const_iterator begin () const
 Begins the iteration.

const_iterator end () const
 Ends the iteration.


Detailed Description

template<typename C, typename T, typename A>
class recls::stl::basic_root_sequence< C, T, A >

Presents an STL-like sequence interface over the items on the file-system.

Parameters:
C  The character type
T  The traits type. On translators that support default template arguments this defaults to reclstl_traits<C>


Member Typedef Documentation

typedef A allocator_type
 

The allocator type.

typedef C char_type
 

The character type.

typedef basic_root_sequence<C, T, A> class_type
 

The current parameterisation of the type.

typedef sequence_type::const_iterator const_iterator
 

The non-mutating (const) iterator type supporting the Input Iterator concept.

typedef value_type const& const_reference
 

The non-mutable (const) reference type.

typedef value_type& reference
 

The reference type.

typedef size_t size_type
 

The size type.

typedef T traits_type
 

The traits type.

typedef char_type const* value_type
 

The value type.


Constructor & Destructor Documentation

basic_root_sequence  
 

Default constructor.

~basic_root_sequence  
 

Destructor.


Member Function Documentation

const_iterator begin  
 

Begins the iteration.

Returns:
An iterator representing the start of the sequence

recls_bool_t empty  
 

Indicates whether the sequence is empty.

const_iterator end  
 

Ends the iteration.

Returns:
An iterator representing the end of the sequence

size_type max_size   [static]
 

Returns the maximum number of items in the sequence.

size_type size  
 

Returns the number of items in the sequence.


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

recls Library documentation Synesis Software Pty Ltd, 2001-2004