Possible base class for VNutrition objects that operate on files that can be loaded as Fiber Bundle. More...

#include <FiberNutrition.hpp>

Inheritance diagram for Wizt::FiberNutrition:

Public Types
using	Bundle = Fiber::Bundle
using	Grid = Fiber::Grid
Public Types inherited from Wizt::VNutrition
typedef std::tuple< html, std::string >	analysis_return_t
typedef string	fileid
typedef std::set< fileid >	FileList_t
typedef std::set< string >	Genres_t
typedef string	html
typedef std::function< void(const WeakPtr< VNutrition > &)>	NutritionIterator
Public Types inherited from Wizt::VSlotContainer
enum	AttachErrorCode
typedef void	AcceptableInputTypes
typedef VSlotSet	CreationSlots_t
typedef VSlot::Empty< I >	Empty
Public Types inherited from MemCore::ReferenceBase< VManagedObjectBase >
typedef Object	reference_domain_t
typedef WeakPtr< Object, Object >	SelfPtr_t
Public Types inherited from Wizt::VManagedDomainObject< VNutrition >
typedef What	Domain_t

Public Member Functions
html	getFileInfo (const string &file_url, bool getExtendedSlowInfo) const
	FiberNutrition (const string &name, const string &Description, const std::initializer_list< string > &exts={"f5"})
virtual html	getGridInfo (const Bundle &B, const string &Gridname) const
	Provide info per grid for the quickinfo() function.
html	quickinfo (const FileList_t &F) const override
	Implement the quick info for showing properties of all the files given on the argument list.
analysis_return_t	analyse (const FileList_t &F) override
virtual bool	checkGridPropertyDigestibility (const Grid &G, const Bundle &B, const string &Gridname) const
	Check whether a particular Grid is digestible, which may for instance merely check the Grid attributes.
virtual bool	checkGridDigestibility (const Bundle &B, const string &Gridname) const
	Check whether a Grid with the given name on the Bundle is digestible.
virtual bool	checkBundleDigestibility (const fileid &f) const
	Check whether a file is digestible by trying to load it as a Bundle and inspecting its contents.
bool	checkFileExtensionDigestibility (const fileid &f) const
	Check if the file ends with .f5 .
bool	digestible (const fileid &f) const override
	The general function to check whether a given file can be used by this Nutrition instance.
Public Member Functions inherited from Wizt::VNutrition
int	computeExpectedOutput (FileList_t &OutputFiles, const string &OutputPath, const FileList_t &InputFiles, const string &NewExtension) const
virtual html	digest (FileList_t &OutputFiles, const string &OutputPath, const std::function< string(const string &)> &OutputFileModifier, const FileList_t &theInputFiles, const MemCore::RefPtr< MemCore::LoaderProgress > &theProgress, map< string, string > &ActualFilenames)
virtual int	expectedOutput (FileList_t &OutputFiles, const string &OutputPath, const FileList_t &InputFiles) const=0
unsigned	getExtensions (const std::function< void(const string &)> &callback) const
void	registerViaExtension (const string &ext) const
	VNutrition (const string &Name, const string &Description, const MemCore::StringList &exts, const RefPtr< VCreationPreferences > &CreationPreferences=nullptr)
	VNutrition (const string &Name, const string &Description, const RefPtr< VCreationPreferences > &CreationPreferences=nullptr)
	VNutrition (const string &Name, const string &Description, const std::initializer_list< string > &exts, const RefPtr< VCreationPreferences > &CreationPreferences=nullptr)
	VNutrition (const string &Name, const string &Description, const string &ext, const RefPtr< VCreationPreferences > &CreationPreferences=nullptr)
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 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::VManagedDomainObject< VNutrition >
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)

Static Public Member Functions
static string	estimateGridname (const string &file_url)
	Given the full path of a filename, try to estimate a meaningful grid name from it.
Static Public Member Functions inherited from Wizt::VNutrition
static unsigned	iterate (const std::function< void(const string &ext, const WeakPtr< VNutrition > &)> &)
static unsigned	iterate (const string &ext, const NutritionIterator &NI)
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::VManagedDomainObject< VNutrition >
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
static const char *	GridnameHelptext
Static Public Attributes inherited from Wizt::VManagedObject
static string	CurrentLoadModule

