Wizt::ValueAction< ActionReceiver > Struct Template Reference

Route a notification event to an object's member function. More...

#include <ocean/plankton/ValueAction.hpp>

Inheritance diagram for Wizt::ValueAction< ActionReceiver >:

Public Attributes
bool(ActionReceiver::*	myAction )(const RefPtr< VValueBase > &)
	Pointer to a member function of the respective object.
WeakPtr< ActionReceiver >	myActionReceiver
	Reference to the actual object that will receive the action.

Additional Inherited Members
Public Types inherited from MemCore::ReferenceBase< ValueNotifier >
using	reference_domain_t = ValueNotifier
	The type of the base class.
using	SelfPtr_t = WeakPtr< ValueNotifier, ValueNotifier >
	Type for a pointer to this object itself.
Public Member Functions inherited from Wizt::ValueActionBase
void	valueChanged (const RefPtr< VValueBase > &value, const ValuePoolPtr &, const ValueNotifierList *DoNotBroadcast, const ValueMap *VP=0) override
	Virtual callback function that is invoked when the referred value is modified.
Public Member Functions inherited from Wizt::ValueNotifier
	ValueNotifier ()
	Constructor.
	~ValueNotifier ()
	Destructor.
Public Member Functions inherited from MemCore::ReferenceBase< ValueNotifier >
auto	getObjectCountID () const noexcept
	Get a unique ID for this object in the given domain.
bool	isIdentical (const WeakPtr< ValueNotifier, ValueNotifier > &PossibleSelf) const noexcept
	Check if this object is identical to the one used by the given pointer.
void	mkAutoDestructive ()
	Marks this object as being automatically destructed, e.g.
refcount_t	refcount () const noexcept
	The strong reference count.
	ReferenceBase (ValueNotifier *that) noexcept
	Constructor, initializes reference counter to zero.
const auto &	self () const
	Return weak pointer to the object self.
refcount_t	wrefcount () const noexcept
	The weak reference count.
Public Member Functions inherited from MemCore::Intercube
void	addInterface (const RefPtr< InterfaceBase > &I) const
	Add an interface class object.
template<class Data >
void	addInterfaceData (const Data &D)
	Add data via an interface class object.
template<class Data , typename TypeSelector >
void	addInterfaceData (const Data &D)
	Add data via an interface class object.
void	clearInterfaces ()
	Remove all interfaces.
bool	const_iterateInterfaces (const RefPtr< InterfaceIterationParameter > &IIP) const
	Constant iterator.
virtual RefPtr< InterfaceBase >	createInterface (const type_info &) const
	Virtual function which allows derived objects to create Interface objects on demand.
RefPtr< InterfaceBase >	findInterface (const type_info &t) const
	Find a certain interface of specified type.
RefPtr< InterfaceBase >	getInterface (const type_info &t)
	Retrieve an interface object from a certain type.
std::string	getInterfaceNames (const char delim=';') const
	Debug function retrieving all interfaces as human-readable string.
template<class Data >
bool	gotNewInterfaceData (const Data &D)
	Check whether data on the given interface have changed, and if so, set new data as interface.
template<class Data >
bool	gotNewInterfaceData (mutex &M, const Data &D)
	Check whether interface data have changed, if so, then set new interface data and return true.
template<class Data , typename Selector >
bool	gotNewInterfaceData (mutex &M, const Data &D)
	Check whether interface data have changed, if so, then set new interface data and return true.
template<class Data , typename Selector >
bool	gotNewInterfaceData (mutex &M, const Data &D, const Selector &S)
	Check whether interface data have changed, if so, then set new interface data and return true.
template<class Data , typename Selector >
bool	gotNewInterfaceData (mutex &M, const Data &D, const Selector *S)
	Check whether interface data have changed, if so, then set new interface data and return true.
template<class Data >
bool	hasChangedInterfaceData (const Data &D) const
	Check whether interface data have changed.
template<class Data , typename Selector >
bool	hasChangedInterfaceData (const Data &D) const
	Check whether interface data have changed.
template<class Data , typename Selector >
bool	hasChangedInterfaceData (const Data &D, const Selector &) const
	Check whether interface data have changed.
template<class Data , typename Selector >
bool	hasChangedInterfaceData (const Data &D, const Selector *) const
	Check whether interface data have changed.
bool	hasInterface (const type_info &t) const
	Check if some Interface might exist.
	Intercube ()
	Constructor.
bool	iterateInterfaces (const RefPtr< InterfaceIterationParameter > &IIP)
	Modifyable iterator.
void	printInterfaces () const
	Debug function that prints the names of all interfaces.
void	registerInterface (const type_info &t)
	Register an interface type; when the interface is actually required, the virtual createInterface() function will be called.
template<class InterfaceType >
void	removeInterface ()
	Remove an interface.
void	removeInterfaceBase (const type_info &InterfaceBaseID)
	Remove an interface.
virtual	~Intercube ()
	Destructor.
Protected Member Functions inherited from MemCore::ReferenceBase< ValueNotifier >
virtual void	extremeUnction ()
	A virtual function that will be called just before the object is destroyed.
ReferenceBase &	operator= (const ReferenceBase &R)
	Protected assignment operator (should not be called).
void	suicide ()
	Delete this.
virtual	~ReferenceBase ()
	Virtual destructor.

Detailed Description

template<class ActionReceiver>
struct Wizt::ValueAction< ActionReceiver >

Route a notification event to an object's member function.

This is actually one of the coolest classes in VISH. It allows to register an arbitrary object's member function (well, the object must be reference-countable) to be invoked when a certain parameter value is changed. The application code will look like this:

class MyObject : public VObject
{
     bool myAction(const RefPtr<VValueBase>&value)
     {
        return false;
     }
 
public:
     MyObject(...)
     : VObject(...)
     {
        addParam(20, "sensitivity");
 
        AddParameterAction( "sensitivity",  new ValueAction<MyObject>( self(), &MyObject::myAction ) );
     }
};