DirectOutput
DirectOutput framework R2 for virtual pinball cabinets.
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events Macros Pages
DirectOutput.Table.TableElementList Class Reference

List of TableElement objects. More...

Inheritance diagram for DirectOutput.Table.TableElementList:
Collaboration diagram for DirectOutput.Table.TableElementList:

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...
 
Dictionary< int, TableElementGetTableElementDictonaryForType (TableElementTypeEnum Type)
 Returns a dictionary for the specified TableElementType More...
 
List< TableElementGetTableElementListForType (TableElementTypeEnum Type)
 Returns a list of the TableElement objects with the specified type.
More...
 
void UpdateState (TableElementTypeEnum TableElementType, int Number, int State)
 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...
 
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...
 
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...
 
delegate void TableElementValueChangedEventHandler (object sender, TableElementValueChangedEventArgs e)
 EventHandler for TableElementValueChanged events. More...
 
 TableElementList ()
 Initializes a new instance of the TableElementList class. More...
 

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 TableElementDescriptor] [get]
 Gets the TableElement with the specified descriptor (e.g. S48, W14, L59). More...
 

Events

TableElementValueChangedEventHandler TableElementValueChanged
 Is fired on changes of the value of any TableElement in this collection More...
 

Detailed Description

List of TableElement objects.

Constructor & Destructor Documentation

DirectOutput.Table.TableElementList.TableElementList ( )

Initializes a new instance of the TableElementList class.

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.
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.
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
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
void DirectOutput.Table.TableElementList.FinishAssignedEffects ( )

Finishes the AssignedEffects for all TableElements in this list.

Dictionary<int, TableElement> DirectOutput.Table.TableElementList.GetTableElementDictonaryForType ( TableElementTypeEnum  Type)

Returns a dictionary for the specified TableElementType

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.
void DirectOutput.Table.TableElementList.InitAssignedEffects ( Table  Table)

Initializes the AssignedEffects for all TableElements in this list.

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.
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.
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 ( TableElementTypeEnum  TableElementType,
int  Number,
int  State 
)

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

Parameters
TableElementTypeType of entry to update
NumberNumber of entry to update
StateState of entry to update

Property Documentation

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

Returns a dictionary of GIString table elements

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

Returns a dictionary of Lamp table elements

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

Returns a dictionary of Mech table elements

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

Returns a dictionary of Solenoid table elements

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

Returns a dictionary of Switch table elements

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

Gets the TableElement with the specified descriptor (e.g. S48, W14, L59).

The TableElement for the specified descriptor.

Parameters
TableElementDescriptorThe table element descriptor (e.g. S48, W14, L59).
Returns
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

Event Documentation

TableElementValueChangedEventHandler DirectOutput.Table.TableElementList.TableElementValueChanged

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


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