FiberVISH 0.2
Fish - The Fiber Bundle API for the Vish Visualization Shell
Classes | Public Member Functions | Public Attributes | List of all members
Fiber::FragmentCluster Class Reference

A collection of field fragments, as retrieved by a FieldCollection, and possibly stored over many refinement levels. More...

#include <FragmentCluster.hpp>

Inheritance diagram for Fiber::FragmentCluster:
Fiber::FragmentIterator Wizt::Fish< Fiber::FragmentCluster >::ClusterState

Classes

struct  Iterator
 Iterator object for iterating over a fragment cluster. More...
 

Public Member Functions

 FragmentCluster ()
 Constructor (trivial)
 
 ~FragmentCluster ()
 Destructor (trivial)
 
void clear ()
 Clear all entries.
 
int addFields (FieldCollection &Fields, int RLevel, const WeakPtr< Representation > &RefinementLevel)
 Add all fragments from the given field collection to the fragments stored here, under the given level.
 
int iterate (Iterator &RFI, const RefPtr< FragmentSelector > &FS, const string &SelectionField="Positions") const
 Execute a given Iterator over the given collection of fragments, or possibly a subset of them.
 
int iterateStringList (Iterator &RFI, const RefPtr< MemCore::StringList > &FragmentNameList, const string &SelectionField="Positions")
 
int iterateOneRefClosest (Iterator &RFI, const RefPtr< FragmentSelector > &FS, const string &SelectionField, std::multimap< double, std::pair< RefPtr< FragmentID >, Eagle::PhysicalSpace::point > > &sorted_frags, double equi_dist, unsigned refinement)
 
- Public Member Functions inherited from Fiber::FragmentIterator
virtual ~FragmentIterator ()
 Destructor (virtual)
 

Public Attributes

MemCore::Ageable YoungestFieldAge
 
MemCore::Ageable OldestFieldAge
 

Detailed Description

A collection of field fragments, as retrieved by a FieldCollection, and possibly stored over many refinement levels.

Member Function Documentation

◆ iterate()

int Fiber::FragmentCluster::iterate ( Iterator RFI,
const RefPtr< FragmentSelector > &  FS,
const string &  SelectionField = "Positions" 
) const

Execute a given Iterator over the given collection of fragments, or possibly a subset of them.

Parameters
RFIThe Refinement Fragment Iterator object
FSThe Fragment Selector which will define a subset
SelectionFieldThe field that will be fed to the fragment selector in order to define a subset of the data; it may refer to the Positions same as to some fiber field, but the fragment selector must accept such fibers.

References std::map< typename _Key, typename _Tp, typename _Compare, typename _Alloc >::begin(), std::map< typename _Key, typename _Tp, typename _Compare, typename _Alloc >::end(), and std::map< typename _Key, typename _Tp, typename _Compare, typename _Alloc >::size().