SampleList.SampleCollection< TData > Class Template Reference

Collection of data samples. SampleImageList. More...

Inherited by SampleImageList.ImageCollection.

Public Member Functions
TData	Remove (int index)
	Remove a sample.

Protected Member Functions
TData	GetData (IntPtr dataHandle)
	Retrieve the data behind a TSILDATA handle.
Image	GetImage (IntPtr dataHandle)
	Retrieve the image behind a TSILDATA handle.
unsafe float[]	GetFloatVector (IntPtr dataHandle)
	Retrieve the float vector behind a TSILDATA handle.

Properties
int	Count [get]
	Get the number of samples for this collection.
TData	this[int index] [get]
	Access one of the sample images.

Detailed Description

Collection of data samples. SampleImageList.

Template Parameters

TData

Type of data stored in the samples.

Member Function Documentation

GetData()

TData GetData ( IntPtr dataHandle )

abstractprotected

Retrieve the data behind a TSILDATA handle.

Parameters

dataHandle

Native handle of the data object.

Returns

The data object referred to.

GetFloatVector()

unsafe float[] GetFloatVector ( IntPtr dataHandle )

protected

Retrieve the float vector behind a TSILDATA handle.

Parameters

dataHandle

The native data handle.

Returns

The vector data associated with the dataHandle .

GetImage()

Image GetImage ( IntPtr dataHandle )

protected

Retrieve the image behind a TSILDATA handle.

Parameters

dataHandle

Native handle of the data object.

Returns

The image associated with the dataHandle .

Remove()

TData Remove

(

int

index

)

Remove a sample.

Parameters

index

index of the sample to be removed

Exceptions

ArgumentOutOfRangeException	If the index is invalid
ObjectDisposedException	If the parent list has already been disposed.

Returns

The removed data object.

Exceptions

ObjectDisposedException	If the parent SampleImageList has already been disposed.
ArgumentOutOfRangeException	if the index is outside the range [0...Count-1].

Property Documentation

Count

int Count

get

Get the number of samples for this collection.

Exceptions

ObjectDisposedException

If the parent list has already been disposed.

this[int index]

TData this[int index]

get

Access one of the sample images.

Parameters

index

index to be accessed

Returns

image

Exceptions

ObjectDisposedException	If the parent list has already been disposed.
ArgumentOutOfRangeException	If the index is invalid