OpenWalnut  1.4.0
Public Member Functions | Private Attributes
WFiberIterator Class Reference

An iterator for fibers of a fiber dataset. More...

#include <WDataSetFibers.h>

List of all members.

Public Member Functions

 WFiberIterator ()
 Constructor.
 WFiberIterator (WDataSetFibers const *fibers, std::size_t idx)
 Constructor.
 WFiberIterator (WFiberIterator const &iter)
 Copy constructor.
 ~WFiberIterator ()
 Destructor.
WFiberIteratoroperator= (WFiberIterator const &iter)
 Copy operator.
WFiberIteratoroperator++ ()
 Increment operator.
WFiberIteratoroperator-- ()
 Decrement operator.
WFiberIterator operator++ (int)
 Increment operator.
WFiberIterator operator-- (int)
 Decrement operator.
bool operator== (WFiberIterator const &rhs) const
 Compare to another fiber iterator.
bool operator!= (WFiberIterator const &rhs) const
 Compare to another fiber iterator.
WFiberPointsIterator begin ()
 Creates a point iterator for forward iteration, pointing to the first point of the fiber.
WFiberPointsIterator end ()
 Creates a point iterator for forward iteration, pointing beyond the last point of the fiber.
WFiberPointsIterator rbegin ()
 Creates a point iterator for backward iteration, pointing to the last point of the fiber.
WFiberPointsIterator rend ()
 Creates a point iterator for backward iteration, pointing beyond the first point of the fiber.
std::size_t numPoints () const
 Returns the number of points of the current fiber.
std::size_t getLineStartIndex () const
 Get the index in the point array where the points data starts for this line.
std::size_t getIndex () const
 Get the index of the line.

Private Attributes

WDataSetFibers const * m_fibers
 The pointer to the fibers.
std::size_t m_index
 The current index in the fiber data.

Detailed Description

An iterator for fibers of a fiber dataset.

This class iterates fibers of a fiber dataset.

Definition at line 497 of file WDataSetFibers.h.


Constructor & Destructor Documentation

Constructor.

Creates an invalid iterator pointing nowhere.

Definition at line 395 of file WDataSetFibers.cpp.

WFiberIterator::WFiberIterator ( WDataSetFibers const *  fibers,
std::size_t  idx 
)

Constructor.

Creates an iterator for a specific fiber dataset.

Parameters:
fibersA pointer to the fiber data.
idxThe index of the fiber to point to.

Definition at line 401 of file WDataSetFibers.cpp.

Copy constructor.

Parameters:
iterThe iterator to copy from.

Definition at line 407 of file WDataSetFibers.cpp.

Destructor.

Definition at line 413 of file WDataSetFibers.cpp.


Member Function Documentation

Creates a point iterator for forward iteration, pointing to the first point of the fiber.

Returns:
A point iterator pointing to the first point.

Definition at line 473 of file WDataSetFibers.cpp.

References m_fibers, and m_index.

Creates a point iterator for forward iteration, pointing beyond the last point of the fiber.

Returns:
A point iterator pointing beyond the last point.

Definition at line 478 of file WDataSetFibers.cpp.

References m_fibers, m_index, and numPoints().

std::size_t WFiberIterator::getIndex ( ) const

Get the index of the line.

Notes:
You should avoid using these indices as can use the iterators to query the data. But it might get handy in some situations, where raw data processing is needed.
Returns:
the index.

Definition at line 502 of file WDataSetFibers.cpp.

References m_index.

Referenced by getLineStartIndex().

std::size_t WFiberIterator::getLineStartIndex ( ) const

Get the index in the point array where the points data starts for this line.

You can use numPoints to know how much data to read from the vertex array.

Notes:
You should avoid using these indices as can use the iterators to query the data. But it might get handy in some situations, where raw data processing is needed.
Returns:
the start index.

Definition at line 497 of file WDataSetFibers.cpp.

References getIndex(), WDataSetFibers::getLineStartIndexes(), and m_fibers.

std::size_t WFiberIterator::numPoints ( ) const

Returns the number of points of the current fiber.

Returns:
The number of points.

Definition at line 466 of file WDataSetFibers.cpp.

References WDataSetFibers::getLineLengths(), m_fibers, and m_index.

Referenced by end(), and rend().

bool WFiberIterator::operator!= ( WFiberIterator const &  rhs) const

Compare to another fiber iterator.

Parameters:
rhsThe second fiber iterator.
Returns:
false, iff the two iterators point to the same fiber of the same fiber dataset.

Definition at line 461 of file WDataSetFibers.cpp.

References operator==().

WFiberIterator & WFiberIterator::operator++ ( )

Increment operator.

Makes the iterator point to the next fiber.

Returns:
The incremented iterator.

Definition at line 430 of file WDataSetFibers.cpp.

References m_index.

WFiberIterator WFiberIterator::operator++ ( int  )

Increment operator.

Makes the iterator point to the next fiber.

Returns:
The iterator before incrementing.

Definition at line 436 of file WDataSetFibers.cpp.

References m_fibers, and m_index.

WFiberIterator & WFiberIterator::operator-- ( )

Decrement operator.

Makes the iterator point to the previous fiber.

Returns:
The decremented iterator.

Definition at line 443 of file WDataSetFibers.cpp.

References m_index.

WFiberIterator WFiberIterator::operator-- ( int  )

Decrement operator.

Makes the iterator point to the previous fiber.

Returns:
The iterator before decrementing.

Definition at line 449 of file WDataSetFibers.cpp.

References m_fibers, and m_index.

WFiberIterator & WFiberIterator::operator= ( WFiberIterator const &  iter)

Copy operator.

Parameters:
iterThe iterator to copy from.
Returns:
*this

Definition at line 417 of file WDataSetFibers.cpp.

References m_fibers, and m_index.

bool WFiberIterator::operator== ( WFiberIterator const &  rhs) const

Compare to another fiber iterator.

Parameters:
rhsThe second fiber iterator.
Returns:
true, iff the two iterators point to the same fiber of the same fiber dataset.

Definition at line 456 of file WDataSetFibers.cpp.

References m_fibers, and m_index.

Referenced by operator!=().

Creates a point iterator for backward iteration, pointing to the last point of the fiber.

Returns:
A point iterator pointing to the last point.

Definition at line 485 of file WDataSetFibers.cpp.

References m_fibers, and m_index.

Creates a point iterator for backward iteration, pointing beyond the first point of the fiber.

Returns:
A point iterator pointing beyond the first point.

Definition at line 490 of file WDataSetFibers.cpp.

References m_fibers, m_index, and numPoints().


Member Data Documentation

The pointer to the fibers.

Definition at line 638 of file WDataSetFibers.h.

Referenced by begin(), end(), getLineStartIndex(), numPoints(), operator++(), operator--(), operator=(), operator==(), rbegin(), and rend().

std::size_t WFiberIterator::m_index [private]

The current index in the fiber data.

Definition at line 641 of file WDataSetFibers.h.

Referenced by begin(), end(), getIndex(), numPoints(), operator++(), operator--(), operator=(), operator==(), rbegin(), and rend().


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