Wizt::Fish< Fiber::Field > Struct Reference

The fish scale to access the fields of a grid object in a fiber bundle. More...

#include <FishField.hpp>

Inheritance diagram for Wizt::Fish< Fiber::Field >:

Public Types
enum	{ NumberOfInputFields = 1 }

Public Member Functions
	Fish (const string &field, int ExpertLevel=0)
	Constructor, specify slot name for this field.
template<class ... T>
bool	acceptType ()
	Tell this field to accept certain types.
void	setFieldExpertLevel (int EL)
	Set the expert level of this slot.
	~Fish ()
	Destructor, cleaning up.
void	registerFieldAsOutput ()
	Make field visible as output.
string	Fieldname (const RefPtr< ValuePool > &VP) const
	Get the name of the selected field.
string	getFieldname (const RefPtr< ValuePool > &VP) const
	Get the name of the selected field.
RefPtr< Fiber::Field >	getField (const RefPtr< ValuePool > &VP) const
	Get a vertex field from the root level from the current selection.
RefPtr< Fiber::Field >	getField (const RefPtr< ValuePool > &VP, const string &theFieldName) const
	Get another field from the same Grid.
RefPtr< Fiber::Field >	getFieldRepresentation (const RefPtr< Fiber::Representation > &LevelRep, const RefPtr< ValuePool > &VP, const RefPtr< Fiber::Skeleton > &DestVertices, Fiber::Grid &SourceGrid, Fiber::Slice &DestGridSlice, const string &HelperDestGridName, bool StoreResult=true)
	Get Field from a possibly different Grid.
RefPtr< Fiber::Field >	getCoordinates (const RefPtr< ValuePool > &VP) const
	Get the coordinates on this Grid.
FieldSelector	getFieldSelector (const RefPtr< ValuePool > &VP) const
double	getTime (const RefPtr< ValuePool > &VP, const RefPtr< Fiber::Bundle > &SpaceTime) const override
	Get the time from the current field selector.
TypedSlot< VTime >	getTimeSlot () const
	Return the associated time slot from the source object.
RefPtr< VManagedObject >	getSource () const
	Get the source object of this field slot, can be used to check if the field is connected to a source at all.
bool	IterateLevels (LevelIterator &LI, const RefPtr< ValuePool > &Context, const Fiber::BundlePtr &SpaceTime=Fiber::BundlePtr(NullPtr())) const
	Get a field from an arbitrary representation from the current selection.

Protected Attributes
TypedSlot< Fiber::Field >	MyField

Detailed Description

The fish scale to access the fields of a grid object in a fiber bundle.

Fields that are selectable here are constrained to certain types. To define the specific types, use a syntax like this in your code, like in a derived class:

void addTypes()
{
AcceptType<float> a( AcceptableFieldTypes );
AcceptType<double>b( AcceptableFieldTypes );
}

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
NumberOfInputFields	How many fields must the connected object provide? Per default, one at least. Child classes may define another enum.

Member Function Documentation

acceptType()

template<class ... T>

bool Wizt::Fish< Fiber::Field >::acceptType ( )

inline

Tell this field to accept certain types.

Get global value of this slot (local field selection irrelevant)

getField()

RefPtr< Fiber::Field > Wizt::Fish< Fiber::Field >::getField	(	const RefPtr< ValuePool > &	VP,
		const string &	theFieldName
	)		const

Get another field from the same Grid.

Parameters

theFieldName

Name of this other field.

getTimeSlot()

TypedSlot< VTime > Wizt::Fish< Fiber::Field >::getTimeSlot ( ) const

inline

Return the associated time slot from the source object.

This is usually not required, but might be useful to inspect properties of the time object, such as a min/max range or the increments.

Application code might look like this:

double  Tmin = 0.0, Tmax = 1.0, Tinc = 0.1;
        if (TypedSlot<VTime> MyTime = getTimeSlot() )
     {
        MyTime->getProperty( VPROPERTY_VTIME_MIN, Tmin);
        MyTime->getProperty( VPROPERTY_VTIME_MAX, Tmax);
        MyTime->getProperty( VPROPERTY_VTIME_INCREMENT, Tinc);
     }

IterateLevels()

bool Wizt::Fish< Fiber::Field >::IterateLevels	(	LevelIterator &	LI,
		const RefPtr< ValuePool > &	Context,
		const Fiber::BundlePtr &	SpaceTime = Fiber::BundlePtr( NullPtr() )
	)		const

Get a field from an arbitrary representation from the current selection.

A representation may for instance be retrieved from the Fish<Skeleton> class:

   RefPtr<Grid> G = ...;
   RefPtr<Representation> LevelRep = getLevel( *G, R);
   @code
  /
RefPtr<Fiber::Field>  getField(const RefPtr<Fiber::Representation>&LevelRep,
                               const RefPtr<ValuePool>&VP) const;
 
 
Fiber::Info<Fiber::Skeleton>
        getRefinementLevel(int Level,
                           const RefPtr<ValuePool>&VP,
                           int IndexDepth = 0,
                           const Fiber::BundlePtr&SpaceTime = Fiber::BundlePtr(NullPtr() ) )
        const override ;
 
 
Fiber::Bundle::GridInfo_t
        findMostRecentGrid(FieldSelector&GS, const RefPtr<ValuePool>&VP, const Fiber::BundlePtr&SpaceTime = Fiber::BundlePtr(NullPtr() )) const;