Wizt::FishGridSavable Class Reference

Convenience class for objects that provide a Grid that may be saved. More...

#include <FishSaver.hpp>

List of all members.

Public Member Functions

• FishGridSavable (VSaveable *what, VOutput< Grid > &SavableGrid)

  Construction time is used to store the output slot that will be used for saving.
  

• override FishBait getBait () const

  Getting the bait from the output grid that was specified during construction.
  

---

Detailed Description

Convenience class for objects that provide a Grid that may be saved.

Derive from this class and specify the output grid slot in the constructor.

Examples:

HelicalLines.cpp, and Sphere.cpp.

---

Constructor & Destructor Documentation

Wizt::FishGridSavable::FishGridSavable	(	VSaveable *	what,
		VOutput< Grid > &	SavableGrid
	)			[inline]

Construction time is used to store the output slot that will be used for saving.

Note: Only the reference to the output slot is stored here, not another reference pointer. The output slot might actually not yet have been constructed, which is the case when the child class implementing the output grid slot is derived from this class: The base class constructor will be called first (ergo us here), then later will the members be constructed (ergo the parameter that we already use here).

Examples:

HelicalLines.cpp, and Sphere.cpp.

---

Member Function Documentation

FishBait Wizt::FishGridSavable::getBait

(

)

const [virtual]

Getting the bait from the output grid that was specified during construction.

Only its global value will be used, local settings not supported.

Implements Wizt::FishSavable.

References Fiber::GridSelector::getGridname(), and Fiber::GridSelector::theSourceBundle.