Information about changes to spectrums in the spectrum module. More...

#include <spectrum.hpp>

Public Member Functions
	Spectrummoduleevent (cmzn_spectrummoduleevent_id in_spectrummodule_event_id)

	Spectrummoduleevent (const Spectrummoduleevent &spectrummoduleEvent)

Spectrummoduleevent &	operator= (const Spectrummoduleevent &spectrummoduleEvent)

bool	isValid () const

cmzn_spectrummoduleevent_id	getId () const

Spectrum::ChangeFlags	getSpectrumChangeFlags (const Spectrum &spectrum) const

Spectrum::ChangeFlags	getSummarySpectrumChangeFlags () const

Protected Attributes
cmzn_spectrummoduleevent_id	id

Detailed Description

Information about changes to spectrums in the spectrum module.

Information about changes to spectrums in the spectrum module, sent with each callback from the spectrummodule notifier.

Member Function Documentation

cmzn_spectrummoduleevent_id OpenCMISS::Zinc::Spectrummoduleevent::getId ( ) const

inline

Return the C handle of the Spectrummoduleevent object.

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

Spectrum::ChangeFlags OpenCMISS::Zinc::Spectrummoduleevent::getSpectrumChangeFlags ( const Spectrum & spectrum ) const

inline

Get logical OR of flags indicating how the spectrum has changed.

Parameters

spectrum The spectrum to query about.

Returns: The change flags summarising the change: logical OR of enum Spectrum::ChangeFlag values. Returns CMZN_SPECTRUM_CHANGE_FLAG_NONE in case of invalid arguments.

Spectrum::ChangeFlags OpenCMISS::Zinc::Spectrummoduleevent::getSummarySpectrumChangeFlags ( ) const

inline

Get logical OR of flags indicating how spectrums in the spectrum module have changed.

Returns: The change flags summarising the change: logical OR of enum Spectrum::ChangeFlag values.

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

inline

Check if this is a valid Spectrummoduleevent object.

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