SCENE C++ API  2.0.22
Public Member Functions | List of all members
LSScanIterator< ValueT > Class Template Reference

A specialized iterator which may be run on organized scans and additionally provides access to the row and column of the current scan point. More...

#include <lsscaniterator.h>

+ Inheritance diagram for LSScanIterator< ValueT >:

Public Member Functions

 LSScanIterator ()
 Constructs a null iterator. More...
 
 LSScanIterator (const LSScanIterator< ValueT > &iter)
 Constructs a copy of the iterator iter. More...
 
LSScanIteratoroperator= (const LSScanIterator< ValueT > &iter)
 Assigns a copy of the iterator iter to this iterator. More...
 
int getCurrentCol () const
 Gets the column of the scan point at which the iterator currently points. More...
 
int getCurrentRow () const
 Gets the row of the scan point at which the iterator currently points. More...
 
void * operator new (size_t tSize)
 Default allocation function. More...
 
void operator delete (void *p)
 Default deallocation function. More...
 
- Public Member Functions inherited from LSIterator< ValueT >
 LSIterator ()
 Constructs a null iterator. More...
 
 LSIterator (const LSIterator< ValueT > &iter)
 Constructs a copy of the iterator iter. More...
 
LSIteratoroperator= (const LSIterator< ValueT > &iter)
 Assigns a copy of the iterator iter to this iterator. More...
 
bool moveNext ()
 Advances the iterator to the next element of the container. More...
 
ValueT getCurrent () const
 Gets the element at which the iterator currently points. More...
 
void getCurrent (ValueT &out) const
 Gets the element at which the iterator currently points. More...
 
LSIterator< ValueT > where (bool(*func)(const ValueT &)) const
 Filters the elements returned by the iterator based on a given filter function. More...
 
void * operator new (size_t tSize)
 Default allocation function. More...
 
void operator delete (void *p)
 Default deallocation function. More...
 

Detailed Description

template<typename ValueT>
class SCENE_API::LSScanIterator< ValueT >

A specialized iterator which may be run on organized scans and additionally provides access to the row and column of the current scan point.

Version
SCENE API Version 2.0.0.

Constructor & Destructor Documentation

◆ LSScanIterator() [1/2]

Constructs a null iterator.

Version
SCENE API Version 2.0.0.

◆ LSScanIterator() [2/2]

LSScanIterator ( const LSScanIterator< ValueT > &  iter)

Constructs a copy of the iterator iter.

Parameters
iterThe iterator from which to create a copy.
Version
SCENE API Version 2.0.0.

Member Function Documentation

◆ operator=()

LSScanIterator& operator= ( const LSScanIterator< ValueT > &  iter)

Assigns a copy of the iterator iter to this iterator.

Parameters
iterThe iterator which is assigned to this iterator.
Version
SCENE API Version 2.0.0.

◆ getCurrentCol()

int getCurrentCol ( ) const

Gets the column of the scan point at which the iterator currently points.

Version
SCENE API Version 2.0.0.

◆ getCurrentRow()

int getCurrentRow ( ) const

Gets the row of the scan point at which the iterator currently points.

Version
SCENE API Version 2.0.0.

◆ operator new()

void* operator new ( size_t  tSize)

Default allocation function.

Overloaded in order to always allocate LSString objects in the context of this module.

Version
SCENE API Version 2.0.0.

◆ operator delete()

void operator delete ( void *  p)

Default deallocation function.

Overloaded in order to always deallocate LSString objects in the context of this module.

Version
SCENE API Version 2.0.0.