Common base class for objects that provide Grid objects. More...

#include <GridProviderObject.hpp>

Inheritance diagram for Wizt::GridProviderObject:

Public Member Functions
	GridProviderObject (const string &name, int p, const RefPtr< VCreationPreferences > &VP, const string &GridSlotName="grid")
	Constructor.
	~GridProviderObject ()
	Destructor.
void	resetOutputs (const VRequest &Context)
bool	hasNewOutputConnected (const VRequest &Context) const
std::string	type_key () const override
bool	must_update (const VRequest &, double precision) const override
void	provideMetaInfo (const VRequest &Context, const GridSelector &CurrentSL, const Fiber::Info< Fiber::Grid > &iG=Fiber::Info< Fiber::Grid >(0.0))
	Defines optional time range and bounding box information (if requested) for the provided grid object.
const char const	xpm_icon () const override
Public Member Functions inherited from Wizt::FishObject
	FishObject (const string &name, int p, const RefPtr< VCreationPreferences > &VP)
	Constructor.
	~FishObject ()
	Destructor.
void	updateBundleInformation (const Fiber::Bundle &B)
	Update time range and announce charts that exist on this bundle.
Public Member Functions inherited from Wizt::VObject
string	CreatorName () const
const WeakPtrVCreatorBase &	getCreator () const
virtual bool	request (VRequest &, double precision, const WeakVObjectPtr &ImmediateRequestor, const WeakVObjectPtr &RootRequestor)
bool	schedule (double precision, const RefPtr< ValuePool > &Context=nullptr)
void	enableRequestProcessing ()
void	disableRequestProcessing ()
bool	acceptsRequests () const
const MemCore::Counter &	UpdateCount () const
const MemCore::Counter &	RequestCount () const
	VObject (const string &name, int p, const RefPtr< VCreationPreferences > &VP)
virtual const GimpIcon *	gimp_icon () const
virtual string	qt_icon () const
virtual string	help (HelpType=HTMLText) const
bool	setObjectAsChild (const VObjectPtr &childVObject, const string &DependencySlotName)
double	requestTime () const
void	remove ()
const RefPtr< VCreationPreferences > &	CreationPreferences () const
void	iterateParents (VObjectIterator &VOI, int EL=0) const
int	iterateParents (const VObjectIterator_f &VOI, int EL=0) const
virtual string	CreateParameterName (const ParameterID &name) const
int	iterateChildren (ChildIterator &) const
int	findChildren (const Lambda &theLambda) const
std::list< std::vector< std::string > >	getProvenance () const
AttachErrorCode	attachNewObject (const RefPtr< VSlot > &slot, const string &name, const Intercube &CreationContext, const RefPtr< VCreationPreferences > &VCP=nullptr)
AttachErrorCode	attachNewObject (const RefPtr< VSlot > &slot, const string &name, const RefPtr< VCreationPreferences > &VCP=nullptr)
AttachErrorCode	attachInputObject (const RefPtr< VSlot > &slot, const string &name={}, const RefPtr< VCreationPreferences > &VCP=nullptr, bool ReallyUnique=true)
CreateConnectionResult_t	createChild (const VAcception &VA, const Intercube &CreationContext)
CreateConnectionResult_t	connectChild (const VObjectPtr &ChildObject, const RefPtr< VAcceptInfo > &VA)
CreateConnectionResult_t	connectAsChild (const VObjectPtr &ChildObject, const VAcception &VA)
virtual void	InputCreation (const RefPtr< VParameter > &CurrentObjectsInput, const VObjectPtr &NewlyCreatedObject, const RefPtr< VParameter > &TheNewObjectsOutputParameter)
VObjectPtr	createInput (const WeakPtrVCreatorBase &VCrec, const RefPtr< VSlot > &what, const string &name, Intercube &CreationContext)
VObjectPtr	extractSlot (const RefPtr< VSlot > &theSlot, const string &theNewName=string()) const
Public Member Functions inherited from MemCore::ReferenceBase< VManagedObjectBase >
auto	getObjectCountID () const noexcept
bool	isIdentical (const WeakPtr< Object, Object > &PossibleSelf) const noexcept
void	mkAutoDestructive ()
refcount_t	refcount () const noexcept
	ReferenceBase (Object *that) noexcept
