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 (ICabinetOwner CabinetOwner)
	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
ICabinetOwner	Owner `[get, set]`
	Gets or sets the owner or the cabinet. More...

AlarmHandler	Alarms `[get]`
	Gets the AlarmHandler object for the cabinet object. 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).

Definition at line 17 of file Cabinet.cs.

Constructor & Destructor Documentation

DirectOutput.Cab.Cabinet.Cabinet ( )

Initializes a new instance of the Cabinet class.

Definition at line 342 of file Cabinet.cs.

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.

Definition at line 22 of file Cabinet.cs.

void DirectOutput.Cab.Cabinet.Finish ( )

Finishes the cabinet

Definition at line 327 of file Cabinet.cs.

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

static

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

Parameters

ConfigXml XML string

Returns: Cabinet object

Definition at line 276 of file Cabinet.cs.

static Cabinet DirectOutput.Cab.Cabinet.GetCabinetFromConfigXmlFile ( string FileName )

static

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

Parameters

FileName Name of the XML file.

Returns: Cabinet object

Definition at line 224 of file Cabinet.cs.

static Cabinet DirectOutput.Cab.Cabinet.GetCabinetFromConfigXmlFile ( FileInfo CabinetConfigFile )

static

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

Parameters

CabinetConfigFile FileInfo object for the config file.

Returns: Cabinet object

Definition at line 266 of file Cabinet.cs.

string DirectOutput.Cab.Cabinet.GetConfigXml ( )

Returns a serialized XML representation of the cabinet configuration.

Returns: XMLString

Definition at line 191 of file Cabinet.cs.

void DirectOutput.Cab.Cabinet.Init ( ICabinetOwner CabinetOwner )

Initializes the cabinet.

Parameters

Owner The ICabinetOwner object for the cabinet instance.

Definition at line 302 of file Cabinet.cs.

void DirectOutput.Cab.Cabinet.SaveConfigXmlFile ( string FileName )

Serializes the cabinet configuration to a XML file.

Parameters

FileName Name of the XML file.

Definition at line 213 of file Cabinet.cs.

static bool DirectOutput.Cab.Cabinet.TestCabinetConfigXmlFile ( string FileName )

static

Tests a cabinet config in a XML file.

Parameters

FileName Name of the file.

Returns: true is the file contains a valid config, otherwise false.

Definition at line 246 of file Cabinet.cs.

void DirectOutput.Cab.Cabinet.Update ( )

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

Definition at line 316 of file Cabinet.cs.

Property Documentation

AlarmHandler DirectOutput.Cab.Cabinet.Alarms

get

Gets the AlarmHandler object for the cabinet object.

The AlarmHandler object for the cabinet object.

Definition at line 80 of file Cabinet.cs.

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.

Definition at line 152 of file Cabinet.cs.

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.

Definition at line 98 of file Cabinet.cs.

ColorList DirectOutput.Cab.Cabinet.Colors

getset

List of Color objects used to set colors for toys.

Definition at line 125 of file Cabinet.cs.

CurveList DirectOutput.Cab.Cabinet.Curves

getset

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

Definition at line 137 of file Cabinet.cs.

string DirectOutput.Cab.Cabinet.Name

getset

Name of the Cabinet.

Definition at line 89 of file Cabinet.cs.

Out.OutputControllerList DirectOutput.Cab.Cabinet.OutputControllers

getset

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

Definition at line 179 of file Cabinet.cs.

CabinetOutputList DirectOutput.Cab.Cabinet.Outputs

get

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

Definition at line 164 of file Cabinet.cs.

ICabinetOwner DirectOutput.Cab.Cabinet.Owner

getset

Gets or sets the owner or the cabinet.

The owner of the cabinet.

Definition at line 67 of file Cabinet.cs.

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

getset

List of IToy objects describing the toys in the cabinet.

Definition at line 107 of file Cabinet.cs.

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

C:/Users/tom/Documents/Github/DirectOutput/DirectOutput/Cab/Cabinet.cs

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation