Fiber::Slice Class Reference

Information per time slice, mainly a set of Grid objects that are accessed via GridID objects. More...

#include <Slice.hpp>

List of all members.

Classes

• class Loader

  An loader object that may be associated with each Slice, such that data can created on access. More...
  

Public Member Functions

• bool accessSlice ()

  Access a slice and loads its data, if they are not loaded yet.
  

• bool isNotYetLoaded () const
• bool isLoaded () const
• Slice (const WeakPtr< GridList > &IDList, const RefPtr< GlobalCharts > &Atlas)

  Construct Slice object.
  

• ~Slice ()

  Destruct Slice object.
  

• Grid & newGrid (const string &gridname)

  Create a new Grid object, overwriting an existing one.
  

• Grid & newGrid (const string &gridname, const string &ParentGridName)

  Create a new Grid object as a child relationship to an existing one, overwriting an existing one.
  

• bool insert (const string &gridname, const RefPtr< Grid > &G)

  Insert a Grid object under the given name in this slice, eventually overwriting an existing Grid.
  

• Grid & operator[] (const string &gridname)

  Retrieve a grid from a textual description, creating one, if desired.
  

• Grid & operator[] (const RefPtr< GridID > &gridname)

  Retrieve an existing grid, possibly creating one.
  

• RefPtr< GridID > makeGridID (const string &gridname)

  Get a Grid for the given textual description.
  

• RefPtr< GridID > findGridID (const string &gridname)

  Find a grid ID for a given string.
  

• RefPtr< Grid > operator() (const string &gridname)

  Find a Grid object from its textual description.
  

• RefPtr< Grid > operator() (const RefPtr< GridID > &gridname)

  Find a grid via a grid identifier.
  

• int iterate (GridIterator &GI, const RefPtr< MemCore::StringList > &TheseGridsOnly=NullPtr())

  Iterate over all or a subset of grids on this slice.
  

• int getMemoryUsage (memsize_t &UsedMemory, memsize_t &WantedMemory) const

  Memory usage.
  

Public Attributes

• RefPtr< Loader > DeferredLoader

  An optionally associated loader object.
  

---

Detailed Description

Information per time slice, mainly a set of Grid objects that are accessed via GridID objects.

A slice in the fiber bundle data model hierarchy.

Examples:

trimesh.cpp.

---

Member Function Documentation

int Slice::iterate	(	GridIterator &	GI,
		const RefPtr< MemCore::StringList > &	TheseGridsOnly = NullPtr()
	)

Iterate over all or a subset of grids on this slice.

Note:

Even when iterating just over a subset of grids, inter-grid information will still be visible, such as a relative representation of one Grid in another Grid (known as interpolation weights).

References accessSlice(), and Fiber::GridIterator::apply().

Grid & Slice::newGrid	(	const string &	gridname,
		const string &	ParentGridName
	)

Create a new Grid object as a child relationship to an existing one, overwriting an existing one.

Note:

The grid relationship will be global, independently of the specific Grid object created at this certain time slice.

References accessSlice(), findGridID(), and makeGridID().

Grid & Slice::operator[]

(

const string &

gridname

)

Retrieve a grid from a textual description, creating one, if desired.

A GridID is reused or created.

Note:

Use the newGrid() functor to create a new grid, thereby replacing an old one existing under the same name.

References accessSlice(), and makeGridID().

---

Member Data Documentation

RefPtr<Loader> Fiber::Slice::DeferredLoader

An optionally associated loader object.

If it is non-zero, it will be called upon each slice access.