Public Types

typedef Wizt::TypedSlot< T > Base_t

Public Member Functions

Input ()
Default constructor to create empty slot references that are filled in at a later time.
Input (const Input &I)
Copy constructor.
Input (VObject *that, const string &s, const T &initialValue, int EL=0)
Constructing an input.
Input & operator= (const Input &TS)
Assignment constructor.
TypedSlot (VObject *that, const string &s, const RefPtr< VCreationPreferences > &VP, int prior)
Construct a typed slot with Creation Preferences, but no initialization of the value.
TypedSlot (VObject *that, const string &s, const VSlot::Empty &, int prior=0)
Special constructor that does not initialize the value of this input slot.
TypedSlot (VObject *that, const VSlot::Empty &, const string &s, int prior=0)
Creates a typed slot with no parameter attached yet.
TypedSlot (VObject *that, const string &s, const T &initialValue, const RefPtr< VCreationPreferences > &VP, int prior=0)
Declaration of constructor with creation preferences.

Detailed Description

An input slot for Vish Objects, bound to a specific type.

The typical usage is

class MyObject : public Vish::Object
{
        Vish::Input<int>        MyInteger;

        MyObject()
        : MyInteger(this, "myvalue", 42)
        {}
};

Constructor & Destructor Documentation

Vish::Input::Input	(	VObject *	that,
		const string &	s,
		const T &	initialValue,
		int	EL = `0`
	)		`[inline]`

Constructing an input.

Parameters:

that	The VObject to which this slot is bound.
EL	the Expert level of this slot, which might be used for a GUI.
initialValue	The intial value of this slot's parameter.

Member Function Documentation

Vish::Input::TypedSlot	(	VObject *	that,
		const string &	s,
		const RefPtr< VCreationPreferences > &	VP,
		int	prior
	)

Construct a typed slot with Creation Preferences, but no initialization of the value.

Note:: Requires template VValueParameter<T>::VValueParameter(string, const RefPtr<VCreationPreferences>&) to be specialized!!

Vish::Input::TypedSlot	(	VObject *	that,
		const string &	s,
		const VSlot::Empty &	,
		int	prior = `0`
	)

Special constructor that does not initialize the value of this input slot.

Rarely to be used, only for specific cases where initialization of a slot's type is non-trivial.

Note:: Requires template VValueParameter<T>::VValueParameter() to be specialized!!

Vish::Input::TypedSlot	(	VObject *	that,
		const string &	s,
		const T &	initialValue,
		const RefPtr< VCreationPreferences > &	VP,
		int	prior = `0`
	)

Declaration of constructor with creation preferences.

Note:: This constructor is defined in VObject.hpp

Parameters:

initialValue The intial value of this slot's parameter.

The documentation for this class was generated from the following file:

ocean/plankton/Vish.hpp