Specialised generic version of the standard List class which can be converted to XML. Containss a standard List object and has wrapper methods for most of the standard List functionality plus some extras. More...

Inheritance diagram for Seci.SerialisableList< T >:

Collaboration diagram for Seci.SerialisableList< T >:

Public Member Functions
void	Add (T item)
	Wrapper for standard List "Add". More...

void	AddRange (IEnumerable< T > collection)
	Wrapper for standard List "Add". More...

void	Clear ()
	Wrapper for standard List "Clear" - removes all items. More...

object	Clone ()
	Clone - default method of ICloneable. Produces a deep-copy of the List. More...

Boolean	Contains (T item)
	Wrapper for standard List "Contains". More...

IEnumerator< T >	GetEnumerator ()
	GetEnumerator - default method of IEnumerable. Provides an iterator over a generic List. More...

List< T >	GetRange (int index, int count)
	Wrapper for standard List "GetRange" - returns all items in a specified range. More...

void	Insert (int index, T item)
	Wrapper for standard List "Insert". More...

Boolean	Remove (T item)
	Wrapper for standard List "Remove". More...

int	RemoveAll (Predicate< T > match)
	Wrapper for standard List "RemoveAll". Removes all items that match the specified predicate. More...

void	RemoveAt (int index)
	Wrapper for standard List "RemoveAt". More...

void	RemoveRange (int index, int count)
	Wrapper for standard List "RemoveRange". More...

T[]	ToArray ()
	Wrapper for standard List "ToArray". More...

Properties
int	Count `[get]`

T[]	Items `[get, set]`
	This property is purely for serialising and deserialising the items of the List. More...

T	this[int index] `[get, set]`

Private Member Functions
System.Collections.IEnumerator System.Collections.IEnumerable.	GetEnumerator ()
	System.Collections.IEnumerable.GetEnumerator - default method of IEnumerable. Provides an iterator over a non-generic List. As this is a generic list it calls the iterator for a generic list. More...

Private Attributes
List< T >	_list = new List<T>()

Detailed Description

Specialised generic version of the standard List class which can be converted to XML. Containss a standard List object and has wrapper methods for most of the standard List functionality plus some extras.

Template Parameters

T	Generic type

Definition at line 17 of file SerialisableList.cs.

Member Function Documentation

void Seci.SerialisableList< T >.Add ( T item )

inline

Wrapper for standard List "Add".

Parameters

item	The item of type T to add

Definition at line 31 of file SerialisableList.cs.

void Seci.SerialisableList< T >.AddRange ( IEnumerable< T > collection )

inline

Wrapper for standard List "Add".

Definition at line 40 of file SerialisableList.cs.

void Seci.SerialisableList< T >.Clear ( )

inline

Wrapper for standard List "Clear" - removes all items.

Definition at line 101 of file SerialisableList.cs.

object Seci.SerialisableList< T >.Clone ( )

inline

Clone - default method of ICloneable. Produces a deep-copy of the List.

Returns: An object which will need to be cast to the correct type

Definition at line 177 of file SerialisableList.cs.

Boolean Seci.SerialisableList< T >.Contains ( T item )

inline

Wrapper for standard List "Contains".

Parameters

item	The item of type T to match

Returns: Boolean result

Definition at line 126 of file SerialisableList.cs.

IEnumerator<T> Seci.SerialisableList< T >.GetEnumerator ( )

inline

GetEnumerator - default method of IEnumerable. Provides an iterator over a generic List.

Returns: The current item

Definition at line 149 of file SerialisableList.cs.

System.Collections.IEnumerator System.Collections.IEnumerable. Seci.SerialisableList< T >.GetEnumerator ( )

inlineprivate

System.Collections.IEnumerable.GetEnumerator - default method of IEnumerable. Provides an iterator over a non-generic List. As this is a generic list it calls the iterator for a generic list.

Returns: The current item

Definition at line 163 of file SerialisableList.cs.

List<T> Seci.SerialisableList< T >.GetRange	(	int	index,
		int	count
	)

inline

Wrapper for standard List "GetRange" - returns all items in a specified range.

Parameters

index	The starting index
count	The number of items of type T to return

Returns: List of type T containing the range

Definition at line 116 of file SerialisableList.cs.

void Seci.SerialisableList< T >.Insert	(	int	index,
		T	item
	)

inline

Wrapper for standard List "Insert".

Parameters

index	The index to insert at
item	The item of type T to insert

Definition at line 50 of file SerialisableList.cs.

Boolean Seci.SerialisableList< T >.Remove ( T item )

inline

Wrapper for standard List "Remove".

Parameters

item	The item of type T to remove

Returns: Result

Definition at line 73 of file SerialisableList.cs.

int Seci.SerialisableList< T >.RemoveAll ( Predicate< T > match )

inline

Wrapper for standard List "RemoveAll". Removes all items that match the specified predicate.

Parameters

match The predicate to match

Returns: Number of items removed

Definition at line 93 of file SerialisableList.cs.

void Seci.SerialisableList< T >.RemoveAt ( int index )

inline

Wrapper for standard List "RemoveAt".

Parameters

index The index to insert at

Definition at line 63 of file SerialisableList.cs.

void Seci.SerialisableList< T >.RemoveRange	(	int	index,
		int	count
	)

inline

Wrapper for standard List "RemoveRange".

Parameters

index	The starting index
count	The number of items of type T to remove

Definition at line 83 of file SerialisableList.cs.

T [] Seci.SerialisableList< T >.ToArray ( )

inline

Wrapper for standard List "ToArray".

Returns: An array of T

Definition at line 135 of file SerialisableList.cs.

Member Data Documentation

List<T> Seci.SerialisableList< T >._list = new List<T>()

private

Definition at line 19 of file SerialisableList.cs.

Property Documentation

int Seci.SerialisableList< T >.Count

get

Definition at line 23 of file SerialisableList.cs.

T [] Seci.SerialisableList< T >.Items

getset

This property is purely for serialising and deserialising the items of the List.

Definition at line 200 of file SerialisableList.cs.

T Seci.SerialisableList< T >.this[int index]

getset

Definition at line 22 of file SerialisableList.cs.

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

/isis2/instcontrol_temp/NewSECI/Sample_Environment_Control_Interface/Seci/Tools/SerialisableList.cs

Public Member Functions

Properties

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation