fesa-core  4.3.1
fesa::ImmutableFunctionList Class Reference

#include <ImmutableFunctionList.h>

Inheritance diagram for fesa::ImmutableFunctionList:
fesa::FunctionList

Public Member Functions

 ImmutableFunctionList (const detail::FunctionStorage *storage, std::size_t size, std::size_t pointsPerFunction)
 
 ImmutableFunctionList ()
 
template<class InputIterator >
 ImmutableFunctionList (InputIterator first, InputIterator last)
 
virtual bool isValid () const
 
virtual std::size_t size () const
 
ImmutableFunction getFunction (std::size_t index) const
 
std::size_t getTotalNumberOfPoints () const
 
std::size_t getMaxNumberOfPoints () const
 
FunctionList getMutable () const
 
virtual const_iterator begin () const
 Get a constant iterator pointing to the first function in the list.
 
virtual const_iterator end () const
 Get a constant iterator pointing after the last function in the list.
 

Detailed Description

Class which represents a function list. Objects of this class don't copy data and are immutable. This means that the data used to instantiate them must remain accessible and constant until they are destroyed.

Constructor & Destructor Documentation

fesa::ImmutableFunctionList::ImmutableFunctionList ( const detail::FunctionStorage storage,
std::size_t  size,
std::size_t  pointsPerFunction 
)

Instantiates an ImmutableFunctionList from a field value containing an array of FunctionStorage.

Parameters
storage
intervalthe number of bytes between 2 arrays of points contained by the field value
fesa::ImmutableFunctionList::ImmutableFunctionList ( )

Instantiates an empty function list.

template<class InputIterator >
fesa::ImmutableFunctionList::ImmutableFunctionList ( InputIterator  first,
InputIterator  last 
)

Instantiates an ImmutableFunctionList from iterators of points.

Template Parameters
InputIteratoran iterator to iterators of points.

Member Function Documentation

ImmutableFunction fesa::ImmutableFunctionList::getFunction ( std::size_t  index) const
Returns
the function at the given index
std::size_t fesa::ImmutableFunctionList::getMaxNumberOfPoints ( ) const

Returns the maximum number of points in a single function of this function list.

FunctionList fesa::ImmutableFunctionList::getMutable ( ) const

Returns a FunctionList object that contains a copy of the elements of this function list.

std::size_t fesa::ImmutableFunctionList::getTotalNumberOfPoints ( ) const
Returns
the total number of points in the functions of this function list.
bool fesa::ImmutableFunctionList::isValid ( ) const
virtual

Checks that functions in this function list are valid functions.

Reimplemented in fesa::FunctionList.

std::size_t fesa::ImmutableFunctionList::size ( ) const
virtual
Returns
the number of functions in this function list.

Reimplemented in fesa::FunctionList.


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