Ocean::NonconstAccessor< T, TKey > Class Template Referenceabstract
This class implements a base class for accessors allowing a non-constant reference access. More...
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. More... | |
| virtual T & | operator[] (const TKey &key)=0 |
| Returns one element of this accessor object by a given key. More... | |
 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. More... | |
| virtual bool | canAccess (const TKey &key) const =0 |
| Returns whether this accessor has a specific element. More... | |
| virtual bool | firstElement (T &element, TKey &key) const =0 |
| Returns the first element of this accessor. More... | |
| 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. More... | |
| virtual const T & | operator[] (const TKey &key) const =0 |
| Returns one element of this accessor object by a given key. More... | |
| Public Member Functions inherited from Ocean::Accessor | |
| virtual | ~Accessor ()=default |
| Default destructor. More... | |
| virtual size_t | size () const =0 |
| Returns the number of accessible elements of this accessor object. More... | |
| bool | isEmpty () const |
| Returns whether this accessor provides no elements. More... | |
Protected Member Functions | |
| NonconstAccessor ()=default | |
| Creates a new indexed-based accessor object. More... | |
| Protected Member Functions inherited from Ocean::ConstAccessor< T, TKey > | |
| 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... | |
Additional Inherited Members | |
| Public Types inherited from Ocean::ConstAccessor< T, TKey > | |
| typedef T | Type |
| Definition of the element type of this accessor. More... | |
| typedef TKey | KeyType |
| Definition of the key (or e.g., index) type of this accessor. More... | |
| 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... | |
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 >
|
protecteddefault |
Creates a new indexed-based accessor object.
Member Function Documentation
◆ data()
template<typename T , typename TKey >
|
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 >
|
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::NonconstMapAccessor< T, TKey >, Ocean::NonconstIndexedAccessor< T >, and Ocean::NonconstArrayAccessor< T >.
The documentation for this class was generated from the following file:
