Ocean::ConstCallbackIndexedAccessor< T > Class Template Reference

This class implements an accessor providing access to a elements by using a callback function. More...

#include <Accessor.h>

Inheritance diagram for Ocean::ConstCallbackIndexedAccessor< T >:

Public Types
typedef Callback< const T &, const size_t >	CallbackFunction
	Definition of a callback function providing access to individual elements.
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.

Public Member Functions
	ConstCallbackIndexedAccessor ()=default
	Creates a new empty accessor.
	ConstCallbackIndexedAccessor (const CallbackFunction &callback, const size_t size)
	Creates a new accessor object.
virtual const T &	operator[] (const size_t &index) const
	Returns one element of this accessor object.
virtual size_t	size () const
	Returns the number of accessible elements of this accessor object.
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::ConstAccessor< T, size_t >
virtual const T *	data () const
	Returns a pointer to the elements of this accessor if the data exists within one memory block without gaps.
Public Member Functions inherited from Ocean::Accessor
virtual	~Accessor ()=default
	Default destructor.
bool	isEmpty () const
	Returns whether this accessor provides no elements.

Protected Attributes
CallbackFunction	callback_
	The callback function of this accessor.
size_t	size_ = 0
	The number of elements that can be accessed.

Additional Inherited Members
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::ConstCallbackIndexedAccessor< T >

This class implements an accessor providing access to a elements by using a callback function.

Template Parameters

T	The data type of the elements of the accessor

Member Typedef Documentation

CallbackFunction

template<typename T >

typedef Callback<const T&, const size_t> Ocean::ConstCallbackIndexedAccessor< T >::CallbackFunction

Definition of a callback function providing access to individual elements.

The first parameter is the index of the elements to be accessed The return parameter is the constant reference to the requested element

Constructor & Destructor Documentation

ConstCallbackIndexedAccessor() [1/2]

template<typename T >

Ocean::ConstCallbackIndexedAccessor< T >::ConstCallbackIndexedAccessor ( )

default

Creates a new empty accessor.

ConstCallbackIndexedAccessor() [2/2]

template<typename T >

Ocean::ConstCallbackIndexedAccessor< T >::ConstCallbackIndexedAccessor ( const CallbackFunction &  callback, const size_t  size  )

inline

Creates a new accessor object.

Parameters

callback	The callback function providing access to individual elements
size	The number of elements of this accessor

Member Function Documentation

operator[]()

template<typename T >

const T & Ocean::ConstCallbackIndexedAccessor< 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::ConstCallbackIndexedAccessor< T >::size ( ) const

virtual

Returns the number of accessible elements of this accessor object.

See also

ConstAccessor::size().

Implements Ocean::Accessor.

Field Documentation

callback_

template<typename T >

CallbackFunction Ocean::ConstCallbackIndexedAccessor< T >::callback_

protected

The callback function of this accessor.

size_

template<typename T >

size_t Ocean::ConstCallbackIndexedAccessor< 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