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.

Constructor & Destructor Documentation

DirectOutput.Pinball.Pinball

(

)

Initializes a new instance of the Pinball class.

Member Function Documentation

void DirectOutput.Pinball.Finish

(

)

Finishes the Pinball object.

void DirectOutput.Pinball.Init

(

)

Initializes/starts the Pinball object

void DirectOutput.Pinball.MainThreadSignal

(

)

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

void DirectOutput.Pinball.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.

Parameters

TableElementTypeChar	The table element type char as specified in the TableElementTypeEnum.
Number	The number of the TableElement.
Value	The value of the TableElement.

void DirectOutput.Pinball.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.

Parameters

TableElementData

The table element data to be received.

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

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

Parameters

GlobalConfigFilename	The global config filename.
TableFilename	The table filename.
RomName	Name of the rom.

override string DirectOutput.Pinball.ToString

(

)

Returns a System.String that represents this instance.

Returns

A System.String that represents this instance.

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

Updates the table element statistics.

Parameters

TableElementData	The table element data.
Duration	The duration.

void DirectOutput.Pinball.WriteStatisticsToLog

(

)

Writes the statistics to the log.

Property Documentation

AlarmHandler DirectOutput.Pinball.Alarms

getset

Gets the AlarmHandler object for the Pinball object.

The AlarmHandler object for the Pinball object.

Cabinet DirectOutput.Pinball.Cabinet

getset

Gets or sets the Cabinet object for the Pinball object.

The cabinet object for the Pinball object.

GlobalConfig DirectOutput.Pinball.GlobalConfig

getset

Gets the global config for the Pinnball object.

The global config for the Pinball object.

bool DirectOutput.Pinball.MainThreadIsActive

get

Indicates if the MainThread of DirectOutput is active

Table.Table DirectOutput.Pinball.Table

getset

Gets or sets the table object for the Pinball object.

The table object for the Pinball object.

TimeSpanStatisticsList DirectOutput.Pinball.TimeSpanStatistics

getset

---

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

• C:/Users/Tom/Documents/GitHub/DirectOutput/DirectOutput/Pinball.cs