DirectOuput Framework R2
DirectOutput framework R2 for virtual pinball cabinets
Go to:
Overview 
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events Macros Pages
DirectOutput.Table.Table Class Reference

Holds all table specific information and handles all TableElements More...

Public Member Functions

void UpdateTableElement (TableElementData Data)
 Updates the TableElements list with data received from Pinmame. More...
 
void TriggerStaticEffects ()
 Triggers the static effects for the table. More...
 
void Init (Pinball Pinball)
 Initializes the table and the contained objects(Effects, TableElements). More...
 
void Finish ()
 Finishes the table and the contained objects (Effects, TableElements) More...
 
string GetConfigXml ()
 Returns a serialized XML representation of the Table configuration. More...
 
void SaveConfigXmlFile (string FileName)
 Serializes the Table configuration to a XML file. More...
 
 Table ()
 Initializes a new instance of the Table class. More...
 

Static Public Member Functions

static Table GetTableFromConfigXmlFile (string FileName)
 Instanciates a Table object from a Table configuration in a XML file. More...
 
static Table GetTableFromConfigXmlFile (FileInfo TableConfigFile)
 Instanciates a Table object from a Table configuration in a XML file. More...
 
static Table GetTableFromConfigXml (string ConfigXml)
 Instanciates a Table object from a Table configuration in a XML string. More...
 

Properties

TableElementList TableElements [get, set]
 Lists the TableElement objects for the Table.
This list is automaticaly extend with new TableElement objects if updates for non existing elements are received. More...
 
Pinball Pinball [get, set]
 Gets the pinball object to which the Table object belongs. More...
 
FastImageList Bitmaps [get, set]
 Gets or sets the list of bitmaps More...
 
string TableName [get, set]
 Name of the Table.
Triggers TableNameChanged if value is changed. More...
 
string RomName [get, set]
 Name of the table rom.
Triggers RomNameChanged if value is changed. More...
 
string TableFilename [get, set]
 Gets or sets the filename of the table. More...
 
string TableConfigurationFilename [get, set]
 Gets or sets the table configuration filename. More...
 
bool AddLedControlConfig [get, set]
 Gets or sets a value indicating whether configurations from ledcontrol files should be added to the table config from a xml table config file. More...
 
TableConfigSourceEnum ConfigurationSource [get, set]
 Gets or sets the configuration source. More...
 
EffectList Effects [get, set]
 List of table specific effects. More...
 
AssignedEffectList AssignedStaticEffects [get, set]
 Gets or sets the static effects list for the table.
AssignedEffects contained in AssignedStaticEffects are triggered when the Table is started. The Trigger method is called with null as the TableElement parameter.
More...
 

Events

EventHandler< EventArgs > TableNameChanged
 Event is fired if the value of the property TableName is changed. More...
 
EventHandler< EventArgs > RomNameChanged
 Event is fired if the value of the property RomName is changed. More...
 

Detailed Description

Holds all table specific information and handles all TableElements

Definition at line 19 of file Table.cs.

Constructor & Destructor Documentation

DirectOutput.Table.Table.Table ( )
inline

Initializes a new instance of the Table class.

Definition at line 338 of file Table.cs.

Member Function Documentation

void DirectOutput.Table.Table.Finish ( )
inline

Finishes the table and the contained objects (Effects, TableElements)

Definition at line 226 of file Table.cs.

string DirectOutput.Table.Table.GetConfigXml ( )
inline

Returns a serialized XML representation of the Table configuration.

Returns
XMLString

Definition at line 241 of file Table.cs.

static Table DirectOutput.Table.Table.GetTableFromConfigXml ( string  ConfigXml)
inlinestatic

Instanciates a Table object from a Table configuration in a XML string.

Parameters
ConfigXmlXML string
Returns
Table object

Definition at line 309 of file Table.cs.

static Table DirectOutput.Table.Table.GetTableFromConfigXmlFile ( string  FileName)
inlinestatic

