A serialisable list for containing objects of type SeciConfiguration. This class wraps a standard List and exposes some of the basic methods, but also includes some specialist method for serialising and deserialising the components. Only the names of the components are serialised and deserialised. More...

Collaboration diagram for Seci.ComponentList:

Public Member Functions
void	Add (Configuration item)
	This a wrapper for the standard List Add command. More...

void	Clear ()
	This a wrapper for the standard List "Clear" command. More...

void	Insert (int index, Configuration item)
	This a wrapper for the standard List "Insert" command. More...

Boolean	Remove (Configuration item)
	This a wrapper for the standard List "Remove" command. More...

void	RemoveAt (int index)
	This a wrapper for the standard List "RemoveAt" command. More...

Properties
String[]	Components `[get, set]`
	This property is purely for serialising and deserialising the names of any components in the configuration. Nothing else is needed as SECI will load any components after the rest of the configuration has loaded. More...

int	Count `[get]`
	This a wrapper for the standard List "Count" command. More...

Configuration	this[int index] `[get, set]`
	This is a property for accessing individual components by index. More...

Configuration	this[String name] `[get, set]`
	This is a property for accessing individual components by component name. More...

Private Attributes
List< Configuration >	_compsList = new List<Configuration>()

Detailed Description

A serialisable list for containing objects of type SeciConfiguration. This class wraps a standard List and exposes some of the basic methods, but also includes some specialist method for serialising and deserialising the components. Only the names of the components are serialised and deserialised.

Definition at line 17 of file ComponentList.cs.

Member Function Documentation

void Seci.ComponentList.Add ( Configuration item )

inline

This a wrapper for the standard List Add command.

Parameters

item	The component to add to the configuration

Definition at line 112 of file ComponentList.cs.

void Seci.ComponentList.Clear ( )

inline

This a wrapper for the standard List "Clear" command.

Definition at line 149 of file ComponentList.cs.

void Seci.ComponentList.Insert	(	int	index,
		Configuration	item
	)

inline

This a wrapper for the standard List "Insert" command.

Parameters

index	Where in the List to insert the component
item	The component to insert in to the configuration

Definition at line 141 of file ComponentList.cs.

Boolean Seci.ComponentList.Remove ( Configuration item )

inline

This a wrapper for the standard List "Remove" command.

Parameters

item	The component to remove to the configuration

Returns: Result

Definition at line 122 of file ComponentList.cs.

void Seci.ComponentList.RemoveAt ( int index )

inline

This a wrapper for the standard List "RemoveAt" command.

Parameters

index The index number of the component to remove to the configuration.

Definition at line 131 of file ComponentList.cs.

Member Data Documentation

List<Configuration> Seci.ComponentList._compsList = new List<Configuration>()

private

Definition at line 19 of file ComponentList.cs.

Property Documentation

String [] Seci.ComponentList.Components

getset

This property is purely for serialising and deserialising the names of any components in the configuration. Nothing else is needed as SECI will load any components after the rest of the configuration has loaded.

Definition at line 28 of file ComponentList.cs.

int Seci.ComponentList.Count

get

This a wrapper for the standard List "Count" command.

Definition at line 106 of file ComponentList.cs.

Configuration Seci.ComponentList.this[int index]

getset

This is a property for accessing individual components by index.

Parameters

index The index number of the required component

Returns: Returns the selected component

Definition at line 60 of file ComponentList.cs.

Configuration Seci.ComponentList.this[String name]

getset

This is a property for accessing individual components by component name.

Parameters

name	The name of the required component

Returns: Returns the selected component

Definition at line 78 of file ComponentList.cs.

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

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

Public Member Functions

Properties

Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation