Ocean::ConstIndexedAccessor< T > Class Template Reference

This class implements a base class for all indexed-based accessors allowing a constant reference access only. More...

Inheritance diagram for Ocean::ConstIndexedAccessor< T >:

Public Member Functions
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...
virtual const T &	operator[] (const size_t &index) const =0
	Returns one element of this accessor object by a given index. 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...
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
	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...

Additional Inherited Members
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...
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>
class Ocean::ConstIndexedAccessor< T >

This class implements a base class for all indexed-based accessors allowing a constant reference access only.

Template Parameters

T	The data type of the elements of the accessor

Constructor & Destructor Documentation

ConstIndexedAccessor()

template<typename T >

Ocean::ConstIndexedAccessor< T >::ConstIndexedAccessor ( )

protecteddefault

Creates a new indexed-based accessor object.

Member Function Documentation

canAccess()

template<typename T >

bool Ocean::ConstIndexedAccessor< T >::canAccess ( const size_t &  index ) const

virtual

Returns whether this accessor has a specific element.

See also

ConstAccessor::canAccess().

Implements Ocean::ConstAccessor< T, size_t >.

firstElement()

template<typename T >

bool Ocean::ConstIndexedAccessor< T >::firstElement ( T &  element, size_t &  index  ) const

virtual

Returns the first element of this accessor.

See also

ConstAccessor:firstElement().

Implements Ocean::ConstAccessor< T, size_t >.

nextElement()

template<typename T >

bool Ocean::ConstIndexedAccessor< T >::nextElement ( const size_t &  previousIndex, T &  nextElement, size_t &  nextIndex  ) const

virtual

Returns the next element which follows a given key of the previous element.

See also

ConstAccessor::nextElement().

Implements Ocean::ConstAccessor< T, size_t >.

operator[]()

template<typename T >

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

pure virtual

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

Parameters

index

The index of element to be accessed, with range [0, size())

Returns

The requested element

Implements Ocean::ConstAccessor< T, size_t >.

Implemented in Ocean::Tracking::Database::ConstPoseAccessorTopology< tThreadSafe >, Ocean::Tracking::Database::ConstPoseAccessorIds< tThreadSafe >, Ocean::Tracking::Database::ConstObjectPointAccessorIds< tThreadSafe >, Ocean::Tracking::Database::ConstImagePointAccessorTopology< tThreadSafe >, Ocean::Tracking::Database::ConstImagePointAccessorIds< tThreadSafe >, Ocean::ConstCallbackIndexedAccessor< T >, Ocean::ConstIndexedAccessorSubsetAccessor< T, TIndex >, Ocean::ConstArraySubsetAccessor< T, TIndex >, Ocean::ConstElementAccessor< T >, Ocean::SharedPointerConstArrayAccessor< T >, and Ocean::ConstArrayAccessor< T >.

---

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

• Accessor.h