const auto &	self () const
refcount_t	wrefcount () const noexcept
Public Member Functions inherited from Wizt::VConnectable
virtual void	adjustConnections (const RefPtr< VSlot > &ChangedSlot, const RefPtr< VParameter > &par)
VSlotContainer::AttachErrorCode	attach (const ParameterID &whichone, VSlotContainer &sourceObject, const ParameterID &sourceName)
AttachErrorCode	attach (const RefPtr< VParameter > &OldParam, const RefPtr< VParameter > &NewParam, const string &Member={})
AttachErrorCode	attachUniqueObject (const RefPtr< VParameter > &param, const RefPtr< VCreationPreferences > &VCP=NullPtr(), bool ReallyUnique=true)
AttachErrorCode	attachUniqueObject (const RefPtr< VSlot > &slot, const RefPtr< VCreationPreferences > &VCP=NullPtr(), bool ReallyUnique=true)
RefPtr< VSlot >	Connect (const RefPtr< VParameter > &SourceParam)
RefPtr< VSlot >	ConnectInterface (const RefPtr< VSlotContainer > &Provider, const RefPtr< InterfaceBase > &IB)
virtual bool	CreatedFilteredConnection (const RefPtr< VParameter > &SourceParam)
Public Member Functions inherited from Wizt::VSlotContainer
Ageable &	age (const RefPtr< ValuePool > &VP)
const Ageable &	age (const RefPtr< ValuePool > &VP) const
const Ageable &	ConnectionAge () const
bool	ConnectionsHaveChanged (const RefPtr< ValuePool > &VP) const
bool	HasYoungerInput (const RefPtr< ValuePool > &Context, int RecursionLevel=0) const
Ageable	YoungestInput (const RefPtr< ValuePool > &Context) const
Ageable	YoungestOutput (const RefPtr< ValuePool > &Context) const
Ageable	YoungestUncachedInput (const RefPtr< ValuePool > &Context) const
bool	CheckIfThereExistNewerOutputs (const VRequest &request, bool AdjustObjectAge) const
RefPtr< VSlot >	addParameter (const ParameterID &name, int EL, const RefPtr< VParameter > &param, bool overwriteExistingSlot)
virtual bool	allowParameterReplacement (const RefPtr< VParameter > &NewParam, const RefPtr< VParameter > &OldParam, const string &localName, int ExpertLevel)
virtual int	connectSlots (const VSlotContainerPtr &vobj)
bool	removeParameter (const ParameterID &s)
RefPtr< VParameter >	getParameter (const ParameterID &s) const
RefPtr< VSlot >	getSlot (const ParameterID &s, int &EL) const
bool	setSlotValueFromText (const ParameterID &s, const string &ValueText, const RefPtr< ValuePool > &VP, const string &theMember={})
RefPtr< VSlot >	findSlot (const RefPtr< VParameter > &param) const
string	getSlotName (const RefPtr< VParameter > &param) const
bool	AddAction (const ParameterID &s, const RefPtr< ValueActionBase > &VAB)
bool	AddAction (const RefPtr< VSlot > &ActionSlot, bool(DerivedObject::*Action)(const RefPtr< VValueBase > &value))
RefPtr< VParameter >	mkUniqueParameterInput (const ParameterID &s, const string &ContainerName)
int	getExpertLevel (const ParameterID &s) const
int	setExpertLevel (const ParameterID &s, int EL)
int	getExpertLevel (const RefPtr< VParameter > &) const
int	getExpertLevel (const RefPtr< VSlot > &S) const
int	setExpertLevel (const RefPtr< VSlot > &S, int EL)
int	setExpertLevel (const RefPtr< VParameter > &s, int EL)
bool	hasChanged (const ParameterID &s, const RefPtr< ValuePool > &Context) const
bool	hasChanged (const RefPtr< VSlot > &, const RefPtr< ValuePool > &Context) const
bool	hasChanged (const RefPtr< ValuePool > &Context, int n,...) const
bool	hasChanged (RefPtr< ValuePool > Context,...) const
virtual bool	ignoreInput (const RefPtr< VSlot > &theSlot) const
bool	getParameterValue (Type &Variable, const ParameterID &s, const RefPtr< ValuePool > &VP) const
bool	getParameterValue (Type &Variable, const ParameterID &s, const VContext &C) const
bool	getParameterValue (Type &Variable, const ParameterID &s, const VRequest &R) const
bool	setParameterValue (const Type &Variable, const ParameterID &s, const RefPtr< ValuePool > &VP, bool autoCreateLocalValue) const
bool	setParameterValue (const Type &Variable, const ParameterID &s, VContext &C, bool autoCreateLocalValue) const
bool	setParameterValue (const Type &Variable, const ParameterID &s, VRequest &R, bool autoCreateLocalValue=false) const
RefPtr< VSlot >	addParam (const ParameterID &name, const Type &init, const RefPtr< VCreationPreferences > &VP=NullPtr(), int expertLevel=0, bool overwriteExistingSlot=true)
bool	setParameterProperty (const ParameterID &param, const string &Properties, const RefPtr< VValueBase > &Value=NullPtr())
RefPtr< VSlot >	addFloatParam (double init, const ParameterID &param, double min, double max, const RefPtr< VCreationPreferences > &IP=NullPtr(), int expertLevel=0)
AttachErrorCode	attach (const RefPtr< VParameter > &OldParam, const RefPtr< VParameter > &NewParam, const string &Member={})
int	iterateParameters (int expertLevel, VSlotIterator &VIIt) const
int	iterateInputSlots (int expertLevel, VSlotIterator &VIIt) const
int	iterateInputs (VSlotIterator &VIIt, int expertLevel=0)
int	iterate_inputs (const std::function< bool(VSlot &what, int ExpertLevel)>) const
RefPtr< VSlot >	getUniqueInputSlot (const type_info &what)
int	getNumberOfParameters (int expertLevel) const
virtual bool	implements (const type_info &what) const
virtual RefPtr< VParameter >	getImplementation (const type_info &what, const string &name={}, const string &member={}) const
RefPtr< VSlot >	getImplementationSlot (const type_info &what, const string &Name={}, const string &Member={}) const
VAcceptInfoList_t	getAcceptInfoList (const std::type_info &request_type) const
bool	provides (const RefPtr< VSlot > &OutputSlot) const
RefPtr< VSlot >	findOutputSlot (const RefPtr< VParameter > &Who) const
bool	isYounger (const RefPtr< VParameter > &OutputParam, const RefPtr< ValuePool > &VP) const
bool	isNewlyConnected (const RefPtr< VParameter > &Who, const RefPtr< ValuePool > &VP) const
bool	hasNewlyConnectedOutputs (const RefPtr< ValuePool > &VP) const
void	findNewlyConnectedOutputs (const RefPtr< ValuePool > &VP, VSlotSet &WhichOnes) const
RefPtr< VSlot >	getOutput (const string &Name) const
RefPtr< MemCore::StringList >	getOutputs (const type_info &what=typeid(void)) const
virtual int	iterateOutputs (VOutputIterator &VOut, const type_info &just_these=typeid(void)) const
bool	registerOutput (const RefPtr< VParameter > &P, const string &AsName={})
bool	registerOutput (const RefPtr< VParameter > &P, const string &AsName, const type_info &MemberType, const string &UseMember)
bool	registerOutput (const RefPtr< VParameter > &P, const type_info &MemberType, const string &UseMember)
int	getNumberOfInputs () const
int	getNumberOfOutputs () const
bool	hasChangedSlots (const MemCore::Intercube &IC, const RefPtr< ValuePool > &Context) const
auto	include_self (const std::tuple< SlotList... > &t) const -> decltype(std::tuple_cat(std::make_tuple(this), t))
Public Member Functions inherited from Wizt::VStateCreatorBase
RefPtr< State > &	getState (const WeakPtr< ValuePool > &VP) const
RefPtr< InterfaceBase >	hasLocalInterface (const type_info &InterfaceType) const
RefPtr< State >	myState (const WeakPtr< ValuePool > &Context) const
virtual RefPtr< State >	newState () const
void	setState (const WeakPtr< ValuePool > &, const RefPtr< State > &st) const
Public Member Functions inherited from Wizt::VSaveable
void	addSaver (const string &, const RefPtr< VishSaver > &)
void	addSavers (AppClass &A)
bool	autosave () const
RefPtr< VishSaver >	getMostRecentSaver () const
size_t	getNumberOfSavers () const
RefPtr< VishSaver >	getSaver (const string &) const
RefPtr< VishSaver >	getSaverByExt (const string &ext) const
int	iterate_savers (const save_iterator &si) const
Public Member Functions inherited from Wizt::VManagedDomainObject< VObject >
const type_info &	getDomainType () const override
void	remove ()
	VManagedDomainObject (const string &name, int priority=DEFAULT_PRIORITY)