Instanciates a Table object from a Table configuration in a XML file.

Parameters
FileNameName of the XML file.
Returns
Table object

Definition at line 275 of file Table.cs.

static Table DirectOutput.Table.Table.GetTableFromConfigXmlFile ( FileInfo  TableConfigFile)
inlinestatic

Instanciates a Table object from a Table configuration in a XML file.

Parameters
TableConfigFileFileInfo object for the config file.
Returns
Table object

Definition at line 299 of file Table.cs.

void DirectOutput.Table.Table.Init ( Pinball  Pinball)
inline

Initializes the table and the contained objects(Effects, TableElements).

Parameters
PinballThe Pinball object containing the Table.

Definition at line 214 of file Table.cs.

void DirectOutput.Table.Table.SaveConfigXmlFile ( string  FileName)
inline

Serializes the Table configuration to a XML file.

Parameters
FileNameName of the XML file.

Definition at line 264 of file Table.cs.

void DirectOutput.Table.Table.TriggerStaticEffects ( )
inline

Triggers the static effects for the table.

Definition at line 205 of file Table.cs.

void DirectOutput.Table.Table.UpdateTableElement ( TableElementData  Data)
inline

Updates the TableElements list with data received from Pinmame.

Parameters
DataData received from Pinmame and handled by the PinMameInputManger

Definition at line 196 of file Table.cs.

Property Documentation

bool DirectOutput.Table.Table.AddLedControlConfig
getset

Gets or sets a value indicating whether configurations from ledcontrol files should be added to the table config from a xml table config file.

true will add ledcontrol configs, false (default) will ingnore ledcontrol configs.

Definition at line 137 of file Table.cs.

AssignedEffectList DirectOutput.Table.Table.AssignedStaticEffects
getset

Gets or sets the static effects list for the table.
AssignedEffects contained in AssignedStaticEffects are triggered when the Table is started. The Trigger method is called with null as the TableElement parameter.

The static effects list.

Definition at line 180 of file Table.cs.

FastImageList DirectOutput.Table.Table.Bitmaps
getset

Gets or sets the list of bitmaps

The bitmaps list.

Definition at line 48 of file Table.cs.

TableConfigSourceEnum DirectOutput.Table.Table.ConfigurationSource
getset

Gets or sets the configuration source.

The configuration source.

Definition at line 153 of file Table.cs.

EffectList DirectOutput.Table.Table.Effects
getset

List of table specific effects.

Definition at line 166 of file Table.cs.

Pinball DirectOutput.Table.Table.Pinball
getset

Gets the pinball object to which the Table object belongs.

The pinball object to which the Table object belongs.

Definition at line 35 of file Table.cs.

string DirectOutput.Table.Table.RomName
getset

Name of the table rom.
Triggers RomNameChanged if value is changed.

Definition at line 89 of file Table.cs.

string DirectOutput.Table.Table.TableConfigurationFilename
getset

Gets or sets the table configuration filename.

The table configuration filename.

Definition at line 125 of file Table.cs.

TableElementList DirectOutput.Table.Table.TableElements
getset

Lists the TableElement objects for the Table.
This list is automaticaly extend with new TableElement objects if updates for non existing elements are received.

Definition at line 26 of file Table.cs.

string DirectOutput.Table.Table.TableFilename
getset

Gets or sets the filename of the table.

The filename of the table.

Definition at line 116 of file Table.cs.

string DirectOutput.Table.Table.TableName
getset

Name of the Table.
Triggers TableNameChanged if value is changed.

Definition at line 61 of file Table.cs.

Event Documentation

EventHandler<EventArgs> DirectOutput.Table.Table.RomNameChanged

Event is fired if the value of the property RomName is changed.

Definition at line 106 of file Table.cs.

EventHandler<EventArgs> DirectOutput.Table.Table.TableNameChanged

Event is fired if the value of the property TableName is changed.

Definition at line 78 of file Table.cs.


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