Ocean::ConstArrayAccessor< T > Class Template Reference

This class implements an accessor providing direct access to a constant array of elements. More...

#include <Accessor.h>

Inheritance diagram for Ocean::ConstArrayAccessor< T >:

Public Member Functions
	ConstArrayAccessor ()=default
	Creates a new empty accessor.
	ConstArrayAccessor (ConstArrayAccessor< T > &&accessor) noexcept
	Move constructor.
	ConstArrayAccessor (const T *elements, const size_t size)
	Creates a new accessor object.
	ConstArrayAccessor (const std::vector< T > &elements)
	Creates a new accessor object.
virtual const T *	data () const
	Returns a pointer to the elements of this accessor if the data exists within one memory block without gaps.
virtual size_t	size () const
	Returns the number of accessible elements of this accessor object.
virtual const T &	operator[] (const size_t &index) const
	Returns one element of this accessor object.
ConstArrayAccessor< T > &	operator= (ConstArrayAccessor< T > &&accessor) noexcept
	Move operator.
Public Member Functions inherited from Ocean::ConstIndexedAccessor< T >
virtual bool	canAccess (const size_t &index) const
	Returns whether this accessor has a specific element.
virtual bool	firstElement (T &element, size_t &index) const
	Returns the first element of this accessor.
virtual bool	nextElement (const size_t &previousIndex, T &nextElement, size_t &nextIndex) const
	Returns the next element which follows a given key of the previous element.
Public Member Functions inherited from Ocean::Accessor
virtual	~Accessor ()=default
	Default destructor.
bool	isEmpty () const
	Returns whether this accessor provides no elements.

Protected Attributes
const T *	elements_ = nullptr
	The elements of this accessor.
size_t	size_ = 0
	The number of elements that can be accessed.

Additional Inherited Members
Public Types inherited from Ocean::ConstAccessor< T, size_t >
typedef T	Type
	Definition of the element type of this accessor.
typedef size_t	KeyType
	Definition of the key (or e.g., index) type of this accessor.
Static Public Member Functions inherited from Ocean::Accessor
template<typename TAccessor >
static std::vector< typename TAccessor::Type >	accessor2elements (const TAccessor &accessor)
	Returns all elements of a given accessor (as a block).
template<typename TAccessor >
static std::unordered_map< typename TAccessor::KeyType, typename TAccessor::Type >	accessor2map (const TAccessor &accessor)
	Returns all elements of a given accessor as a map with key and elements.
template<typename TAccessor , typename TIndex >
static std::vector< typename TAccessor::Type >	accessor2subsetElements (const TAccessor &accessor, const std::vector< TIndex > &subset)
	Returns a subset of all elements of a given accessor (as a block).
Protected Member Functions inherited from Ocean::ConstIndexedAccessor< T >
	ConstIndexedAccessor ()=default
	Creates a new indexed-based accessor object.
Protected Member Functions inherited from Ocean::ConstAccessor< T, size_t >
	ConstAccessor ()=default
	Protected default constructor.
Protected Member Functions inherited from Ocean::Accessor
	Accessor ()=default
	Protected default constructor.
	Accessor (const Accessor &accessor)=default
	Protected copy constructor.
Accessor &	operator= (const Accessor &accessor)=delete
	Deleted assign operator.

Detailed Description

template<typename T>
class Ocean::ConstArrayAccessor< T >

This class implements an accessor providing direct access to a constant array of elements.

An instance of this accessor does not copy the elements, thus the caller has to ensure that the actual elements exist as long as the instance of the accessor exists.

The application of the this class is demonstrated in the following code example (compare the code example for ConstTemplateArrayAccessor):

// the parameter type is a base class of ConstArrayAccessor<Object> allowing a more flexible application of this function
void iterate(const ConstIndexedAccessor<Object>& accessor)
{
    for (size_t n = 0; n < accessor.size(); ++n)
    {
        // access the object by application of the !virtual! index operator
        const Object& object = accessor[n];
 
        // ... do something with the object ...
    }
}
 
void main()
{
    std::vector<Object> objects;
 
    // ... add some objects ...
 
    // iterate over all objects
    iterate(ConstArrayAccessor<Object>(objects));
}

Template Parameters

T	The data type of the elements of the accessor

See also

ConstTemplateArrayAccessor, ConstElementAccessor.

Constructor & Destructor Documentation

ConstArrayAccessor() [1/4]

template<typename T >

Ocean::ConstArrayAccessor< T >::ConstArrayAccessor ( )

default

Creates a new empty accessor.

ConstArrayAccessor() [2/4]

template<typename T >

Ocean::ConstArrayAccessor< T >::ConstArrayAccessor ( ConstArrayAccessor< T > &&  accessor )

inlinenoexcept

Move constructor.

Parameters

accessor

Accessor to be moved

ConstArrayAccessor() [3/4]

template<typename T >

Ocean::ConstArrayAccessor< T >::ConstArrayAccessor ( const T *  elements, const size_t  size  )

inline

Creates a new accessor object.

Beware: The given elements are not copied, they must not be deleted before the accessor is disposed.

Parameters

elements	The elements that can be accessed, may be nullptr if size is equal 0
size	The number of elements that can be accessed, may be 0 if elements is nullptr

ConstArrayAccessor() [4/4]

template<typename T >

Ocean::ConstArrayAccessor< T >::ConstArrayAccessor ( const std::vector< T > &  elements )

inlineexplicit

Creates a new accessor object.

Beware: The given elements are not copied, they must not be deleted before the accessor is disposed.

Parameters

elements

A vector holding all elements

Member Function Documentation

data()

template<typename T >

const T * Ocean::ConstArrayAccessor< T >::data ( ) const

virtual

Returns a pointer to the elements of this accessor if the data exists within one memory block without gaps.

See also

ConstAccessor::size().

Reimplemented from Ocean::ConstAccessor< T, size_t >.

operator=()

template<typename T >

ConstArrayAccessor< T > & Ocean::ConstArrayAccessor< T >::operator= ( ConstArrayAccessor< T > &&  accessor )

inlinenoexcept

Move operator.

Parameters

accessor

Accessor to be moved

Returns

Reference to this accessor

operator[]()

template<typename T >

const T & Ocean::ConstArrayAccessor< T >::operator[] ( const size_t &  index ) const

virtual

Returns one element of this accessor object.

See also

ConstAccessor::operator[].

Implements Ocean::ConstIndexedAccessor< T >.

size()

template<typename T >

size_t Ocean::ConstArrayAccessor< T >::size ( ) const

virtual

Returns the number of accessible elements of this accessor object.

See also

ConstAccessor::size().

Implements Ocean::Accessor.

Field Documentation

elements_

template<typename T >

const T* Ocean::ConstArrayAccessor< T >::elements_ = nullptr

protected

The elements of this accessor.

size_

template<typename T >

size_t Ocean::ConstArrayAccessor< T >::size_ = 0

protected

The number of elements that can be accessed.

---

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

• Accessor.h