The Vish Visualization Shell 0.3
Vish
Public Member Functions | List of all members
Wizt::CallbackMutableInputNotifier< SlotType, VObjectClass, VObjectClassPtr > Struct Template Reference

A value notification class that awaits value changes for a specific type and forwards the event to the member function of a given object. More...

#include <ocean/plankton/VInputNotifier.hpp>

Inheritance diagram for Wizt::CallbackMutableInputNotifier< SlotType, VObjectClass, VObjectClassPtr >:
Wizt::ValueNotifier MemCore::ReferenceBase< ValueNotifier > MemCore::Intercube

Public Member Functions

bool setValue (const SlotType &theValue, const ValuePoolPtr &Context) const
 Set a value, avoiding self-notification.
 
void valueChanged (const RefPtr< VValueBase > &value, const ValuePoolPtr &Context, 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< InterfaceBasecreateInterface (const type_info &) const
 Virtual function which allows derived objects to create Interface objects on demand.
 
RefPtr< InterfaceBasefindInterface (const type_info &t) const
 Find a certain interface of specified type.
 
RefPtr< InterfaceBasegetInterface (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.
 

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.
 
- Protected Member Functions inherited from MemCore::ReferenceBase< ValueNotifier >
virtual void extremeUnction ()
 A virtual function that will be called just before the object is destroyed.
 
ReferenceBaseoperator= (const ReferenceBase &R)
 Protected assignment operator (should not be called).
 
void suicide ()
 Delete this.
 
virtual ~ReferenceBase ()
 Virtual destructor.
 

Detailed Description

template<class SlotType, class VObjectClass, class VObjectClassPtr>
struct Wizt::CallbackMutableInputNotifier< SlotType, VObjectClass, VObjectClassPtr >

A value notification class that awaits value changes for a specific type and forwards the event to the member function of a given object.

Member Function Documentation

◆ valueChanged()

template<class SlotType , class VObjectClass , class VObjectClassPtr >
void Wizt::CallbackMutableInputNotifier< SlotType, VObjectClass, VObjectClassPtr >::valueChanged ( const RefPtr< VValueBase > &  value,
const ValuePoolPtr ,
const ValueNotifierList DoNotBroadcast,
const ValueMap VP = 0 
)
inlineoverridevirtual

Virtual callback function that is invoked when the referred value is modified.

Parameters
valueThe new value.
DoNotBroadcastDo not broadcast notification events to this list, but still allow to retrieve the event.

This function is called whenever an instance of a common parameter has been changed. Implementations of this function are supposed to set local variables according to the given value, and to touch() itself in case the new value has changed something significantly.

Implements Wizt::ValueNotifier.