This is an abstract interface class for a timer. More...

#include <itimer_configuration.h>

Inheritance diagram for mi::neuraylib::ITimer:

[legend]

Public Member Functions
virtual void	timer_callback ()=0
	This function is called when the timer elapses. More...

Public Member Functions inherited from mi::neuraylib::ISerializable
virtual base::Uuid	get_class_id () const =0
	Returns the class ID of the object. More...

virtual void	serialize (ISerializer *serializer) const =0
	Serializes the object to the given `serializer`. More...

virtual void	deserialize (IDeserializer *deserializer)=0
	Deserializes the object from the given `deserializer`. More...

Public Member Functions inherited from mi::base::IInterface
virtual Uint32	retain () const =0
	Increments the reference count. More...

virtual Uint32	release () const =0
	Decrements the reference count. More...

virtual const IInterface *	get_interface (const Uuid &interface_id) const =0
	Acquires a const interface from another. More...

template<class T>
const T *	get_interface () const
	Acquires a const interface from another. More...

virtual IInterface *	get_interface (const Uuid &interface_id)=0
	Acquires a mutable interface from another. More...

template<class T>
T *	get_interface ()
	Acquires a mutable interface from another. More...

virtual Uuid	get_iid () const =0
	Returns the interface ID of the most derived interface. More...

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0x654218a4, ... >
typedef Interface_declare< id1, ... >	Self
	Own type. More...

typedef Uuid_t< id1, ... >	IID
	Declares the interface ID (IID) of this interface. More...

Public Types inherited from mi::base::Interface_declare< 0x7a70f2fb, ... >
typedef Interface_declare< id1, ... >	Self
	Own type. More...

typedef Uuid_t< id1, ... >	IID
	Declares the interface ID (IID) of this interface. More...

Public Types inherited from mi::base::IInterface
typedef Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>	IID
	Declares the interface ID (IID) of this interface. More...

Static Public Member Functions inherited from mi::base::Interface_declare< 0x654218a4, ... >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID `iid` against the interface ID of this interface and of its ancestors. More...

Static Public Member Functions inherited from mi::base::Interface_declare< 0x7a70f2fb, ... >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID `iid` against the interface ID of this interface and of its ancestors. More...

Static Public Member Functions inherited from mi::base::IInterface
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID `iid` against the interface ID of this interface. More...

Detailed Description

This is an abstract interface class for a timer.

Its aim is to be derived from by the application writer. The concrete implementation can then be registered with the DiCE API and will after that be used by DiCE library.

The timer class must be serializable since a timer will potentially be sent over the cluster to different nodes. If the timer class is only ever used locally, then the serialization function can be left empty.

Note: Instances of this interface should not be created on the stack, since this might lead to premature destruction of such instances while still being in use by the DiCE library.

Member Function Documentation

^◆ timer_callback()

virtual void mi::neuraylib::ITimer::timer_callback ( )

pure virtual

This function is called when the timer elapses.

Note that the function will be called from a separate thread, not from the thread that was used to start the timer.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ timer_callback()

^◆ timer_callback()