This is the documentation for Enlighten.
class Enlighten InputWorkspaceDebugIterator
- William Joseph
- geosw (Unlicensed)
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
| Name | Description |
|---|---|
| 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. |
bool Enlighten::InputWorkspaceDebugIterator::AtEnd
public: bool AtEnd() const
Returns true if current sample point is beyond the last point in the InputWorkspace.
InputWorkspaceDebugPoint Enlighten::InputWorkspaceDebugIterator::GetDebugPoint
public: InputWorkspaceDebugPoint GetDebugPoint() const
Constructs the InputWorkspaceDebugPoint for the current sample point.
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.
InputWorkspaceDebugIterator& Enlighten::InputWorkspaceDebugIterator::operator++
public: InputWorkspaceDebugIterator & operator++()
Iterate to the next sample point in the InputWorkspace.
InputWorkspaceDebugIterator Enlighten::InputWorkspaceDebugIterator::operator++
public: InputWorkspaceDebugIterator operator++
(
  int
)
Iterate to the next sample point in the InputWorkspace.