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

The Cabinet object describes the parts of a pinball cabinet (toys, outputcontrollers, outputs and more). More...

Public Member Functions

void AutoConfig ()
 This method finds all classes implementing the IAutoConfigOutputController interface and uses the member of this interface to detect and configure IOutputController objects automatically. More...
 
string GetConfigXml ()
 Returns a serialized XML representation of the cabinet configuration. More...
 
void SaveConfigXmlFile (string FileName)
 Serializes the cabinet configuration to a XML file. More...
 
void Init (Pinball Pinball)
 Initializes the cabinet. More...
 
void Update ()
 Calls the update method for toys and output controllers in the cabinet More...
 
void Finish ()
 Finishes the cabinet More...
 
 Cabinet ()
 Initializes a new instance of the Cabinet class. More...
 

Static Public Member Functions

static Cabinet GetCabinetFromConfigXmlFile (string FileName)
 Instanciates a Cabinet object from a cabinet configuration in a XML file. More...
 
static bool TestCabinetConfigXmlFile (string FileName)
 Tests a cabinet config in a XML file. More...
 
static Cabinet GetCabinetFromConfigXmlFile (FileInfo CabinetConfigFile)
 Instanciates a Cabinet object from a cabinet configuration in a XML file. More...
 
static Cabinet GetCabinetFromConfigXml (string ConfigXml)
 Instanciates a Cabinet object from a cabinet configuration in a XML string. More...
 

Properties

Pinball Pinball [get, set]
 Gets the Pinball object to which the Cabinet pobject belongs. More...
 
string Name [get, set]
 Name of the Cabinet. More...
 
string CabinetConfigurationFilename [get, set]
 Gets or sets the filename from which the cabiet configuration was loaded. More...
 
DirectOutput.Cab.Toys.ToyList Toys [get, set]
 List of IToy objects describing the toys in the cabinet. More...
 
ColorList Colors [get, set]
 List of Color objects used to set colors for toys. More...
 
CurveList Curves [get, set]
 List of named curve objects used to set Curves for toys. More...
 
bool AutoConfigEnabled [get, set]
 Gets or sets a value indicating whether auto config is enabled.
If auto config is enabled, the framework tries to detect and configure IOutputController objects and related IToy objects automatically. More...
 
CabinetOutputList Outputs [get]
 List of IOutput objects representing all outputs of all all output controllers in the cabinet. More...
 
Out.OutputControllerList OutputControllers [get, set]
 List of IOutputController objects representing the output controllers in the cabinet. More...
 

Detailed Description

The Cabinet object describes the parts of a pinball cabinet (toys, outputcontrollers, outputs and more).

Constructor & Destructor Documentation

DirectOutput.Cab.Cabinet.Cabinet ( )

Initializes a new instance of the Cabinet class.

Member Function Documentation

void DirectOutput.Cab.Cabinet.AutoConfig ( )

This method finds all classes implementing the IAutoConfigOutputController interface and uses the member of this interface to detect and configure IOutputController objects automatically.

void DirectOutput.Cab.Cabinet.Finish ( )

Finishes the cabinet

static Cabinet DirectOutput.Cab.Cabinet.GetCabinetFromConfigXml ( string  ConfigXml)
static

Instanciates a Cabinet object from a cabinet configuration in a XML string.

Parameters
ConfigXmlXML string
Returns
Cabinet object
static Cabinet DirectOutput.Cab.Cabinet.GetCabinetFromConfigXmlFile ( string  FileName)
static

Instanciates a Cabinet object from a cabinet configuration in a XML file.

Parameters
FileNameName of the XML file.
Returns
Cabinet object
static Cabinet DirectOutput.Cab.Cabinet.GetCabinetFromConfigXmlFile ( FileInfo  CabinetConfigFile)
static

Instanciates a Cabinet object from a cabinet configuration in a XML file.

Parameters
CabinetConfigFileFileInfo object for the config file.
Returns
Cabinet object
string DirectOutput.Cab.Cabinet.GetConfigXml ( )

Returns a serialized XML representation of the cabinet configuration.

Returns
XMLString
void DirectOutput.Cab.Cabinet.Init ( Pinball  Pinball)

Initializes the cabinet.

Parameters
PinballThe Pinball object using the Cabinet instance.
void DirectOutput.Cab.Cabinet.SaveConfigXmlFile ( string  FileName)

Serializes the cabinet configuration to a XML file.

Parameters
FileNameName of the XML file.
static bool DirectOutput.Cab.Cabinet.TestCabinetConfigXmlFile ( string  FileName)
static

Tests a cabinet config in a XML file.

Parameters
FileNameName of the file.
Returns
true is the file contains a valid config, otherwise false.
void DirectOutput.Cab.Cabinet.Update ( )

Calls the update method for toys and output controllers in the cabinet

Property Documentation

bool DirectOutput.Cab.Cabinet.AutoConfigEnabled
getset

Gets or sets a value indicating whether auto config is enabled.
If auto config is enabled, the framework tries to detect and configure IOutputController objects and related IToy objects automatically.

true enables auto config, false disables auto config.

string DirectOutput.Cab.Cabinet.CabinetConfigurationFilename
getset

Gets or sets the filename from which the cabiet configuration was loaded.

The filename of the cabinet configuration file.

ColorList DirectOutput.Cab.Cabinet.Colors
getset

List of Color objects used to set colors for toys.

CurveList DirectOutput.Cab.Cabinet.Curves
getset

List of named curve objects used to set Curves for toys.

string DirectOutput.Cab.Cabinet.Name
getset

Name of the Cabinet.

Out.OutputControllerList DirectOutput.Cab.Cabinet.OutputControllers
getset

List of IOutputController objects representing the output controllers in the cabinet.

CabinetOutputList DirectOutput.Cab.Cabinet.Outputs
get

List of IOutput objects representing all outputs of all all output controllers in the cabinet.

Pinball DirectOutput.Cab.Cabinet.Pinball
getset

Gets the Pinball object to which the Cabinet pobject belongs.

The pinball object.

DirectOutput.Cab.Toys.ToyList DirectOutput.Cab.Cabinet.Toys
getset

List of IToy objects describing the toys in the cabinet.


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