golib  0.5
Public Member Functions | Public Attributes | List of all members
goSignal3DGenericConstIterator Class Reference
Data handling for up to 3D data

Public Member Functions

 goSignal3DGenericConstIterator (const goSignal3DBase< void > *s)
 Sets the iterator position to x,y,z in the signal. More...
 
void init (const goSignal3DBase< void > *s)
 
 goSignal3DGenericConstIterator (const goSignal3DGenericConstIterator &other)
 
void setPosition (goIndex_t x, goIndex_t y, goIndex_t z)
 Sets the iterator position to x,y,z in the signal. More...
 
bool endX ()
 
bool endY ()
 
bool endZ ()
 
void incrementX ()
 
void incrementY ()
 
void incrementZ ()
 
void decrementX ()
 
void decrementY ()
 
void decrementZ ()
 
void resetX ()
 Resets the X pointer and internals concerning X to the beginning of the current x-line.
 
void resetY ()
 Resets the Y pointer and internals concerning Y to the beginning of the current z-plane.
 
void resetZ ()
 Sets the iterator position to x,y,z in the signal. More...
 
const goByte * leftX () const
 
const goByte * leftY () const
 
const goByte * leftZ () const
 
const goByte * rightX () const
 
const goByte * rightY () const
 
const goByte * rightZ () const
 
const goByte * leftUp () const
 
const goByte * leftDown () const
 
const goByte * rightUp () const
 
const goByte * rightDown () const
 
const goByte * operator* () const
 

Public Attributes

const goSignal3DBase< void > * sig
 
const goPtrdiff_t * dx
 
const goPtrdiff_t * dy
 
const goPtrdiff_t * dz
 
const goPtrdiff_t * dxStart
 
const goPtrdiff_t * dyStart
 
const goPtrdiff_t * dzStart
 
const goByte * px
 
const goByte * py
 
const goByte * pz
 
goIndex_t posX
 
goIndex_t posY
 
goIndex_t posZ
 
goIndex_t maxX
 
goIndex_t maxY
 
goIndex_t maxZ
 

Constructor & Destructor Documentation

◆ goSignal3DGenericConstIterator()

goSignal3DGenericConstIterator::goSignal3DGenericConstIterator ( const goSignal3DBase< void > *  s)
inline

Sets the iterator position to x,y,z in the signal.

Parameters
xX position
yY position
zZ position

Member Function Documentation

◆ endX()

bool goSignal3DGenericConstIterator::endX ( )
inline
Returns
True if the end of the current x-line is reached, false otherwise.

◆ endY()

bool goSignal3DGenericConstIterator::endY ( )
inline
Returns
True if the end of the current y-plane is reached, false otherwise.

◆ endZ()

bool goSignal3DGenericConstIterator::endZ ( )
inline
Returns
True if the end of the current z-plane is reached (end of the 3D signal), false otherwise.

◆ leftX()

const goByte* goSignal3DGenericConstIterator::leftX ( ) const
inline
Returns
Pointer to the data element at the current iterator position.

◆ resetZ()

void goSignal3DGenericConstIterator::resetZ ( )
inline

Sets the iterator position to x,y,z in the signal.

Parameters
xX position
yY position
zZ position

Resets the Z pointer and internals concerning Z to initial values.

Calls resetY() and resetX().

◆ setPosition()

void goSignal3DGenericConstIterator::setPosition ( goIndex_t  x,
goIndex_t  y,
goIndex_t  z 
)
inline

Sets the iterator position to x,y,z in the signal.

Parameters
xX position
yY position
zZ position
The documentation for this class was generated from the following files: