Bundle Class Reference [Basic Operations dealing with semantic structures below the end-user API.]

The main entity holding all information. More...

#include <Bundle.hpp>

List of all members.

Public Types

• typedef
  MemCore::LoaderRegistry
  < Bundle > Loader
• typedef Info< Slice > SliceInfo_t

  The information as returned by a query for Slices.
  

• typedef Info< Grid > GridInfo_t

  The information as returned by a query for Grids.
  

• typedef Info< Skeleton > SkeletonInfo_t

  The information as returned by a query for Skeletons.
  

• typedef std::pair< double, double > Range_t

Public Member Functions

• bool merge (const RefPtr< LoaderParameters > &LP)

  Check whether some URL looks like something that might be loadable.
  

• Bundle ()

  Constructor.
  

• void DeferredConstructor ()

  Deferred Constructor (.
  

• ~Bundle ()

  Destructor.
  

• double minTime () const

  Return the minimal time, i.e.
  

• double maxTime () const

  Return the maximal time, i.e.
  

• SliceInfo_t firstSlice () const

  Return the first slice in this bundle.
  

• bool accessFirstSlice () const

  Access the first slice of this bundle, which implies loading or creating any metadata as associated with this bundle.
  

• Slice & operator[] (double time)

  Access one-dimensional index space, possibly creating an Slice entry.
  

• Slice & operator[] (const ParameterSet &)

  Access n-dimensional index space, possibly creating an Slice entry.
  

• SlicePtr operator() (double &time) const

  Query the one-dimensional index space for a Slice entry.
  

• SlicePtr findPrev (double &time) const
• SlicePtr findNext (double &time) const
• SliceInfo_t prev (double time) const

  Return the time slice just before the given time.
  

• SliceInfo_t next (double time) const

  Return the time slice just next after the given time.
  

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

  Query the one-dimensional index space for a Grid.
  

• RefPtr< Grid > newGrid () const

  Create a new Grid object that lives on this Bundle, but is not yet associated to any time, and yet unnamed.
  

• GridInfo_t findMostRecentGrid (double time, const string &gridname) const

  Return information when the requested grid was found most recently.
  

• GridInfo_t findMostRecentGrid (double time, const RefPtr< GridID > &gridid) const

  Return information when the requested grid was found most recently.
  

• Info< Grid > findPrev (double time, const string &gridname) const

  Find the latest existence of the grid object that exists at the current time.
  

• Info< Grid > findPrev (double time, const RefPtr< GridID > &gridname) const
• Info< Grid > findNext (double time, const string &gridname) const

  Find the next grid object that exists after the current time.
  

• Info< Grid > findNext (double time, const RefPtr< GridID > &gridname) const
• int iterateBackward (double &time, const string &gridname, EvolutionIterator< Grid > &GEI, bool IterateOnlyLoadedSlices) const

  Starting with the given time, find all grids that reside before this time until the GridEvolutionIterator returns false or there are no more such grids.
  

• int iterateForward (double &time, const string &gridname, EvolutionIterator< Grid > &GEI, bool IterateOnlyLoadedSlices) const

  Starting with the given time, find all grids that reside after this time until the GridEvolutionIterator returns false or there are no more such grids.
  

• SkeletonInfo_t findPreviousRefinementLevel (double &T, const string &gridname, int Level, EvolutionIterator< Skeleton > *EIS, int IndexDepth)
• SkeletonInfo_t findPreviousRefinementLevel (double &T, const string &gridname, int Level, int IndexDepth=0)

  Find the most recent refinement level of an adaptive mesh, which resides at a time before the current one.
  

• SkeletonInfo_t findPreviousRefinementLevel (double &T, const string &gridname, int Level, EvolutionIterator< Skeleton > &EIS, int IndexDepth=0)
• SkeletonInfo_t findNextRefinementLevel (double &T, const string &gridname, int Level, int IndexDepth=0)
• RefPtr< Grid > operator() (double time, const RefPtr< GridID > &gridname) const

  Query the one-dimensional index space for a Grid.
  

• RefPtr< Slice > operator() (const ParameterSet &) const

  Query the n-dimensional index space for a Slice entry.
  

• int sizeP1D () const

  The size of the one-dimensional parameter space.
  

• const ParameterList & AllParameters () const
• int iterate (const ParameterList &PL, EvolutionIterator< Slice > &SI) const
• Range_t getTimeRange (const string &Gridname, bool OnlyInspectAlreadyLoadedSlices=false)
• int getMemoryUsage (memsize_t &UsedMemory, memsize_t &WantedMemory) const

  Get the memory occupied by this Bundle (and all of its Grids).
  

Static Public Member Functions

• static RefPtr< Bundle > load (bool &success, const RefPtr< LoaderParameters > &ld, const RefPtr< Bundle > &B=NullPtr())

  Load a Bundle object or append new data to an existing Bundle.
  

• static RefPtr< Bundle > load (bool &success, const string &url, const RefPtr< Bundle > &B=NullPtr(), const RefPtr< LoaderProgress > &Progress=NullPtr(), bool detect_sequence=false)

Related Functions

(Note that these are not member functions.)

• class BUNDLE_API EvolutionIterator

  Generic template definition for iterators over objects on many time steps.
  

---

Detailed Description

The main entity holding all information.

A Bundle is a set of Slice objects, each of them accessed via some floating-point value, which is usually interpreted as time.

Note: by inheritance, the Bundle object allows to query GridID's from strings as well, see class GridList for details.

---

Member Function Documentation

void Bundle::DeferredConstructor

(

)

Deferred Constructor (.

See also:

MemCore::DeferredInitializationTrait<>)

Bundle::GridInfo_t Bundle::findMostRecentGrid	(	double	time,
		const string &	gridname
	)			const

Return information when the requested grid was found most recently.

Search from back to front

Referenced by findMostRecentGrid().

Info< Grid > Bundle::findNext	(	double	time,
		const string &	gridname
	)			const

Find the next grid object that exists after the current time.

See also:

findPrevious()

Info< Grid > Bundle::findPrev	(	double	time,
		const string &	gridname
	)			const

Find the latest existence of the grid object that exists at the current time.

See also:

findNext()

int Bundle::getMemoryUsage	(	memsize_t &	UsedMemory,
		memsize_t &	WantedMemory
	)			const

Get the memory occupied by this Bundle (and all of its Grids).

Not that if a Grid is shared on another location then it will be counted twice here. Use the MemCache::Cache function to determine the actual memory usage.

int Bundle::iterateBackward	(	double &	time,
		const string &	gridname,
		EvolutionIterator< Grid > &	GEI,
		bool	IterateOnlyLoadedSlices
	)			const

Starting with the given time, find all grids that reside before this time until the GridEvolutionIterator returns false or there are no more such grids.

Parameters:

	time	The initial time, will be modified(!) during traversal towards the first Grid found
	IterateOnlyLoadedSlices	Specify if the iteration shall only be performed over those Slices that have already been loaded.

int Bundle::iterateForward	(	double &	time,
		const string &	gridname,
		EvolutionIterator< Grid > &	GEI,
		bool	IterateOnlyLoadedSlices
	)			const

Starting with the given time, find all grids that reside after this time until the GridEvolutionIterator returns false or there are no more such grids.

Parameters:

	time	The initial time, will be modified(!) during traversal towards the first Grid found
	IterateOnlyLoadedSlices	Specify if the iteration shall only be performed over those Slices that have already been loaded.

RefPtr< Bundle > Bundle::load	(	bool &	success,
		const RefPtr< LoaderParameters > &	ld,
		const RefPtr< Bundle > &	B = NullPtr()
	)			[static]

Load a Bundle object or append new data to an existing Bundle.

Creates a new Bundle object from an external device, as specified by the LoaderParameters, e.g. a file or an URL.

Parameters:

	success	Boolean that informs about the success of the load action. An eventual error code can be found in the LoaderParameters argument
	ld	Collection of all information that is required for loading data. Includes things like filename, interaction callback object and possible error code retrieval.
	B	Pointer to an eventually existing bundle.

double Bundle::maxTime

(

)

const

Return the maximal time, i.e.

the highest coordinate value of the one-dimensional parameter space.

bool Bundle::merge

(

const RefPtr< LoaderParameters > &

LP

)

Check whether some URL looks like something that might be loadable.

Merge data from an external device (file, URL, ...) to the current Bundle object. The Bundle object must already be referenced via a strong reference pointer.

double Bundle::minTime

(

)

const

Return the minimal time, i.e.

the lowest coordinate value of the one-dimensional parameter space.

RefPtr<Grid> Bundle::newGrid

(

)

const [inline]

Create a new Grid object that lives on this Bundle, but is not yet associated to any time, and yet unnamed.

It is thus ready for later insertion into some Slice on this Bundle.

int Bundle::sizeP1D

(

)

const [inline]

The size of the one-dimensional parameter space.

For instance, this is the number of time slices in a time evolution.

---

Friends And Related Function Documentation

class BUNDLE_API EvolutionIterator [related]

Generic template definition for iterators over objects on many time steps.

The generic template is not used at all, it is only used to provide a pretty name for the specific iterators, which are EvolutionIterator<Slice>, EvolutionIterator<Grid>, EvolutionIterator<Skeleton>, EvolutionIterator<Field> , Slice