DirectOutputHyperpinPlugin.DirectOutputPlugin Class Reference

DirectOutputPlugin is IHyperpinPlugin interface implementation required by Hyperpin. More...

Inheritance diagram for DirectOutputHyperpinPlugin.DirectOutputPlugin:

Collaboration diagram for DirectOutputHyperpinPlugin.DirectOutputPlugin:

Public Member Functions
void	DataReceive (int Number, int Value)
	This method is called, when Hyperpin sends new data to DirectOutput. HyperPin does only send a IDNumber and a value. These values are fed to DirectOutput as updates on EMTable elements (TableElementType character E). The IHyperpinPlugin interface requires the implementation of this method. More...
void	PluginFinish ()
	Finishes the plugin. This is the last method called, before a plugin is discared. This method is also called, after a undhandled exception has occured in a plugin. The IHyperpinPlugin interface requires the implementation of this method. More...
void	PluginInit ()
	Initializes the Plugin. The IHyperpinPlugin interface requires the implementation of this method. DirectOutput likes to receive a global config filename, a table file name and a romname when it is initialized. The global config file for the HyperPinPlugin is called GlobalConfig_Hyperpin.xml and should reside in the config subdirectory of the directory containing the DirectOutput.dll or there can be a shortcut named config pointing to the directory containg the config file. For the tablename the name of a file named Hyperpin.tmp located in the config dir of DirectOutput is supplied to DirectOutput. This file does/must not exist. For the RomName the value Hyperpin is provided to DOF to allow for configuratiojn through LedControl files. More...
	DirectOutputPlugin ()
	Initializes a new instance of the DirectOutputPlugin class. More...

Properties
string	Name [get]
	Gets the name of this IHyperpinPlugin. More...
Pinball	Pinball [get, set]
	Gets or sets the Pinball object for the plugin. More...

Detailed Description

DirectOutputPlugin is IHyperpinPlugin interface implementation required by Hyperpin.

Definition at line 18 of file Plugin.cs.

Constructor & Destructor Documentation

DirectOutputHyperpinPlugin.DirectOutputPlugin.DirectOutputPlugin ( )

inline

Initializes a new instance of the DirectOutputPlugin class.

Definition at line 177 of file Plugin.cs.

Member Function Documentation

void DirectOutputHyperpinPlugin.DirectOutputPlugin.DataReceive ( int  Number, int  Value  )

inline

This method is called, when Hyperpin sends new data to DirectOutput.
HyperPin does only send a IDNumber and a value. These values are fed to DirectOutput as updates on EMTable elements (TableElementType character E).
The IHyperpinPlugin interface requires the implementation of this method.

Parameters

Number	The received IdNumber.
Value	The received value.

Definition at line 54 of file Plugin.cs.

void DirectOutputHyperpinPlugin.DirectOutputPlugin.PluginFinish ( )

inline

Finishes the plugin.
This is the last method called, before a plugin is discared. This method is also called, after a undhandled exception has occured in a plugin.
The IHyperpinPlugin interface requires the implementation of this method.

Definition at line 69 of file Plugin.cs.

void DirectOutputHyperpinPlugin.DirectOutputPlugin.PluginInit ( )

inline

Initializes the Plugin.
The IHyperpinPlugin interface requires the implementation of this method.
DirectOutput likes to receive a global config filename, a table file name and a romname when it is initialized.
The global config file for the HyperPinPlugin is called GlobalConfig_Hyperpin.xml and should reside in the config subdirectory of the directory containing the DirectOutput.dll or there can be a shortcut named config pointing to the directory containg the config file.
For the tablename the name of a file named Hyperpin.tmp located in the config dir of DirectOutput is supplied to DirectOutput. This file does/must not exist.
For the RomName the value Hyperpin is provided to DOF to allow for configuratiojn through LedControl files.

Definition at line 84 of file Plugin.cs.

Property Documentation

string DirectOutputHyperpinPlugin.DirectOutputPlugin.Name

get

Gets the name of this IHyperpinPlugin.

Remarks

This property returns the version of the DirectOutput.dll, NOT the version of the DirectOutputPlugin plugin.

The name of this IHyperpinPlugin (Name is DirectOutput (V: VersionNumber) af of TimeStamp).

Definition at line 36 of file Plugin.cs.

Pinball DirectOutputHyperpinPlugin.DirectOutputPlugin.Pinball

getset

Gets or sets the Pinball object for the plugin.

The Pinball object for the plugin.

Definition at line 163 of file Plugin.cs.

---

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

• C:/Users/Tom/Documents/GitHub/DirectOutput/HyperpinPlugin/Plugin.cs