OpenCMISS::Zinc::Spectrumiterator Class Reference

An iterator for looping through all the spectrums in a spectrum module. More...

#include <spectrum.hpp>

Public Member Functions
	Spectrumiterator (cmzn_spectrumiterator_id iterator_id)
	Spectrumiterator (const Spectrumiterator &spectrumiterator)
Spectrumiterator &	operator= (const Spectrumiterator &spectrumiterator)
bool	isValid () const
Spectrum	next ()

Detailed Description

An iterator for looping through all the spectrums in a spectrum module.

An iterator for looping through all the spectrums in a spectrum module.

Member Function Documentation

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

inline

Check if this is a valid Spectrumiterator object.

Returns

Status True if object is valid, false otherwise.

Spectrum OpenCMISS::Zinc::Spectrumiterator::next ( )

inline

Returns a handle to the next spectrum in the container being iterated over then advances the iterator position. The caller is required to destroy the returned spectrum handle.

Returns

Handle to the next spectrum, or NULL/invalid handle if none or failed.

---

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

• auto_comments_output/spectrum.hpp