Public Member Functions inherited from Wizt::VManagedObject
string	getLoadModule () const
void	insert (const string &s, int priority=DEFAULT_PRIORITY)
void	remove ()
void	setPriority (int priority)
	VManagedObject (const string &name, int priority=DEFAULT_PRIORITY)
Public Member Functions inherited from MemCore::Intercube
void	addInterface (const RefPtr< InterfaceBase > &I) const
void	addInterfaceData (const Data &D)
void	addInterfaceData (const Data &D)
void	clearInterfaces ()
bool	const_iterateInterfaces (const RefPtr< InterfaceIterationParameter > &IIP) const
virtual RefPtr< InterfaceBase >	createInterface (const type_info &) const
RefPtr< InterfaceBase >	findInterface (const type_info &t) const
RefPtr< InterfaceBase >	getInterface (const type_info &t)
std::string	getInterfaceNames (const char delim=';') const
bool	gotNewInterfaceData (const Data &D)
bool	gotNewInterfaceData (mutex &M, const Data &D)
bool	gotNewInterfaceData (mutex &M, const Data &D)
bool	gotNewInterfaceData (mutex &M, const Data &D, const Selector &S)
bool	gotNewInterfaceData (mutex &M, const Data &D, const Selector *S)
bool	hasChangedInterfaceData (const Data &D) const
bool	hasChangedInterfaceData (const Data &D) const
bool	hasChangedInterfaceData (const Data &D, const Selector &) const
bool	hasChangedInterfaceData (const Data &D, const Selector *) const
bool	hasInterface (const type_info &t) const
bool	iterateInterfaces (const RefPtr< InterfaceIterationParameter > &IIP)
void	printInterfaces () const
void	registerInterface (const type_info &t)
void	removeInterface ()
void	removeInterfaceBase (const type_info &InterfaceBaseID)
Public Member Functions inherited from MemCore::MutableName
void	addNameChangeNotifier (const WeakPtr< Notifier > &)
std::string	BaseName (const char Separator) const
const std::string &	getName () const
	MutableName (const std::string &theName)
const std::string &	Name () const
void	rename (const std::string &newName)
void	setName (const std::string &newName)
Public Member Functions inherited from Wizt::VScriptable
RefPtr< VScriptFunctor >	findFunctor (const string &name) const
RefPtr< VScriptFunctor >	insertFunctor (const string &name, const RefPtr< VScriptFunctor > &)
bool	iterate (iterator &it)
int	nFunctors () const
void	removeFunctor (const string &name)
Public Member Functions inherited from Wizt::VTraceRequestID
bool	addRequest (const VRequest &request)
bool	hasRequest (const VRequest &request) const
Public Member Functions inherited from Wizt::FishGridSavable
	FishGridSavable (VSaveable *what, VOutput< Grid > &SavableGrid)
	Construction time is used to store the output slot that will be used for saving.
FishBait	getBait () const override
	Getting the bait from the output grid that was specified during construction.
Public Member Functions inherited from Wizt::FishSavable
	FishSavable (VSaveable *what)
	Constructor creates its own FishWharf and registers a FishSaver on the provided VSaveable.

Public Attributes
VOutput< Fiber::Grid >	myGrid
VOutput< VBoundingBox >	BBox
VOutput< Fiber::Field >	myPositionsField
	Grid objects provide their positions field automatically.
Public Attributes inherited from Wizt::FishObject
VOutput< VTimeRange >	TimeRange
Public Attributes inherited from Wizt::VObject
	HelpURL
	HTMLText
	PlainText
	ShortHTMLText
	ShortText
