Fish - FiberLib for VISH 0.3
Fish - The Fiber Bundle API for the Vish Visualization Shell
Fiber::Iterator< SkeletonID > Class Reference
Inheritance diagram for Fiber::Iterator< SkeletonID >:
Fiber::IteratorBase< T > Fiber::SkeletonIterator Fiber::ElementIterator< T > Fiber::HyperslabParameters

Public Types

typedef IteratorBase< SkeletonIDBase_t
typedef SkeletonID value_t
typedef Eagle::MetaInfo< value_t > FI
typedef FI::element_t component_t
typedef ElementryArrayTrait< SkeletonID >::basetype_t array_t
typedef SkeletonIDreference_t
 The reference type.
Public Types inherited from Fiber::ElementIterator< T >
typedef Eagle::MetaInfo< T > info_t
typedef info_t::element_t element_info_t

Public Member Functions

 Iterator (index_t howmany, SkeletonID *Ptr)
 Construct view pointer from contiguous storage.
Iterator< array_t > getArrayIterator () const
 Get an iterator that operates on associated FixedArray<> subjects.
Iterator< component_t > getComponent (int n) const
 Get an iterator that operates on the nth component.
SkeletonIDoperator[] (index_t i) const
 Access an element of the array, writeable.
const SkeletonIDgetValue (index_t i) const
 Get the value, readonly.
void set (const SkeletonID &Value)
 Set all elements to the same value.
const_ranged_for_iterator< SkeletonIDbegin () const
const_ranged_for_iterator< SkeletonIDend () const
Public Member Functions inherited from Fiber::IteratorBase< T >
 IteratorBase (index_t Length, T *d, index_t Stride, index_t Offset)
 IteratorBase (const IteratorBase &IB)
 IteratorBase (const HyperslabParameters &IB, T *d)
 Construct compatible iterator with different data.
 IteratorBase (index_t ishift, const IteratorBase &P, const Add &)
Public Member Functions inherited from Fiber::ElementIterator< T >
 ElementIterator (index_t Length, T *Data, index_t Stride, index_t Offset)
 Construct an element iterator.
 ElementIterator (const ElementIterator &It)
 Copy Constructor.
 ElementIterator (const HyperslabParameters &It, T *newData)
 Constructor compatible iterator with new data.
 ElementIterator (index_t i, const ElementIterator &It, const Add &)
 Addition Constructor.
void SetNewData (T *newData, index_t newLength) throw ()
 Change the stored data chunk to a new location and length.
T * ptr (int c=0) const
 Return pointer to data, which is good for C interface, but otherwise, avoid that.
T & getElement (index_t i, int c) const
 Element access (no range check!).
 operator bool () const
 Implicit conversion to boolean: Check whether this is a valid pointer.
Public Member Functions inherited from Fiber::HyperslabParameters
 HyperslabParameters (index_t Length, index_t Stride, index_t Offset) throw ()
 Simple constructorm sets shift and cropped members to zero.
 HyperslabParameters (const HyperslabParameters &H) throw ()
 Copy constructor.
 HyperslabParameters (index_t i, const HyperslabParameters &H) throw ()
 Pointer addition constructor (sets the shift member).
index_t getLength () const throw ()
 Return the number of elements which can be accessed through this ElementIterator.
index_t getOffset () const throw ()
index_t getStride () const throw ()
index_t getShift () const throw ()
index_t getCropped () const throw ()
bool isSeparatedCompound () const throw ()
 Tell if the iterator refers to a data set which is built from arrays of structure members, i.e.
index_t multiplicity () const throw ()
 Return number of elements which form an entity.
index_t maxcount () const throw ()
 Return the number of steps which can be traversed through this ElementIterator.
index_t count () const throw ()
 Return the number of steps which can be traversed through this ElementIterator.
void setCount (index_t size) throw ()
 Set the maximally allowed count, i.e.
index_t getIndex (index_t i, int c) const throw ()
 Given a major and a minor index, compute the overall index in the dataset according to.
HyperslabParametersgetHyperslabParameters () throw ()
const HyperslabParametersgetHyperslabParameters () const throw ()
Public Member Functions inherited from Fiber::SkeletonIterator
virtual bool apply (const SkeletonID &id, Skeleton &S)=0

Friends

Iterator operator+ (const Iterator &P, uint32_t i)

Additional Inherited Members

Protected Member Functions inherited from Fiber::ElementIterator< T >
void incPtr (index_t what)
Protected Attributes inherited from Fiber::ElementIterator< T >
index_t length
 The length (number of elements) of the data array.
index_t stride
index_t offset
index_t shift
index_t cropped
Protected Attributes inherited from Fiber::HyperslabParameters
index_t length
 The length (number of elements) of the data array.
index_t stride
index_t offset
index_t shift
index_t cropped

Member Function Documentation

◆ getValue()

const SkeletonID & Fiber::Iterator< SkeletonID >::getValue ( index_t i) const
inline

Get the value, readonly.

Parameters
iThe index

◆ set()

void Fiber::Iterator< SkeletonID >::set ( const SkeletonID & Value)
inline

Set all elements to the same value.

Parameters
Concrete and abstract storage places for data values that are used as parameters.The value.