OpenStructure
Public Member Functions
LineIterator Class Reference

#include <line_iterator.hh>

Public Member Functions

 LineIterator (const Extent &ext, unsigned int flag=(Axis::X|Axis::Y|Axis::Z))
 
bool AtEnd ()
 
void Inc ()
 
ExtentIterator GetLine ()
 
int GetSize () const
 
LineIteratoroperator++ ()
 
LineIterator operator++ (int)
 
ExtentIterator GetNextLine ()
 

Detailed Description

line iterator generator

generates consecutive lines over given extent

Definition at line 41 of file line_iterator.hh.

Constructor & Destructor Documentation

◆ LineIterator()

LineIterator ( const Extent ext,
unsigned int  flag = (Axis::X|Axis::Y|Axis::Z) 
)

Initialization with extent and flag.

Flag determines which axes are scanned by the iterator: (use the img::geometry::axis constants)

Member Function Documentation

◆ AtEnd()

bool AtEnd ( )

return true if iterator has reached end

◆ GetLine()

ExtentIterator GetLine ( )

retrieve current line (in form of an ExtentIterator)

◆ GetNextLine()

ExtentIterator GetNextLine ( )

convenience method, but preferred!

◆ GetSize()

int GetSize ( ) const

Retrieve Size of current line.

◆ Inc()

void Inc ( )

increase method

◆ operator++() [1/2]

LineIterator& operator++ ( )

Prefix increase operator.

◆ operator++() [2/2]

LineIterator operator++ ( int  )

Postfix increase operator.


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