Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

class Enlighten::InputWorkspaceDebugIterator

This class is used to iterate through the duster samples in order to get a InputWorkspaceDebugPoint.

The InputWorkspaceDebugPoint can be used for various debug visualisations.

Functions

NameDescription
AtEnd()

Returns true if current sample point is beyond the last point in the InputWorkspace.

GetDebugPoint()

Constructs the InputWorkspaceDebugPoint for the current sample point.

InputWorkspaceDebugIterator()

Default constructor sets iterator to an invalid state.

operator++()

Iterate to the next sample point in the InputWorkspace.

operator++(int)

Iterate to the next sample point in the InputWorkspace.


Anchor
a9ba34d00705c77df0de1ab49a3e120d6
a9ba34d00705c77df0de1ab49a3e120d6

bool Enlighten::InputWorkspaceDebugIterator::AtEnd

...

public: bool AtEnd() const

...

Returns true if current sample point is beyond the last point in the InputWorkspace.


Anchor
a298828d7f6264d40593350870aab73b0
a298828d7f6264d40593350870aab73b0

InputWorkspaceDebugPoint Enlighten::InputWorkspaceDebugIterator::GetDebugPoint

...

public: InputWorkspaceDebugPoint GetDebugPoint() const

...

Constructs the InputWorkspaceDebugPoint for the current sample point.


Anchor
ac0823e90e9645c70886af003ace5d5d4
ac0823e90e9645c70886af003ace5d5d4

Enlighten::InputWorkspaceDebugIterator::InputWorkspaceDebugIterator

...

public: InputWorkspaceDebugIterator()

...

Default constructor sets iterator to an invalid state.

You need to call GetInputWorkspaceDebugIterator() to set it to a valid state.


Anchor
aef67a2ba1bb571dd178f48bc96f6e3d8
aef67a2ba1bb571dd178f48bc96f6e3d8

InputWorkspaceDebugIterator& Enlighten::InputWorkspaceDebugIterator::operator++

...

public: InputWorkspaceDebugIterator & operator++()

...

Iterate to the next sample point in the InputWorkspace.


Anchor
a9329f379e26f07feac40c7038092307c
a9329f379e26f07feac40c7038092307c

InputWorkspaceDebugIterator Enlighten::InputWorkspaceDebugIterator::operator++

...

public: InputWorkspaceDebugIterator operator++
(
    int
)

...

Iterate to the next sample point in the InputWorkspace.