Additional Inherited Members
Public Attributes inherited from Wizt::VNutrition
const string	Description
Genres_t	Genres
FileList_t	OutputExtensions
Public Attributes inherited from Wizt::VSlotContainer
	AllLevels
	DestParameterNotFound
	InvalidDestParameter
Protected Member Functions inherited from Wizt::VSlotContainer
virtual void	setup (const CreationSlots_t &CreationSlots)
Protected Member Functions inherited from MemCore::ReferenceBase< VManagedObjectBase >
virtual void	extremeUnction ()
ReferenceBase &	operator= (const ReferenceBase &R)
void	suicide ()

Detailed Description

Possible base class for VNutrition objects that operate on files that can be loaded as Fiber Bundle.

Member Function Documentation

◆ analyse()

FiberNutrition::analysis_return_t Wizt::FiberNutrition::analyse ( const FileList_t & F )

overridevirtual

Implements Wizt::VNutrition.

◆ checkBundleDigestibility()

bool Wizt::FiberNutrition::checkBundleDigestibility ( const fileid & f ) const

virtual

Check whether a file is digestible by trying to load it as a Bundle and inspecting its contents.

This is a much deeper and slower check than just checking the file extension.

References checkGridDigestibility(), and Fiber::Bundle::load().

Referenced by digestible().

◆ checkGridDigestibility()

bool Wizt::FiberNutrition::checkGridDigestibility	(	const Bundle &	B,
		const string &	Gridname ) const

virtual

Check whether a Grid with the given name on the Bundle is digestible.

By default, this function will load the Grid object - which can be a SLOW operation - and calls the checkGridPropertyDigestibility() function.

References checkGridPropertyDigestibility().

Referenced by checkBundleDigestibility().

◆ checkGridPropertyDigestibility()

bool Wizt::FiberNutrition::checkGridPropertyDigestibility	(	const Grid &	G,
		const Bundle &	B,
		const string &	Gridname ) const

virtual

Check whether a particular Grid is digestible, which may for instance merely check the Grid attributes.

By default this function does nothing and returns true for any Grid.

Referenced by checkGridDigestibility().

◆ digestible()

bool Wizt::FiberNutrition::digestible ( const fileid & f ) const

overridevirtual

The general function to check whether a given file can be used by this Nutrition instance.

The default function here will check the file extension and then inspect all Grids found in this bundle. A child class may override any of the checkBundleDigestibility(), checkGridDigestibility() or checkGridPropertyDigestibility() functions to implement special checks. By default these functions return true, but with a lot of effort behind such as loading the file's metadata.

Example code for the default implementation:

bool    FiberNutrition::digestible(const fileid&f) const
{
        if (!checkFileExtensionDigestibility(f)) return false;
 
        return checkBundleDigestibility(f);
}

Reimplemented from Wizt::VNutrition.

References checkBundleDigestibility(), and checkFileExtensionDigestibility().

◆ estimateGridname()

string Wizt::FiberNutrition::estimateGridname ( const string & file_url )

static

Given the full path of a filename, try to estimate a meaningful grid name from it.

It may for instance get the name of the file's parent directory, assuming that all input files belonging to a certain project have been downloaded into the same parent directory.

References std::vector< typename _Tp, typename _Alloc >::size().

◆ getGridInfo()

FiberNutrition::html Wizt::FiberNutrition::getGridInfo	(	const Bundle &	B,
		const string &	Gridname ) const

virtual

Provide info per grid for the quickinfo() function.

By default it lists all attributes that are available on the first Grid found on the Bundle under this name.

◆ quickinfo()

FiberNutrition::html Wizt::FiberNutrition::quickinfo ( const FileList_t & F ) const

overridevirtual

Implement the quick info for showing properties of all the files given on the argument list.

Here, this implementation opens each file, loads a Bundle, and calls the virtual getGridInfo() function.

Reimplemented from Wizt::VNutrition.

Member Data Documentation

◆ GridnameHelptext

const char * Wizt::FiberNutrition::GridnameHelptext

static

Initial value:

                                           =
                QT_TRANSLATE_NOOP("VishNutritions",
R"(The Gridname is an identifier used in F5 files describing an geometrical entity.
The Gridname may contain any character except '/'.)"
                        )

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ analyse()

◆ checkBundleDigestibility()

◆ checkGridDigestibility()

◆ checkGridPropertyDigestibility()

◆ digestible()

◆ estimateGridname()

◆ getGridInfo()

◆ quickinfo()

Member Data Documentation

◆ GridnameHelptext