std::string	whyupdate
string	UserInfo
Public Attributes inherited from Wizt::VSlotContainer
	AllLevels
	DestParameterNotFound
	InvalidDestParameter

Additional Inherited Members
Public Types inherited from Wizt::VObject
enum	HelpType
typedef void	AcceptableInputTypes
typedef VConnectable::Empty< I >	Empty
typedef std::function< bool(const RefPtr< VObject > &vobj, const VSlot &ChildConnection)>	VObjectIterator_f
Public Types inherited from MemCore::ReferenceBase< VManagedObjectBase >
typedef Object	reference_domain_t
typedef WeakPtr< Object, Object >	SelfPtr_t
Public Types inherited from Wizt::VSlotContainer
enum	AttachErrorCode
typedef void	AcceptableInputTypes
typedef VSlotSet	CreationSlots_t
typedef VSlot::Empty< I >	Empty
Public Types inherited from Wizt::VSaveable
typedef std::function< bool(const string &s, VishSaver &VS)>	save_iterator
Public Types inherited from Wizt::VManagedDomainObject< VObject >
typedef What	Domain_t
Static Public Member Functions inherited from Wizt::VObject
static bool	remove (const string &s)
static int	findOutputObjects (const type_info &Type, OutputObjectIterator &GOutputs)
static string	createChildname (const string &parent_name)
static VAcceptInfoList_t	accept (const VObjectPtr &vobj)
static RefPtr< VParameter >	findUniqueOutputObject (const type_info &Type, const RefPtr< VCreationPreferences > &VCP, bool ReallyUnique, const VObject *NotThisOne)
Static Public Member Functions inherited from Wizt::VConnectable
static bool	attachSlot (const WeakPtr< VSlot > &DestSlot, const RefPtr< VParameter > &ProvidedParam, const string &Member={})
static bool	attachSlot (const WeakPtr< VSlot > &DestSlot, const RefPtr< VSlot > &SourceSlot, const string &Member={})
static bool	detachSlot (const RefPtr< VSlot > &SourceSlot)
Static Public Member Functions inherited from Wizt::VSlotContainer
static const char *	AttachErrorCodeMessage (AttachErrorCode)
static bool	attachParameter (const RefPtr< VParameter > &theProvidedParam, const WeakPtr< VSlot > &theDestSlot, const string &theMember={})
Static Public Member Functions inherited from Wizt::ValueCacheable
static ValueCache &	consider (MemCore::Intercube &IC, const WeakPtr< VSlot > &VS, const RefPtr< ValuePool > &Context)
static ValueCache &	getValueCache (MemCore::Intercube &IC)
static bool	hasChangedSlots (const WeakPtrToVSlotContainer &theSlotOwner, const MemCore::Intercube &IC, const RefPtr< ValuePool > &Context)
Static Public Member Functions inherited from Wizt::VSaveable
static VSaveable &	GlobalState ()
Static Public Member Functions inherited from Wizt::VManagedDomainObject< VObject >
static RefPtr< VManagedObject >	find (const string &s)
static int	iterate (VManagedObjectIterator_t VIt, int p_start=INT_MIN, int p_end=INT_MAX)
static int	size ()
static int	traverse (VManagedObjectIterator &VIt, int p_start=INT_MIN, int p_end=INT_MAX)
Static Public Member Functions inherited from Wizt::VManagedObject
static int	count ()
static VManagedObjectPtr	find (const type_info &, const std::string &s)
static bool	InitDomain (const type_info &)
static int	iterateModules (ModuleIterator &VIM)
static int	size (const type_info &)
static int	traverse (const type_info &, VManagedObjectIterator &VIt, int p_start, int p_end)
static void	UnloadVModule (const string &what, VRemoveItem &RI)
Static Public Member Functions inherited from MemCore::MutableName
static std::string	BaseName (const std::string &theName, const char Separator)
Static Public Attributes inherited from Wizt::VObject
static constexpr char	NameSeparator
static constexpr char	SlotNameSeparator
Static Public Attributes inherited from Wizt::VManagedObject
static string	CurrentLoadModule
Protected Types inherited from Wizt::VObject
typedef bool(*	UpdateFunction) (VObject *, VRequest &, double precision)
Protected Member Functions inherited from Wizt::VObject
virtual bool	update (VRequest &, double precision=1.0)
virtual bool	unsychronized_update (VRequest &VR, double precision)
Protected Member Functions inherited from MemCore::ReferenceBase< VManagedObjectBase >
virtual void	extremeUnction ()
ReferenceBase &	operator= (const ReferenceBase &R)
void	suicide ()
Protected Member Functions inherited from Wizt::VSlotContainer
virtual void	setup (const CreationSlots_t &CreationSlots)
Protected Attributes inherited from Wizt::VObject
MemCore::Counter	UpdateCounter
MemCore::Counter	RequestCounter

