Ocean::NonconstAccessor< T, TKey > Class Template Reference

This class implements a base class for accessors allowing a non-constant reference access. More...

#include <Accessor.h>

Inheritance diagram for Ocean::NonconstAccessor< T, TKey >:

Public Member Functions
virtual T *	data ()
	Returns a pointer to the elements of this accessor if the data exists within one memory block without gaps.
virtual T &	operator[] (const TKey &key)=0
	Returns one element of this accessor object by a given key.
Public Member Functions inherited from Ocean::ConstAccessor< T, TKey >
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 bool	canAccess (const TKey &key) const =0
	Returns whether this accessor has a specific element.
virtual bool	firstElement (T &element, TKey &key) const =0
	Returns the first element of this accessor.
virtual bool	nextElement (const TKey &previousKey, T &nextElement, TKey &nextKey) const =0
	Returns the next element which follows a given key of the previous element.
virtual const T &	operator[] (const TKey &key) const =0
	Returns one element of this accessor object by a given key.
Public Member Functions inherited from Ocean::Accessor
virtual	~Accessor ()=default
	Default destructor.
virtual size_t	size () const =0
	Returns the number of accessible elements of this accessor object.
bool	isEmpty () const
	Returns whether this accessor provides no elements.

Protected Member Functions
	NonconstAccessor ()=default
	Creates a new indexed-based accessor object.
Protected Member Functions inherited from Ocean::ConstAccessor< T, TKey >
	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.

Additional Inherited Members
Public Types inherited from Ocean::ConstAccessor< T, TKey >
using	Type = T
	Definition of the element type of this accessor.
using	KeyType = TKey
	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).

Detailed Description

template<typename T, typename TKey>
class Ocean::NonconstAccessor< T, TKey >

This class implements a base class for accessors allowing a non-constant reference access.

Template Parameters

T	The data type of the elements of the accessor
TKey	The data type of the keys of the accessor

Constructor & Destructor Documentation

NonconstAccessor()

template<typename T , typename TKey >

Ocean::NonconstAccessor< T, TKey >::NonconstAccessor ( )

protecteddefault

Creates a new indexed-based accessor object.

Member Function Documentation

data()

template<typename T , typename TKey >

T * Ocean::NonconstAccessor< T, TKey >::data ( )

virtual

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

Beware: There is not guarantee that the data of an accessor is stored as one memory block, thus be prepared that the resulting pointer is nullptr.

Returns

The pointer to the memory block of this accessor, if available

Reimplemented in Ocean::NonconstArrayAccessor< T >.

operator[]()

template<typename T , typename TKey >

virtual T & Ocean::NonconstAccessor< T, TKey >::operator[] ( const TKey &  key )

pure virtual

Returns one element of this accessor object by a given key.

Parameters

key	The key of element to be accessed, must be valid

Returns

The requested element

Implemented in Ocean::NonconstArrayAccessor< T >, Ocean::NonconstIndexedAccessor< T >, and Ocean::NonconstMapAccessor< T, TKey >.

---

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

• Accessor.h