List< ValueType > Class Template Reference

Detailed Description

template<typename ValueType>
class Vuforia::List< ValueType >

Vuforia's List container.

This class offers similar capabilities to std::list and implements a subset of its functionality. The type 'ValueType' needs to be a Vuforia data type.

Here is an example on how to use it: Vuforia::List<const HitTesResult> hitTestResult = smartTerrain.hitTest(...)

Public Types
typedef Impl::ListIterator< ValueType >	iterator
	Standard C++ boilerplate typedefs. More...
typedef iterator	const_iterator
typedef int	size_type
typedef iterator::value_type	value_type
typedef iterator::reference	reference
typedef iterator::const_reference	const_reference
typedef iterator::difference_type	difference_type

Public Member Functions
	List (List const &other)
List &	operator= (List const &other)
	~List ()
iterator	begin () const
	Returns an iterator pointing to the first element in the list. More...
iterator	end () const
	Returns an iterator pointing to the last element in the list. More...
ValueType *	operator[] (int pos) const
	Functions returning the list element at position 'pos' in the list. More...
ValueType *	at (int pos) const
List< const ValueType >	constView ()
	Returns a read-only view of the list. More...
int	size () const
	Number of elements in list. More...
bool	empty () const
	Returns true if the list is empty, false otherwise. More...

Protected Member Functions
	List (ListDataProvider< ValueType > *provider_)

Protected Attributes
ListDataProvider< ValueType > *	provider

Friends
template<typename T >
class	List

Member Typedef Documentation

typedef Impl::ListIterator<ValueType> iterator

Standard C++ boilerplate typedefs.

typedef iterator const_iterator

typedef int size_type

typedef iterator::value_type value_type

typedef iterator::reference reference

typedef iterator::const_reference const_reference

typedef iterator::difference_type difference_type

Constructor & Destructor Documentation

List ( List< ValueType > const &  other )

inline

Copy constructor, assignment and destructor are reference counted, therefore it's OK to copy a List, it won't copy the contents. Vuforia might give additional lifetime constraints, e.g. Lists only being valid for a single frame.

~List ( )

inline

List ( ListDataProvider< ValueType > *  provider_ )

inlineprotected

Member Function Documentation

List& operator= ( List< ValueType > const &  other )

inline

iterator begin ( ) const

inline

Returns an iterator pointing to the first element in the list.

iterator end ( ) const

inline

Returns an iterator pointing to the last element in the list.

ValueType* operator[] ( int  pos ) const

inline

Functions returning the list element at position 'pos' in the list.

ValueType* at ( int  pos ) const

inline

List<const ValueType> constView ( )

inline

Returns a read-only view of the list.

int size ( ) const

inline

Number of elements in list.

bool empty ( ) const

inline

Returns true if the list is empty, false otherwise.

Friends And Related Function Documentation

friend class List

friend

Member Data Documentation

ListDataProvider<ValueType>* provider

mutableprotected