OpenCMISS-Zinc C++ API Documentation
Public Member Functions | List of all members
OpenCMISS::Zinc::Fielditerator Class Reference

An iterator for looping through all the fields in a fieldmodule. More...

#include <field.hpp>

Public Member Functions

 Fielditerator (cmzn_fielditerator_id iterator_id)
 
 Fielditerator (const Fielditerator &fielditerator)
 
Fielditeratoroperator= (const Fielditerator &fielditerator)
 
bool isValid () const
 
Field next ()
 

Detailed Description

An iterator for looping through all the fields in a fieldmodule.

An iterator for looping through all the fields in a fieldmodule.

Member Function Documentation

bool OpenCMISS::Zinc::Fielditerator::isValid ( ) const
inline

Check if this is a valid Fielditerator object.

Returns
Status True if object is valid, false otherwise.
Field OpenCMISS::Zinc::Fielditerator::next ( )
inline

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

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

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