PlaneEnumerator Class Reference

Container for a set of planes. More...

Inherits INativeHandle, and IList< Plane >.

Public Member Functions
void	Dispose ()
	IDisposable implementation. More...
int	IndexOf (Plane item)
	Finds the given item and returns its index. More...
bool	Contains (Plane item)
	Determines whether this PlaneEnum More...
void	CopyTo (Plane[] array, int arrayIndex)
	Copies the elements of this PlaneEnum to the given array , starting at arrayIndex . More...
IEnumerator< Plane >	GetEnumerator ()
	Get the enumerator to iterate over all planes. More...

Static Public Member Functions
static PlaneEnumerator	FromHandle (IntPtr handle, ShareObject doShare)
	Create a plane object from a handle . More...

Protected Member Functions
	PlaneEnumerator (IntPtr handle)
	Create a plane object from a handle . More...
virtual void	Dispose (bool disposing)
	IDispose helper function. More...

Properties
IntPtr	Handle [get]
	Native CVB buffer handle. More...
bool	IsDisposed [get]
	Tests if the native handle has already been disposed.
int	Count [get]
	Gets the number of planes.
Plane	this[int index] [get]
	Get the plane at the given index . More...
Properties inherited from INativeHandle
IntPtr	Handle [get]
	The native handle of the object.
bool	IsDisposed [get]
	Possibility to check whether the object has already been disposed of.

Events
NativeHandleEventDelegate	ObjectDisposing
	Raised when this object is about to be disposed via the IDisposable.Dispose method. More...
Events inherited from INativeHandle
NativeHandleEventDelegate	ObjectDisposing
	Raised when this object is about to be disposed via the IDisposable.Dispose method. More...

Detailed Description

Container for a set of planes.

Constructor & Destructor Documentation

PlaneEnumerator()

PlaneEnumerator ( IntPtr  handle )

protected

Create a plane object from a handle .

Parameters

handle

Native IBuffer handle.

Member Function Documentation

Contains()

bool Contains

(

Plane

item

)

Determines whether this PlaneEnum

Parameters

item	Item to find.

Returns

true if item is in this collection.

CopyTo()

void CopyTo	(	Plane[]	array,
		int	arrayIndex
	)

Copies the elements of this PlaneEnum to the given array , starting at arrayIndex .

Parameters

array	Array to copy elements to.
arrayIndex	Start index in array .

Dispose() [1/2]

void Dispose

(

)

IDisposable implementation.

Call this method to release the resources allocated by this buffer immediately. Remember that after calling Dispose, any subsequent access to references to this buffer will result in an ObjectDisposedException.

Dispose() [2/2]

virtual void Dispose ( bool  disposing )

protectedvirtual

IDispose helper function.

Parameters

disposing

true when called via IDisposable.Dispose, false when called by the finalizer.

FromHandle()

static PlaneEnumerator FromHandle ( IntPtr  handle, ShareObject  doShare  )

static

Create a plane object from a handle .

Parameters

handle	Native IBuffer handle.
doShare	ShareObject.Yes if handle should be shared.

Returns

Newly created wrapper object.

GetEnumerator()

IEnumerator< Plane > GetEnumerator

(

)

Get the enumerator to iterate over all planes.

Returns

Enumerator over all planes.

IndexOf()

int IndexOf

(

Plane

item

)

Finds the given item and returns its index.

Parameters

item	Item to find.

Returns

Index of item; -1 if not found.

Property Documentation

Handle

IntPtr Handle

get

Native CVB buffer handle.

It is normally not necessary to work with this handle in CVB.Net. Note that using this handle in connection with the legacy CVB managed wrappers may actually be disruptive to your application.

Implements INativeHandle.

this[int index]

Plane this[int index]

get

Get the plane at the given index .

Parameters

index

Plane index.

Returns

The Plane at the given index .

Event Documentation

ObjectDisposing

NativeHandleEventDelegate ObjectDisposing

Raised when this object is about to be disposed via the IDisposable.Dispose method.

This event is raised right before this object is disposed. The dispose itself cannot be canceled.