SPATMOD::IMAGE::SAMPLETABLE Class Reference

Image sample table. More...

#include <spatmod/imagesampletable.h>

List of all members.

Public Member Functions
	SAMPLETABLE (const SAMPLETABLE &rhs)
	SAMPLETABLE ()
	~SAMPLETABLE ()
ERRVALUE	Create (const SAMPLE &SampleProperties, UINT32 NumItems, const void *pValues=0)
void	Exchange (SAMPLETABLE &other)
UINT32	GetNumItems () const
const void *	GetPtrItem (UINT32 ItemIndex) const
void *	GetPtrItems ()
const void *	GetPtrItems () const
const SAMPLE &	GetSampleProperties () const
SAMPLETABLE &	operator= (const SAMPLETABLE &rhs)
ERRVALUE	SetAllItems (const SAMPLE &value)
ERRVALUE	SetItem (UINT32 index, double value)
ERRVALUE	SetItem (UINT32 index, const SAMPLE &value)
ERRVALUE	SetItems (UINT32 StartIndex, const void *pValues, UINT32 NumItems=1)

---

Detailed Description

Image sample table.

---

Constructor & Destructor Documentation

SPATMOD::IMAGE::SAMPLETABLE::SAMPLETABLE

(

)

Default constructor.

SPATMOD::IMAGE::SAMPLETABLE::SAMPLETABLE

(

const SAMPLETABLE &

rhs

)

Copy constructor.

SPATMOD::IMAGE::SAMPLETABLE::~SAMPLETABLE

(

)

Destructor.

---

Member Function Documentation

ERRVALUE SPATMOD::IMAGE::SAMPLETABLE::Create	(	const SAMPLE &	SampleProperties,
		UINT32	NumItems,
		const void *	pValues = 0
	)

Create sample table.

Will set all items to value specified by properties if no pValues array provided.

Parameters:

	SampleProperties	Sample properties
	NumItems	Number of table items
	pValues	Array of values, 0 to not set

void SPATMOD::IMAGE::SAMPLETABLE::Exchange

(

SAMPLETABLE &

other

)

Exchange data with another sample table.

Parameters:

other

Table to exchange with

UINT32 SPATMOD::IMAGE::SAMPLETABLE::GetNumItems

(

)

const [inline]

Get number of items in table.

const void* SPATMOD::IMAGE::SAMPLETABLE::GetPtrItem

(

UINT32

ItemIndex

)

const [inline]

Get pointer to single item.

For efficiency should not be used in pixel processing loops.

void* SPATMOD::IMAGE::SAMPLETABLE::GetPtrItems

(

)

[inline]

Get pointer to table items (non-const).

const void* SPATMOD::IMAGE::SAMPLETABLE::GetPtrItems

(

)

const [inline]

Get pointer to table items.

const SAMPLE& SPATMOD::IMAGE::SAMPLETABLE::GetSampleProperties

(

)

const [inline]

Get sample properties.

SAMPLETABLE& SPATMOD::IMAGE::SAMPLETABLE::operator=

(

const SAMPLETABLE &

rhs

)

Assignment.

ERRVALUE SPATMOD::IMAGE::SAMPLETABLE::SetAllItems

(

const SAMPLE &

value

)

Set all items to same value.

Parameters:

value

Sample value to set

ERRVALUE SPATMOD::IMAGE::SAMPLETABLE::SetItem	(	UINT32	index,
		double	value
	)

Set single table item with index and range validation.

Parameters:

	index	Index in table
	value	Value to sets

ERRVALUE SPATMOD::IMAGE::SAMPLETABLE::SetItem	(	UINT32	index,
		const SAMPLE &	value
	)

Set single table item with index and property validation.

Parameters:

	index	Index in table
	value	Sample value to set

ERRVALUE SPATMOD::IMAGE::SAMPLETABLE::SetItems	(	UINT32	StartIndex,
		const void *	pValues,
		UINT32	NumItems = 1
	)

Set table items.

Parameters:

	StartIndex	Starting index in table
	pValues	Pointer to sample values to set, must be correct type
	NumItems	Number of items to set

---

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

• spatmod/imagesampletable.h