Class that represents a list type (extends from std::vector). More...

#include <SPL/Runtime/Type/List.h>

Inheritance diagram for SPL::list< T >:

[legend]

List of all members.

Public Member Functions

list ()

list (typename list< T >::size_type n, const T &v=T())

list (const std::vector< T > &x)

list (const list< T > &x)

template<class InputIterator >

list (InputIterator first, InputIterator last)

list (const ConstValueHandle &o)

template<class T2 >

list (const list< T2 > &o)

template<class T2 , int32_t msize>

list (const blist< T2, msize > &o)

list (const List &o)

virtual ~list ()

std::vector< T >::const_reference at (typename std::vector< T >::size_type idx) const

std::vector< T >::reference at (typename std::vector< T >::size_type idx)

list< T > & add (const T &v)

const list< T > & operator= (const list< T > &o)

const list< T > & operator= (const std::vector< T > &o)

bool operator== (const list< T > &o) const

bool operator!= (const list< T > &ov) const

template<class BufferType >

void serialize (ByteBuffer< BufferType > &buf) const

template<class BufferType >

void deserialize (ByteBuffer< BufferType > &buf)

void serialize (std::ostream &ostr) const

void serializeWithPrecision (std::ostream &ostr) const

void deserialize (std::istream &istr, bool withSuffix=false)

void deserializeWithNanAndInfs (std::istream &istr, bool withSuffix=false)

size_t hashCode () const

Reflective interfaces

virtual bool equals (const Collection &ot) const

virtual Collection * clone () const

virtual void assignFrom (const Collection &ot)

virtual void swapWith (Collection &ot)

virtual Meta::Type getElementMetaType () const

virtual ValueHandle createElement () const

virtual int32_t getSize () const

virtual ValueHandle getElement (const size_t &i)

virtual ConstValueHandle getElement (const size_t &i) const

virtual ValueHandle getElement (const ConstListIterator &it)

virtual ConstValueHandle getElement (const ConstListIterator &it) const

virtual void insertElement (const ConstListIterator &it, const ConstValueHandle &v)

virtual void removeElement (const ConstListIterator &it)

virtual void removeAllElements ()

virtual void pushBack (const ConstValueHandle &v)

virtual void popBack ()

virtual size_t getSerializedSize () const

Public Member Functions inherited from SPL::List

virtual ~List ()

virtual ListIterator getBeginIterator ()

virtual ConstListIterator getBeginIterator () const

virtual ListIterator getEndIterator ()

virtual ConstListIterator getEndIterator () const

const List & operator= (const List &ov)

Public Member Functions inherited from SPL::Collection

virtual ~Collection ()

Destructor.

Additional Inherited Members

Public Attributes inherited from std::vector< T >

T elements

STL member.

Detailed Description

template<class T>
class SPL::list< T >

Class that represents a list type (extends from std::vector).

Constructor & Destructor Documentation

template<class T >

SPL::list< T >::list ( )

inlineexplicit

Default constructor

template<class T >

SPL::list< T >::list ( typename list< T >::size_type n,

const T & v = T()

)

inlineexplicit

Construct using a value

Parameters:

n number of elements

v value to use

template<class T >

SPL::list< T >::list ( const std::vector< T > & x )

inline

Construct from an STL vector

Parameters:

x STL vector to use

template<class T >

SPL::list< T >::list ( const list< T > & x )

inline

Copy constructor

Parameters:

x list to construct from

template<class T >

template<class InputIterator >

SPL::list< T >::list ( InputIterator first,

InputIterator last

)

inline

Construct from a sequence

Parameters:

first begin iterator, inclusive

last end iterator, exclusive

template<class T >

SPL::list< T >::list ( const ConstValueHandle & o )

inline

Construct from a value handle

Parameters:

o value handle to construct from

template<class T >

template<class T2 >

SPL::list< T >::list ( const list< T2 > & o )

inline

Construct from an assignable list

Parameters:

o list to construct from

template<class T >

template<class T2 , int32_t msize>

SPL::list< T >::list ( const blist< T2, msize > & o )

inline

Construct from an assignable blist

Parameters:

o list to construct from

template<class T >

SPL::list< T >::list ( const List & o )

inline

Construct from a reflective list

Parameters:

o reflective list to construct from

template<class T >

virtual SPL::list< T >::~list ( )

inlinevirtual

Destructor

Member Function Documentation

template<class T >

std::vector<T>::const_reference SPL::list< T >::at ( typename std::vector< T >::size_type idx ) const

inline

Subscript the list (read-only)

Parameters:

idx element index

Returns:: element at index idx

Exceptions:

SPLRuntimeInvalidIndexException exception if the index is out of range

template<class T >

std::vector<T>::reference SPL::list< T >::at ( typename std::vector< T >::size_type idx )

inline

Subscript the list (read-write)

Parameters:

idx element index

Returns:: element at index idx

Exceptions:

SPLRuntimeInvalidIndexException exception if the index is out of range

template<class T >

list<T>& SPL::list< T >::add ( const T & v )

inline

Append to list

Parameters:

v Value to be added

Returns:: *this

template<class T >

const list<T>& SPL::list< T >::operator= ( const list< T > & o )

inline

Assignment operator (from another list)

Parameters:

o list to assign from

Returns:: self

template<class T >

const list<T>& SPL::list< T >::operator= ( const std::vector< T > & o )

inline

Assignment operator (from an STL vector)

Parameters:

o STL list to assign from

Returns:: self

template<class T >

bool SPL::list< T >::operator== ( const list< T > & o ) const

inline

Equality comparison

Parameters:

o list to compare with

Returns:: true if the contained elements are the same, false otherwise

