DirectOutput
DirectOutput framework R2 for virtual pinball cabinets.
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events Macros Pages
Classes | Public Member Functions | Properties | List of all members
DirectOutput.Cab.CabinetOutputList Class Reference

Readonly list containing all IOutput objects of all IOutputController objects in a cabinet. More...

Inheritance diagram for DirectOutput.Cab.CabinetOutputList:
Inheritance graph
[legend]
Collaboration diagram for DirectOutput.Cab.CabinetOutputList:
Collaboration graph
[legend]

Classes

class  Enumerator
 Enumerator class for IEnumerable<IOutput>. More...
 

Public Member Functions

IEnumerator< IOutput > GetEnumerator ()
 Returns the enumerator for this collection.
Required for the implementation of IEnumerable<IOutput>. More...
 
bool Contains (IOutput Output)
 Checks if the specified IOutput exists in the list. More...
 
bool Contains (string Name)
 Checks if a IOutput with a specific name exists in the list.
Instead of a name and path consisting of {OutputControllerName}\{OutputName} can be supplied. More...
 
 CabinetOutputList (Cabinet Cabinet)
 Initializes a new instance of the CabinetOutputList class. More...
 

Properties

IOutput this[string Name] [get]
 Indexer looks up the first IOutput with the specified name or path.
If several IOutput objects in the list are using the same name, only the first matching IOutput will be returned.
Instead of a name and path consisting of {OutputControllerName}\{OutputName} can be supplied. If no item matches the path, null will be returned. More...
 
IOutput this[int Index] [get]
 Indexer for the list. More...
 
int Count [get]
 Returns the number of outputs for all output controlers. More...
 

Detailed Description

Readonly list containing all IOutput objects of all IOutputController objects in a cabinet.

Constructor & Destructor Documentation

DirectOutput.Cab.CabinetOutputList.CabinetOutputList ( Cabinet  Cabinet)

Initializes a new instance of the CabinetOutputList class.

Parameters
CabinetThe cabinet to which the list belongs.

Member Function Documentation

bool DirectOutput.Cab.CabinetOutputList.Contains ( IOutput  Output)

Checks if the specified IOutput exists in the list.

Parameters
OutputOutput to check.
Returns
true/false
bool DirectOutput.Cab.CabinetOutputList.Contains ( string  Name)

Checks if a IOutput with a specific name exists in the list.
Instead of a name and path consisting of {OutputControllerName}\{OutputName} can be supplied.

Parameters
NameName or path to check.
Returns
true if a IOputput with the given name or path exists, otherwiese false.
IEnumerator<IOutput> DirectOutput.Cab.CabinetOutputList.GetEnumerator ( )

Returns the enumerator for this collection.
Required for the implementation of IEnumerable<IOutput>.

Property Documentation

int DirectOutput.Cab.CabinetOutputList.Count
get

Returns the number of outputs for all output controlers.

IOutput DirectOutput.Cab.CabinetOutputList.this[int Index]
get

Indexer for the list.

Parameters
IndexIndex of the list item to return.
Returns
IOutput at the given index.
IOutput DirectOutput.Cab.CabinetOutputList.this[string Name]
get

Indexer looks up the first IOutput with the specified name or path.
If several IOutput objects in the list are using the same name, only the first matching IOutput will be returned.
Instead of a name and path consisting of {OutputControllerName}\{OutputName} can be supplied. If no item matches the path, null will be returned.

Parameters
NameName of the IOutput to look up.
Returns
IOutput object if a match is found, null otherwise.
The documentation for this class was generated from the following file: