WIP
DirectOutput framework for virtual pinball cabinets WIP
Go to:
Overview 
DirectOutput.Table.TableElementList Class Reference

List of TableElement objects. More...

Inheritance diagram for DirectOutput.Table.TableElementList:
DirectOutput.General.Generic.ExtList< TableElement >

Public Member Functions

void InitAssignedEffects (Table Table)
 Initializes the AssignedEffects for all TableElements in this list. More...
 
void FinishAssignedEffects ()
 Finishes the AssignedEffects for all TableElements in this list. More...
 
List< TableElementGetTableElementListForType (TableElementTypeEnum Type)
 Returns a list of the TableElement objects with the specified type.
More...
 
void UpdateState (TableElementData Data)
 Method to update the state and/or add a entry to the list More...
 
new void Add (TableElement TableElement)
 Adds a TableElement to the list. More...
 
void Add (TableElementTypeEnum TableElementType, int Number, int State)
 Method for adding a entry to the list. More...
 
void Add (string TableElementName, int State)
 
new bool Contains (TableElement TableElement)
 Checks if a specified TableElement is contained in the list. More...
 
bool Contains (TableElementTypeEnum TableElementType, int Number)
 Checks if a specified TableElement is contained in the list. More...
 
bool Contains (string TableElementName)
 Determines whether a table element with the specified name is contained in the list. More...
 
new bool Remove (TableElement TableElement)
 Removes the specified TableElement from the List. More...
 
bool Remove (TableElementTypeEnum TableElementType, int Number)
 Removes the TableElement with the specified TableElementType and Number from the list. More...
 
bool Remove (string TableElementName)
 Removes the table element with the specified name. More...
 
string[] GetTableElementDescriptors ()
 Gets the table element descriptors. NamedElements are returned as $Name. Numbered elemenst are returned with the first char describing the type of the table element (S=Solenoid,W=Switch,L=Lamp and so on) plus its number (e.g. S48 for solenoid 48) More...
 
delegate void TableElementValueChangedEventHandler (object sender, TableElementValueChangedEventArgs e)
 EventHandler for TableElementValueChanged events. More...
 
 TableElementList ()
 Initializes a new instance of the TableElementList class. More...
 
- Public Member Functions inherited from DirectOutput.General.Generic.ExtList< TableElement >
int IndexOf (T Item)
 Determines the index of a specific item. More...
 
int IndexOf (object value)
 
void CopyTo (T[] Array, int ArrayIndex)
 Copies the elements of the ExtList to an Array, starting at a particular Array index. More...
 
void CopyTo (Array array, int index)
 
IEnumerator< T > GetEnumerator ()
 Returns an enumerator that iterates through a ExtList. More...
 
void Add (T NewListItem)
 Adds a new item to the ExtList. More...
 
int Add (object value)
 
void AddRange (IEnumerable< T > Collection)
 Adds a list of items to the ExtList. More...
 
ExtList< T > Clone ()
 Creates a clone of the ExtList More...
 
void Insert (int Index, T Item)
 Inserts an item to the ExtList at the specified Index. More...
 
void Insert (int index, object value)
 
void Clear ()
 Clears the ExtList. More...
 
bool Remove (T ItemToRemove)
 Romves a item from the ExtList. More...
 
void Remove (object value)
 
void RemoveAt (int Index)
 Removes a item at a specified index. More...
 
bool Contains (T ItemToCheck)
 Checks wether the specified item is contained in the ExtList. More...
 
bool Contains (object value)
 
void Sort ()
 Sorts the ExtList. More...
 
void Sort (IComparer< T > Comparer)
 Sorts the ExtList. More...
 
void Sort (Comparison< T > Comparison)
 Sorts the elements in the entire ExtList using the specified System.Comparison<T>. More...
 
T[] ToArray ()
 Returns a array containg the ExtList items. More...
 
 ExtList ()
 
 ExtList (IEnumerable< T > EnumerableList)
 

Properties

Dictionary< int, TableElementSwitch [get]
 Returns a dictionary of Switch table elements More...
 
Dictionary< int, TableElementSolenoid [get]
 Returns a dictionary of Solenoid table elements More...
 
Dictionary< int, TableElementLamp [get]
 Returns a dictionary of Lamp table elements More...
 
Dictionary< int, TableElementGIString [get]
 Returns a dictionary of GIString table elements More...
 
Dictionary< int, TableElementMech [get]
 Returns a dictionary of Mech table elements More...
 
TableElement this[TableElementTypeEnum TableElementType, int Number] [get]
 Indexer for for List More...
 
TableElement this[string TableElementName] [get]
 Gets the TableElement with the specified table element name. More...
 
- Properties inherited from DirectOutput.General.Generic.ExtList< TableElement >
bool IsReadOnly [get]
 This ExtList objects are not readonly.
Will always return false. More...
 
int Count [get]
 Number of items in the ExtList. More...
 
this[int Index] [get, set]
 Indexer of the ExtList.
Returns the item at the specified index. More...
 
bool IsSynchronized [get]
 
object SyncRoot [get]
 
bool IsFixedSize [get]
 

Events

TableElementValueChangedEventHandler TableElementValueChanged
 Is fired on changes of the value of any TableElement in this collection More...
 
- Events inherited from DirectOutput.General.Generic.ExtList< TableElement >
EventHandler< EventArgs > BeforeClear
 Fires before the ExtList is cleared.
If a exception is trown within the events, the list is not cleared. More...
 
EventHandler< EventArgs > AfterClear
 Fires after the ExtList is cleared. More...
 
EventHandler< InsertEventArgs< T > > BeforeInsert
 Fires before a new item is inserted into the ExtList.
If a exception is occurs in the event, to item is not added. OnValidate is called prior to this method.
More...
 
EventHandler< InsertEventArgs< T > > AfterInsert
 Fires after a new item is inserted into the ExtList.
OnValidate is called prior to this method.
More...
 
EventHandler< RemoveEventArgs< T > > BeforeRemove
 Fires before a item is removed from the ExtList. More...
 
EventHandler< RemoveEventArgs< T > > AfterRemove
 Fires after a item is removed from the ExtList. More...
 
EventHandler< SetEventArgs< T > > BeforeSet
 Fires before a item is set in the ExtList. OnValidate is called prior to this method. More...
 
EventHandler< SetEventArgs< T > > AfterSet
 Fires after a item has been set in the ExtList. More...
 

Detailed Description

List of TableElement objects.

Definition at line 11 of file TableElementList.cs.

Constructor & Destructor Documentation

DirectOutput.Table.TableElementList.TableElementList ( )

Initializes a new instance of the TableElementList class.

Definition at line 472 of file TableElementList.cs.

Member Function Documentation

new void DirectOutput.Table.TableElementList.Add ( TableElement  TableElement)

Adds a TableElement to the list.

Parameters
TableElementThe table element to add.
Exceptions
System.ExceptionCant add null to the list of table elements or The TableElement {Type} {Number} cant be added to the list. Another entry with the same type and number does already exist.

Definition at line 210 of file TableElementList.cs.

void DirectOutput.Table.TableElementList.Add ( TableElementTypeEnum  TableElementType,
int  Number,
int  State 
)

Method for adding a entry to the list.

Parameters
TableElementTypeType of entry to add.
NumberNumber of entry to add.
StateState of entry to add.
Exceptions
System.ExceptionCant add null to the list of table elements or The TableElement {Type} {Number} cant be added to the list. Another entry with the same type and number does already exist.

Definition at line 257 of file TableElementList.cs.

void DirectOutput.Table.TableElementList.Add ( string  TableElementName,
int  State 
)

Definition at line 262 of file TableElementList.cs.

new bool DirectOutput.Table.TableElementList.Contains ( TableElement  TableElement)

Checks if a specified TableElement is contained in the list.

Parameters
TableElementTableElement to check.
Returns
true/false

Definition at line 279 of file TableElementList.cs.

bool DirectOutput.Table.TableElementList.Contains ( TableElementTypeEnum  TableElementType,
int  Number 
)

Checks if a specified TableElement is contained in the list.

Parameters
TableElementTypeType of the TableElement to check.
NumberNumber of TableElement to check.
Returns
true/false

Definition at line 297 of file TableElementList.cs.

bool DirectOutput.Table.TableElementList.Contains ( string  TableElementName)

Determines whether a table element with the specified name is contained in the list.

Parameters
TableElementNameName of the table element.
Returns
true table element is contained in list; otherwise, false.

Definition at line 309 of file TableElementList.cs.

void DirectOutput.Table.TableElementList.FinishAssignedEffects ( )

Finishes the AssignedEffects for all TableElements in this list.

Definition at line 31 of file TableElementList.cs.

string [] DirectOutput.Table.TableElementList.GetTableElementDescriptors ( )

Gets the table element descriptors. NamedElements are returned as $Name. Numbered elemenst are returned with the first char describing the type of the table element (S=Solenoid,W=Switch,L=Lamp and so on) plus its number (e.g. S48 for solenoid 48)

Returns
Array of table element descriptors

Definition at line 387 of file TableElementList.cs.

List<TableElement> DirectOutput.Table.TableElementList.GetTableElementListForType ( TableElementTypeEnum  Type)

Returns a list of the TableElement objects with the specified type.

Note
This method does internaly create a new list of the specified table elements on every call. This is not very fast.

Definition at line 55 of file TableElementList.cs.

void DirectOutput.Table.TableElementList.InitAssignedEffects ( Table  Table)

Initializes the AssignedEffects for all TableElements in this list.

Definition at line 20 of file TableElementList.cs.

new bool DirectOutput.Table.TableElementList.Remove ( TableElement  TableElement)

Removes the specified TableElement from the List.

Parameters
TableElementTableElement to remove.
Returns
true if TableElement has been removed, otherwise false.

Definition at line 325 of file TableElementList.cs.

bool DirectOutput.Table.TableElementList.Remove ( TableElementTypeEnum  TableElementType,
int  Number 
)

Removes the TableElement with the specified TableElementType and Number from the list.

Parameters
TableElementTypeTableElementType of the TableElement to remove.
NumberNumber of the TableElement to remove.
Returns
true if TableElement has been removed, otherwise false.

Definition at line 350 of file TableElementList.cs.

bool DirectOutput.Table.TableElementList.Remove ( string  TableElementName)

Removes the table element with the specified name.

Parameters
TableElementNameName of the table element.
Returns
true if TableElement has been removed, otherwise false.

Definition at line 368 of file TableElementList.cs.

delegate void DirectOutput.Table.TableElementList.TableElementValueChangedEventHandler ( object  sender,
TableElementValueChangedEventArgs  e 
)

EventHandler for TableElementValueChanged events.

Parameters
senderThe sender.
eThe TableElementValueChangedEventArgs instance containing the event data.
void DirectOutput.Table.TableElementList.UpdateState ( TableElementData  Data)

Method to update the state and/or add a entry to the list

Parameters
DataTable elemtn data for the update.

Definition at line 169 of file TableElementList.cs.

Property Documentation

Dictionary<int, TableElement> DirectOutput.Table.TableElementList.GIString
get

Returns a dictionary of GIString table elements

Definition at line 101 of file TableElementList.cs.

Dictionary<int, TableElement> DirectOutput.Table.TableElementList.Lamp
get

Returns a dictionary of Lamp table elements

Definition at line 91 of file TableElementList.cs.

Dictionary<int, TableElement> DirectOutput.Table.TableElementList.Mech
get

Returns a dictionary of Mech table elements

Definition at line 112 of file TableElementList.cs.

Dictionary<int, TableElement> DirectOutput.Table.TableElementList.Solenoid
get

Returns a dictionary of Solenoid table elements

Definition at line 81 of file TableElementList.cs.

Dictionary<int, TableElement> DirectOutput.Table.TableElementList.Switch
get

Returns a dictionary of Switch table elements

Definition at line 71 of file TableElementList.cs.

TableElement DirectOutput.Table.TableElementList.this[string TableElementName]
get

Gets the TableElement with the specified table element name.

The TableElement.

Parameters
TableElementNameName of the table element.
Returns

Definition at line 151 of file TableElementList.cs.

TableElement DirectOutput.Table.TableElementList.this[TableElementTypeEnum TableElementType, int Number]
get

Indexer for for List

Parameters
TableElementTypeTableElementType of the TableElement
NumberNumber of TheTableElement
Returns
TableElement with specified TableElementType and Number

Definition at line 128 of file TableElementList.cs.

Event Documentation

TableElementValueChangedEventHandler DirectOutput.Table.TableElementList.TableElementValueChanged

Is fired on changes of the value of any TableElement in this collection

Definition at line 453 of file TableElementList.cs.


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