An input slot for VObjects, bound to a specific type. More...

#include </home/werner/origo/vish/ocean/plankton/VSlot.hpp>

Classes

class SlotCreator
The associated Slot Creator. More...

Public Types

typedef std::pair< const
TypedSlot, const RefPtr
< ValuePool > > SlotContext
A typed Slot context.
typedef T value_type
The type on which this slot operates.

Public Member Functions

void activate () const
Activate this slot.
const Ageable & age (const RefPtr< ValuePool > &VP) const
SlotContext createContext (const RefPtr< ValuePool > &VP) const
void deactivate () const
Deactivate this slot.
RefPtr< VValueBase > getProperty (const string &s) const
Get a certain property of the parameter associated with this slot.
template<class Type > bool getProperty (const string &s, Type &value) const
Retrieve the value of a certain property of the parameter associated with this slot, if it is compatible to the specified type.
WeakVObjectPtr getSlotOwner () const
Return the associated slot owning object, which is the one where this slot resides.
RefPtr< VManagedObject > getSource () const
Return the associated source object, which is related to the referenced parameter.
RefPtr< VValueBase > getValue (const RefPtr< ValuePool > &VP) const
Retrieve the untyped value of this slots.
bool isActive () const
Check whether this slot is active.
bool isInactive () const
Check whether this slot is inactive.
bool isLocal () const
Check whether this slot refers to a local setting.
RefPtr< VValue< T > > operator() (const RefPtr< ValuePool > &VP) const
Retrieve the typed value of this slots.
SlotContext operator<< (const RefPtr< ValuePool > &VP) const
TypedSlot & operator= (const TypedSlot &TS)
Assignment constructor.
void setActive (bool IsActive=true) const
Set activity flag.
void setHelptext (const string &helptext) const
Set a help text for user information about this slot.
template<class Type > bool setProperty (const string &name, const Type &value) const
Set a property of the parameter that is associated with this slot.
void setRelevance (int rel) const
Set the relevance of the associated parameter This should only be done if the parameter is exclusively used here, not once it has been shared.
TypedSlot ()
Default constructor to create empty slot references that are filled in at a later time.
TypedSlot (const TypedSlot &TS)
Copy constructor.
TypedSlot (VObject *that, const string &name, const T &initialValue, int expertLevel=0)
Constructing a typed slot.
TypedSlot (const WeakVObjectPtr &that, const string &name, const T &initialValue, int expertLevel=0)
Constructing a typed slot.
TypedSlot (VObject *that, const string &name, const RefPtr< VCreationPreferences > &VP, int prior)
Construct a typed slot with Creation Preferences, but no initialization of the value.
TypedSlot (VObject *that, const string &name, 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 &name, int prior=0)
Creates a typed slot with no parameter attached yet.
TypedSlot (VObject *that, const string &name, const T &initialValue, const RefPtr< VCreationPreferences > &VP, int ExpertLevel=0, bool overwriteExistingSlot=true)
Creation of a typed slot, constructor with creation preferences.
TypedSlot (const WeakVObjectPtr &that, const string &name, const T &initialValue, const RefPtr< VCreationPreferences > &VP, int ExpertLevel=0, bool overwriteExistingSlot=true)
Creation of a typed slot, constructor with creation preferences.
~TypedSlot ()
Destructor.

Static Public Member Functions

static TypedSlot type_cast (const RefPtr< VSlot > &VP)
Cast an untyped Slot to a typed one, which, of course, will only succeed if the types are compatible.

Static Public Attributes

static RefPtr< SlotCreator > & theCreator = TypedSlot<T>::SlotCreator::getCreator()

Friends

const ValueSetPair & operator+= (const ValueSetPair &VSP, const TypedSlot &VS)
const ValueSetPair & operator, (const ValueSetPair &VSP, const TypedSlot &VS)
bool operator<< (const SlotContext &SC, const T &Variable)
Assign a parameter's value within slot context, returns true or false, if this was possible or not.
bool operator<<= (const SlotContext &SC, const T &Variable)
Assign a parameter's value within slot context IF it has changed.
bool operator>> (const SlotContext &SC, T &Variable)
Assign a variable from a slot context, returns true or false, if this was possible or not.

Related Functions

(Note that these are not member functions.)

template<class T > bool adjustRange (TypedSlot< T >theSlot, const T &minval, const T &maxval)
Set the minimum/maximum parameters of a slot.

