safearray_sequence Class Template Reference
[Collections Library]
#include <comstl/collections/safearray_sequence.hpp>
Inheritance diagram for safearray_sequence:
Detailed Description
template<typename T>
class comstl::safearray_sequence< T >
Provides an STL-iterable view over a COM SAFEARRAY. Member Types | |
| typedef T | value_type |
| The value type. | |
| typedef safearray_sequence< T > | class_type |
| The current parameterisation of the type. | |
| typedef size_t | size_type |
| The size type. | |
| typedef cs_ptrdiff_t | difference_type |
| The difference type. | |
| typedef value_type & | reference |
| The reference type. | |
| typedef value_type const & | const_reference |
| The non-mutable (const) reference type. | |
| typedef value_type * | pointer |
| The pointer type. | |
| typedef value_type const * | const_pointer |
| The non-mutable (const) pointer type. | |
| typedef pointer_iterator < value_type, pointer, reference >::type | iterator |
| The iterator type. | |
| typedef pointer_iterator < value_type const , const_pointer, const_reference >::type | const_iterator |
| The non-mutating (const) iterator type. | |
Public Member Functions | |
Construction | |
The non-mutating (const) reverse iterator type | |
| safearray_sequence (LPCSAFEARRAY array) | |
Iteration | |
| const_iterator | begin () const |
| Begins the iteration. | |
| const_iterator | end () const |
| Ends the iteration. | |
| iterator | begin () |
| Begins the iteration. | |
| iterator | end () |
| Ends the iteration. | |
Attributes | |
| size_type | size () const |
| The number of elements in the array. | |
| bool | empty () const |
| Indicates whether the array is empty. | |
Member Typedef Documentation
| typedef T value_type |
The value type.
| typedef safearray_sequence<T> class_type |
The current parameterisation of the type.
| typedef size_t size_type |
The size type.
| typedef cs_ptrdiff_t difference_type |
The difference type.
| typedef value_type& reference |
The reference type.
| typedef value_type const& const_reference |
The non-mutable (const) reference type.
| typedef value_type* pointer |
The pointer type.
| typedef value_type const* const_pointer |
The non-mutable (const) pointer type.
| typedef pointer_iterator<value_type , pointer , reference >::type iterator |
The iterator type.
| typedef pointer_iterator<value_type const , const_pointer , const_reference >::type const_iterator |
The non-mutating (const) iterator type.
Member Function Documentation
| const_iterator begin | ( | ) | const |
Begins the iteration.
- Returns:
- An iterator representing the start of the sequence
| const_iterator end | ( | ) | const |
Ends the iteration.
- Returns:
- An iterator representing the end of the sequence
| iterator begin | ( | ) |
Begins the iteration.
- Returns:
- An iterator representing the start of the sequence
| iterator end | ( | ) |
Ends the iteration.
- Returns:
- An iterator representing the end of the sequence
| size_type size | ( | ) | const |
The number of elements in the array.
| bool empty | ( | ) | const |
Indicates whether the array is empty.
The documentation for this class was generated from the following file:
- comstl/collections/safearray_sequence.hpp
