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.Pinball Class Reference

Pinball is the main object of the DirectOutput framework.
It holds all objects required to process Pinmame data, trigger the necessary effects and update toys and output controllers. More...

Public Member Functions

void Setup (string GlobalConfigFilename="", string TableFilename="", string RomName="")
 Configures the Pinball object.
Loads the global config, table config and cabinet config More...
 
void Init ()
 Initializes/starts the Pinball object More...
 
void Finish ()
 Finishes the Pinball object. More...
 
void MainThreadSignal ()
 Signals the main thread to continue its work (if currently sleeping). More...
 
void UpdateTableElementStatistics (TableElementData TableElementData, TimeSpan Duration)
 Updates the table element statistics. More...
 
void WriteStatisticsToLog ()
 Writes the statistics to the log. More...
 
void ReceiveData (char TableElementTypeChar, int Number, int Value)
 Receives the table element data from the calling app (e.g. B2S.Server providing data through the plugin interface).
The received data is put in a queue and the internal thread of the framework is notified about the availability of new data. More...
 
void ReceiveData (TableElementData TableElementData)
 Receives the table element data from the calling app.
The received data is put in a queue and the internal thread of the framework is notified about the availability of new data. More...
 
override string ToString ()
 Returns a System.String that represents this instance. More...
 
 Pinball ()
 Initializes a new instance of the Pinball class. More...
 

Properties

TimeSpanStatisticsList TimeSpanStatistics [get, set]
 
Table.Table Table [get, set]
 Gets or sets the table object for the Pinball object. More...
 
Cabinet Cabinet [get, set]
 Gets or sets the Cabinet object for the Pinball object. More...
 
AlarmHandler Alarms [get, set]
 Gets the AlarmHandler object for the Pinball object. More...
 
GlobalConfig GlobalConfig [get, set]
 Gets the global config for the Pinnball object. More...
 
bool MainThreadIsActive [get]
 Indicates if the MainThread of DirectOutput is active More...
 

Detailed Description

Pinball is the main object of the DirectOutput framework.
It holds all objects required to process Pinmame data, trigger the necessary effects and update toys and output controllers.

Definition at line 23 of file Pinball.cs.

Constructor & Destructor Documentation

DirectOutput.Pinball.Pinball ( )
inline

Initializes a new instance of the Pinball class.

Definition at line 801 of file Pinball.cs.

Member Function Documentation

void DirectOutput.Pinball.Finish ( )
inline

Finishes the Pinball object.

Definition at line 440 of file Pinball.cs.

void DirectOutput.Pinball.Init ( )
inline

Initializes/starts the Pinball object

Definition at line 401 of file Pinball.cs.

void DirectOutput.Pinball.MainThreadSignal ( )
inline

Signals the main thread to continue its work (if currently sleeping).

Definition at line 549 of file Pinball.cs.

void DirectOutput.Pinball.ReceiveData ( char  TableElementTypeChar,
int  Number,
int  Value 
)
inline

Receives the table element data from the calling app (e.g. B2S.Server providing data through the plugin interface).
The received data is put in a queue and the internal thread of the framework is notified about the availability of new data.

Parameters
TableElementTypeCharThe table element type char as specified in the TableElementTypeEnum.
NumberThe number of the TableElement.
ValueThe value of the TableElement.

Definition at line 740 of file Pinball.cs.

void DirectOutput.Pinball.ReceiveData ( TableElementData  TableElementData)
inline

Receives the table element data from the calling app.
The received data is put in a queue and the internal thread of the framework is notified about the availability of new data.

Parameters
TableElementDataThe table element data to be received.

Definition at line 753 of file Pinball.cs.

void DirectOutput.Pinball.Setup ( string  GlobalConfigFilename = "",
string  TableFilename = "",
string  RomName = "" 
)
inline

Configures the Pinball object.
Loads the global config, table config and cabinet config

Parameters
GlobalConfigFilenameThe global config filename.
TableFilenameThe table filename.
RomNameName of the rom.

Definition at line 105 of file Pinball.cs.

override string DirectOutput.Pinball.ToString ( )
inline

Returns a System.String that represents this instance.

Returns
A System.String that represents this instance.

Definition at line 769 of file Pinball.cs.

void DirectOutput.Pinball.UpdateTableElementStatistics ( TableElementData  TableElementData,
TimeSpan  Duration 
)
inline

Updates the table element statistics.

Parameters
TableElementDataThe table element data.
DurationThe duration.

Definition at line 694 of file Pinball.cs.

void DirectOutput.Pinball.WriteStatisticsToLog ( )
inline

Writes the statistics to the log.

Definition at line 710 of file Pinball.cs.

Property Documentation

AlarmHandler DirectOutput.Pinball.Alarms
getset

Gets the AlarmHandler object for the Pinball object.

The AlarmHandler object for the Pinball object.

Definition at line 72 of file Pinball.cs.

Cabinet DirectOutput.Pinball.Cabinet
getset

Gets or sets the Cabinet object for the Pinball object.

The cabinet object for the Pinball object.

Definition at line 56 of file Pinball.cs.

GlobalConfig DirectOutput.Pinball.GlobalConfig
getset

Gets the global config for the Pinnball object.

The global config for the Pinball object.

Definition at line 86 of file Pinball.cs.

bool DirectOutput.Pinball.MainThreadIsActive
get

Indicates if the MainThread of DirectOutput is active

Definition at line 532 of file Pinball.cs.

Table.Table DirectOutput.Pinball.Table
getset

Gets or sets the table object for the Pinball object.

The table object for the Pinball object.

Definition at line 43 of file Pinball.cs.

TimeSpanStatisticsList DirectOutput.Pinball.TimeSpanStatistics
getset

Definition at line 30 of file Pinball.cs.


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