Detailed Description

An input slot for VObjects, bound to a specific type.

An input slot is a reference to a VParameter, that is contained within an VObject. The typical usage is

class MyObject : public VObject
{
        TypedSlot<int>  MyInteger;

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

Basically a TypedSlot is a convenience class wrapper for using VObject::Slot, which is for untyped slots.

Examples:: MonochromeBackground.cpp.

Constructor & Destructor Documentation

Wizt::TypedSlot::TypedSlot	(	VObject *	that,
		const string &	name,
		const T &	initialValue,
		int	expertLevel = `0`
	)		`[inline]`

Constructing a typed slot.

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.

Wizt::TypedSlot::TypedSlot	(	const WeakVObjectPtr &	that,
		const string &	name,
		const T &	initialValue,
		int	expertLevel = `0`
	)		`[inline]`

Constructing a typed slot.

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.

Wizt::TypedSlot::TypedSlot	(	VObject *	that,
		const string &	name,
		const RefPtr< VCreationPreferences > &	VP,
		int	prior
	)		`[inline]`

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

Uses non-standard constructor for VValueParameter<T>, thus this constructor is only available for types where a specialization of VValueParameter<T>(string, RefPtr<VCreationPrefences>) exists.

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

Wizt::TypedSlot::TypedSlot	(	VObject *	that,
		const string &	name,
		const VSlot::Empty &	,
		int	prior = `0`
	)		`[inline]`

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.

Uses non-standard constructor for VValueParameter<T>, thus this constructor is only available for types where a specialization of VValueParameter<T>() exists.

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

Wizt::TypedSlot::TypedSlot	(	VObject *	that,
		const string &	name,
		const T &	initialValue,
		const RefPtr< VCreationPreferences > &	VP,
		int	ExpertLevel = `0`,
		bool	overwriteExistingSlot = `true`
	)		`[inline]`

Creation of a typed slot, constructor with creation preferences.

Parameters:

that	The object to which this parameter will be attached.
name	The name under which this parameter will be accessed from within this object. It will be modified via VObject::CreateParameterName().
initialValue	The initial value of this slot's parameter.

Wizt::TypedSlot::TypedSlot	(	const WeakVObjectPtr &	that,
		const string &	name,
		const T &	initialValue,
		const RefPtr< VCreationPreferences > &	VP,
		int	ExpertLevel = `0`,
		bool	overwriteExistingSlot = `true`
	)		`[inline]`

Creation of a typed slot, constructor with creation preferences.

Parameters:

that	The object to which this parameter will be attached.
name	The name under which this parameter will be accessed from within this object. It will be modified via VObject::CreateParameterName().
initialValue	The initial value of this slot's parameter.

Wizt::TypedSlot::~TypedSlot ( ) [inline]

Destructor.

It contains meaningless code to access the static SlotCreator instance such that SlotCreators are instantiated and added to the SlotCreator registry. This meaningless code is a simple pointer assignment and will slow down the destructor by about one or two CPU cycles.

Member Function Documentation

template<class Type >

bool Wizt::TypedSlot::getProperty	(	const string &	s,
		Type &	value
	)		const `[inline]`

Retrieve the value of a certain property of the parameter associated with this slot, if it is compatible to the specified type.

Returns:: false If there type is incompatible, or there is no such property at all.

Friends And Related Function Documentation

const ValueSetPair& operator+=	(	const ValueSetPair &	VSP,
		const TypedSlot &	VS
	)		`[friend]`

           RefPtr<ValueSet> Changeables = new ValueSet(); 
           Changeables & R += nLines, X, Y, Z, Length, DistributionWidth;

const ValueSetPair& operator,	(	const ValueSetPair &	VSP,
		const TypedSlot &	VS
	)		`[friend]`

           RefPtr<ValueSet> Changeables = new ValueSet(); 
           Changeables & R += nLines, X, Y, Z, Length, DistributionWidth;

bool operator<<=	(	const SlotContext &	SC,
		const T &	Variable
	)		`[friend]`

Assign a parameter's value within slot context IF it has changed.

This requires the existence of a comparision operator for type T. It will read the previous value of the slot into a temporary variable for comparison.

Returns:: true if the value has been changed.

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

ocean/plankton/VSlot.hpp
ocean/plankton/VParamProperty.hpp