SPATMOD::IMAGE::SAMPLEITERATOR_CONST Class Reference

Iterator for accessing constant samples in memory array. More...

#include <spatmod/imagesampleiterator.h>

Inheritance diagram for SPATMOD::IMAGE::SAMPLEITERATOR_CONST:

[legend]

List of all members.

Public Member Functions
	SAMPLEITERATOR_CONST (void *pSample, DATATYPE DataType)
	SAMPLEITERATOR_CONST ()
	~SAMPLEITERATOR_CONST ()
void	Attach (void *pSample)
ERRVALUE	Attach (void *pSample, DATATYPE DataType)
bool	GetBool (int offset) const
bool	GetBool () const
double	GetDouble (int offset) const
double	GetDouble () const
void	GetDoubles (double *values, int count, int offset) const
void	GetDoubles (double *values, int count) const
INT32	GetINT32_Floor (int offset) const
INT32	GetINT32_Floor () const
const void *	GetPtr (int offset) const
const void *	GetPtr () const
int	GetSampleBytes () const
UINT32	GetUINT32_Floor (int offset) const
UINT32	GetUINT32_Floor () const
SAMPLEITERATOR_CONST &	operator++ ()
SAMPLEITERATOR_CONST &	operator+= (int num)
SAMPLEITERATOR_CONST &	operator-- ()
SAMPLEITERATOR_CONST &	operator-= (int num)

---

Detailed Description

Iterator for accessing constant samples in memory array.

---

Constructor & Destructor Documentation

SPATMOD::IMAGE::SAMPLEITERATOR_CONST::SAMPLEITERATOR_CONST

(

)

Default constructor.

SPATMOD::IMAGE::SAMPLEITERATOR_CONST::SAMPLEITERATOR_CONST	(	void *	pSample,
		DATATYPE	DataType
	)

Construct with pointer and data type.

SPATMOD::IMAGE::SAMPLEITERATOR_CONST::~SAMPLEITERATOR_CONST

(

)

Destructor.

---

Member Function Documentation

void SPATMOD::IMAGE::SAMPLEITERATOR_CONST::Attach

(

void *

pSample

)

[inline]

Attach iterator to buffer, retaining previous data type.

Buffer must remain valid as long as iterator is in use.

Parameters:

pSample

Pointer to sample buffer to attach

ERRVALUE SPATMOD::IMAGE::SAMPLEITERATOR_CONST::Attach	(	void *	pSample,
		DATATYPE	DataType
	)

Attach iterator to buffer with data type.

Buffer must remain valid as long as iterator is in use.

Parameters:

	pSample	Pointer to sample buffer to attach
	DataType	Sample data type

bool SPATMOD::IMAGE::SAMPLEITERATOR_CONST::GetBool

(

int

offset

)

const [inline]

Get value pointed to by iterator as bool with offset.

No range checking is done for offset validity.

Parameters:

offset

Position before (-) or after (+) current value.

bool SPATMOD::IMAGE::SAMPLEITERATOR_CONST::GetBool

(

)

const [inline]

Get value pointed to by iterator as bool.

double SPATMOD::IMAGE::SAMPLEITERATOR_CONST::GetDouble

(

int

offset

)

const [inline]

Get value pointed to by iterator as double with offset.

No range checking is done for offset validity.

Parameters:

offset

Position before (-) or after (+) current value.

double SPATMOD::IMAGE::SAMPLEITERATOR_CONST::GetDouble

(

)

const [inline]

Get value pointed to by iterator as double.

void SPATMOD::IMAGE::SAMPLEITERATOR_CONST::GetDoubles	(	double *	values,
		int	count,
		int	offset
	)			const [inline]

Get multiple values as double-precision, with offset.

Parameters:

	values	Array to hold result
	count	Number of samples to get
	offset	Position before (-) or after (+) current value.

void SPATMOD::IMAGE::SAMPLEITERATOR_CONST::GetDoubles	(	double *	values,
		int	count
	)			const [inline]

Get multiple values as double-precision.

Parameters:

	values	Array to hold result
	count	Number of samples to get

INT32 SPATMOD::IMAGE::SAMPLEITERATOR_CONST::GetINT32_Floor

(

int

offset

)

const [inline]

Get value pointed to by iterator as INT32 with offset, using floor for floating-point conversion.

No range checking is done for offset validity.

Parameters:

offset

Position before (-) or after (+) current value.

INT32 SPATMOD::IMAGE::SAMPLEITERATOR_CONST::GetINT32_Floor

(

)

const [inline]

Get value pointed to by iterator as INT32, using floor for floating-point conversion.

const void* SPATMOD::IMAGE::SAMPLEITERATOR_CONST::GetPtr

(

int

offset

)

const [inline]

Get pointer to sample.

Parameters:

offset

Position before (-) or after (+) current value.

Reimplemented in SPATMOD::IMAGE::SAMPLEITERATOR.

const void* SPATMOD::IMAGE::SAMPLEITERATOR_CONST::GetPtr

(

)

const [inline]

Get pointer to sample.

Reimplemented in SPATMOD::IMAGE::SAMPLEITERATOR.

int SPATMOD::IMAGE::SAMPLEITERATOR_CONST::GetSampleBytes

(

)

const [inline]

Get number of bytes in sample.

UINT32 SPATMOD::IMAGE::SAMPLEITERATOR_CONST::GetUINT32_Floor

(

int

offset

)

const [inline]

Get value pointed to by iterator as UINT32 with offset, using floor for floating-point conversion.

No range checking is done for offset validity.

Parameters:

offset

Position before (-) or after (+) current value.

UINT32 SPATMOD::IMAGE::SAMPLEITERATOR_CONST::GetUINT32_Floor

(

)

const [inline]

Get value pointed to by iterator as UINT32, using floor for floating-point conversion.

SAMPLEITERATOR_CONST& SPATMOD::IMAGE::SAMPLEITERATOR_CONST::operator++

(

)

[inline]

Pre-increment operator.

Reimplemented in SPATMOD::IMAGE::SAMPLEITERATOR.

SAMPLEITERATOR_CONST& SPATMOD::IMAGE::SAMPLEITERATOR_CONST::operator+=

(

int

num

)

[inline]

Increment by value operator.

SAMPLEITERATOR_CONST& SPATMOD::IMAGE::SAMPLEITERATOR_CONST::operator--

(

)

[inline]

Pre-decrement operator.

Reimplemented in SPATMOD::IMAGE::SAMPLEITERATOR.

SAMPLEITERATOR_CONST& SPATMOD::IMAGE::SAMPLEITERATOR_CONST::operator-=

(

int

num

)

[inline]

Decrement by value operator.

---

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

• spatmod/imagesampleiterator.h