template<class T >

bool SPL::list< T >::operator!= ( const list< T > & ov ) const

inline

Non-equality comparison

Parameters:

ov list to compare with

Returns:: true if the contained elements are not the same, false otherwise

template<class T >

template<class BufferType >

void SPL::list< T >::serialize ( ByteBuffer< BufferType > & buf ) const

inline

Serialize (binary)

Parameters:

buf byte buffer to use

template<class T >

template<class BufferType >

void SPL::list< T >::deserialize ( ByteBuffer< BufferType > & buf )

inline

Deserialize (binary)

Parameters:

buf byte buffer to use

template<class T >

void SPL::list< T >::serialize ( std::ostream & ostr ) const

virtual

Serialize (character)

Parameters:

ostr output stream

Implements SPL::Collection.

template<class T >

void SPL::list< T >::serializeWithPrecision ( std::ostream & ostr ) const

virtual

Serialize (character), with maximum precision for floats

Parameters:

ostr output stream

Implements SPL::Collection.

template<class T >

void SPL::list< T >::deserialize ( std::istream & istr,

bool withSuffix = false

)

virtual

Deserialize (character)

Parameters:

istr input stream

withSuffix if true then consume suffix, otherwise (false) assume no suffix is present

Implements SPL::Collection.

template<class T >

void SPL::list< T >::deserializeWithNanAndInfs ( std::istream & istr,

bool withSuffix = false

)

Deserialize with Inf and Nan (character)

Parameters:

istr input stream

withSuffix if true then consume suffix, otherwise (false) assume no suffix is present

template<class T >

size_t SPL::list< T >::hashCode ( ) const

inlinevirtual

Get hash code

Returns:: hash code

Implements SPL::Collection.

template<class T >

virtual bool SPL::list< T >::equals ( const Collection & ot ) const

inlinevirtual

Compare with another collection

Parameters:

ot other collection to compare to

Returns:: true if equal, false otherwise

Implements SPL::Collection.

template<class T >

virtual Collection* SPL::list< T >::clone ( ) const

inlinevirtual

Create a clone of the collection object

Returns:: clone of the collection object

Implements SPL::Collection.

template<class T >

virtual void SPL::list< T >::assignFrom ( const Collection & ot )

inlinevirtual

Assign this collection using another collection

Parameters:

ot other collection to assign from

Exceptions:

SPLRuntimeTypeMismatchException if the types do not match

Implements SPL::Collection.

template<class T >

virtual void SPL::list< T >::swapWith ( Collection & ot )

inlinevirtual

Swap this collection with another collection

Parameters:

ot other collection to swap with

Exceptions:

SPLRuntimeTypeMismatchException if the types do not match

Implements SPL::Collection.

template<class T >

virtual Meta::Type SPL::list< T >::getElementMetaType ( ) const

inlinevirtual

Get element type

Returns:: element type of this list

Implements SPL::List.

template<class T >

virtual ValueHandle SPL::list< T >::createElement ( ) const

inlinevirtual

Create a new element. The returned value handle is wrapper for an object allocated on the heap. As a result, the caller is responsible for cleaning up the memory by calling ValueHandle::deleteValue()

Returns:: value handle for the new element

Implements SPL::List.

template<class T >

virtual int32_t SPL::list< T >::getSize ( ) const

inlinevirtual

Get the size of the list

Returns:: size of the list

Implements SPL::List.

template<class T >

virtual ValueHandle SPL::list< T >::getElement ( const size_t & i )

inlinevirtual

Get the element at a given index

Parameters:

i index of the element

Returns:: element at the given index

Implements SPL::List.

template<class T >

virtual ConstValueHandle SPL::list< T >::getElement ( const size_t & i ) const

inlinevirtual

Get the element at a given index

Parameters:

i index of the element

Returns:: element at the given index

Implements SPL::List.

template<class T >

virtual ValueHandle SPL::list< T >::getElement ( const ConstListIterator & it )

inlinevirtual

Get the element at a given position

Parameters:

it position of the element

Returns:: element at the given position

Implements SPL::List.

template<class T >

virtual ConstValueHandle SPL::list< T >::getElement ( const ConstListIterator & it ) const

inlinevirtual

Get the element at a given position

Parameters:

it position of the element

Returns:: element at the given position

Implements SPL::List.

template<class T >

virtual void SPL::list< T >::insertElement ( const ConstListIterator & it,

const ConstValueHandle & v

)

inlinevirtual

Insert a given element at a given index

Parameters:

it position of the element

v element to insert

Implements SPL::List.

template<class T >

virtual void SPL::list< T >::removeElement ( const ConstListIterator & it )

inlinevirtual

remove the element at a given index

Parameters:

it position of the element

Implements SPL::List.

template<class T >

virtual void SPL::list< T >::removeAllElements ( )

inlinevirtual

Remove all elements

Implements SPL::List.

template<class T >

virtual void SPL::list< T >::pushBack ( const ConstValueHandle & v )

inlinevirtual

Push a given element to the end of the list

Parameters:

v element to push back

Implements SPL::List.

template<class T >

virtual void SPL::list< T >::popBack ( )

inlinevirtual

Pop the last element from the end of the list

Implements SPL::List.

template<class T >

virtual size_t SPL::list< T >::getSerializedSize ( ) const

inlinevirtual

Get the size in bytes when serialized

Returns:: size in bytes when serialized

Implements SPL::Collection.

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

SPL/Runtime/Type/List.h

Public Member Functions

Additional Inherited Members

Detailed Description

template<class T> class SPL::list< T >

Constructor & Destructor Documentation

Member Function Documentation

template<class T>
class SPL::list< T >