Manages individual user notification of changes with a spectrum module. More...

#include <spectrum.hpp>

Public Member Functions
	Spectrummodulenotifier (cmzn_spectrummodulenotifier_id in_spectrummodulenotifier_id)

	Spectrummodulenotifier (const Spectrummodulenotifier &spectrummoduleNotifier)

Spectrummodulenotifier &	operator= (const Spectrummodulenotifier &spectrummoduleNotifier)

bool	isValid () const

cmzn_spectrummodulenotifier_id	getId () const

int	setCallback (Spectrummodulecallback &callback)

int	clearCallback ()

Protected Attributes
cmzn_spectrummodulenotifier_id	id

Detailed Description

Manages individual user notification of changes with a spectrum module.

Member Function Documentation

int OpenCMISS::Zinc::Spectrummodulenotifier::clearCallback ( )

inline

Stop and clear spectrum module callback. This will stop the callback and also remove the callback function from the spectrummodule notifier.

cmzn_spectrummodulenotifier_id OpenCMISS::Zinc::Spectrummodulenotifier::getId ( ) const

inline

Return the C handle of the Spectrummodulenotifier object.

Returns: C handle of Spectrummodulenotifier if this objects is valid, 0 otherwise.

bool OpenCMISS::Zinc::Spectrummodulenotifier::isValid ( ) const

inline

Check if this is a valid Spectrummodulenotifier object.

int OpenCMISS::Zinc::Spectrummodulenotifier::setCallback ( Spectrummodulecallback & callback )

inline

Assign the callback function and user data for the spectrummodule notifier. This function also starts the callback.

Parameters

callback	function to be called when event is triggered.
user_data_in	Void pointer to user object. User must ensure this object's lifetime exceeds the duration for which callbacks are active.

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