Detailed Description

Common base class for objects that provide Grid objects.

Minimal code for implementing a GridProviderObject is as follows:

using namespace Wizt;
using namespace Fiber;
 
namespace
{
 
struct  MyObject : GridProviderObject
{
        MyObject(const string&name, int p,
                 const RefPtr<VCreationPreferences>&VP)
        : GridProviderObject(name, p, VP, "grid")
        {}
 
        bool update(VRequest&R, double precision) override;
};
 
bool    MyObject::update(VRequest&Context, double precision)
{
GridSelector OutputGS;
 
//      ... initialize / compute / determine ...
 
        myGrid << Context <<= OutputGS;
        provideMetaInfo(Context, OutputGS);
        return true;
}
 
using namespace ProtoOcean;
 
static  VSource<MyObject, Grid>
myCreator( VIdentifier("MyObject") + Category("Demo"),
        ObjectQuality::DEMO
        );
 
}

Note: Reminder on virtual base classes: The order of execution of construction and destruction are mirror images of each other. When a class is constructed, the order of initialization is always the same: the virtual base class subobjects first ("in the order they appear on a depth-first left-to-right traversal of the directed acyclic graph of base classes," according to the standard), followed by the immediate base classes in the order of their appearance on the base-list in the class's definition, followed by the non-static data members of the class, in the order of their declaration, followed by the body of the constructor.

Member Function Documentation

◆ provideMetaInfo()

void Wizt::GridProviderObject::provideMetaInfo	(	const VRequest &	Context,
		const GridSelector &	CurrentSL,
		const Fiber::Info< Fiber::Grid > &	iG = Fiber::Info<Fiber::Grid>( 0.0 ) )

Defines optional time range and bounding box information (if requested) for the provided grid object.

This function should be called in the update() function once the output GridSelector has been determined, which is usually just close to the final return. For instance:

bool    MyGridObject::update(VRequest&Context, double precision)
{
GridSelector OutputGS;
 
        ... initialize / compute / determine ...
 
        myGrid << Context <<= OutputGS;
        provideMetaInfo(Context, OutputGS);
        return true;
}

Calling this function appropriately will allow correct bounding box and time range information available directly from this VObject.

References Wizt::VSlotContainer::age(), Wizt::VSlotContainer::findOutputSlot(), Fiber::GridSelector::getBundle(), Fiber::GridSelector::Gridname(), myPositionsField, MemCore::MutableName::Name(), and Wizt::Ageable::update().

◆ type_key()

std::string Wizt::GridProviderObject::type_key ( ) const

overridevirtual

Reimplemented from Wizt::VObject.

◆ xpm_icon()

const char *const * Wizt::GridProviderObject::xpm_icon ( ) const