Ocean::ConstCallbackIndexedAccessor< T > Class Template Reference
This class implements an accessor providing access to a elements by using a callback function. More...
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. More... | |
 Public Types inherited from Ocean::ConstAccessor< T, size_t > | |
| typedef T | Type |
| Definition of the element type of this accessor. More... | |
| typedef size_t | KeyType |
| Definition of the key (or e.g., index) type of this accessor. More... | |
Public Member Functions | |
| ConstCallbackIndexedAccessor ()=default | |
| Creates a new empty accessor. More... | |
| ConstCallbackIndexedAccessor (const CallbackFunction &callback, const size_t size) | |
| Creates a new accessor object. More... | |
| virtual const T & | operator[] (const size_t &index) const |
| Returns one element of this accessor object. More... | |
| virtual size_t | size () const |
| Returns the number of accessible elements of this accessor object. More... | |
| Public Member Functions inherited from Ocean::ConstIndexedAccessor< T > | |
| virtual bool | canAccess (const size_t &index) const |
| Returns whether this accessor has a specific element. More... | |
| virtual bool | firstElement (T &element, size_t &index) const |
| Returns the first element of this accessor. More... | |
| 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. More... | |
| 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. More... | |
| Public Member Functions inherited from Ocean::Accessor | |
| virtual | ~Accessor ()=default |
| Default destructor. More... | |
| bool | isEmpty () const |
| Returns whether this accessor provides no elements. More... | |
Protected Attributes | |
| CallbackFunction | callback_ |
| The callback function of this accessor. More... | |
| size_t | size_ = 0 |
| The number of elements that can be accessed. More... | |
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). More... | |
| 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. More... | |
| 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). More... | |
| Protected Member Functions inherited from Ocean::ConstIndexedAccessor< T > | |
| ConstIndexedAccessor ()=default | |
| Creates a new indexed-based accessor object. More... | |
| Protected Member Functions inherited from Ocean::ConstAccessor< T, size_t > | |
| ConstAccessor ()=default | |
| Protected default constructor. More... | |
| Protected Member Functions inherited from Ocean::Accessor | |
| Accessor ()=default | |
| Protected default constructor. More... | |
| Accessor (const Accessor &accessor)=default | |
| Protected copy constructor. More... | |
| Accessor & | operator= (const Accessor &accessor)=delete |
| Deleted assign operator. More... | |
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 >
|
default |
Creates a new empty accessor.
◆ ConstCallbackIndexedAccessor() [2/2]
template<typename T >
|
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 >
|
virtual |
Returns one element of this accessor object.
- See also
- ConstAccessor::operator[].
Implements Ocean::ConstIndexedAccessor< T >.
◆ size()
template<typename T >
|
virtual |
Returns the number of accessible elements of this accessor object.
- See also
- ConstAccessor::size().
Implements Ocean::Accessor.
Field Documentation
◆ callback_
template<typename T >
|
protected |
The callback function of this accessor.
◆ size_
template<typename T >
|
protected |
The number of elements that can be accessed.
The documentation for this class was generated from the following file:
