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:

Collaboration diagram for DirectOutput.Cab.CabinetOutputList:

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>.
bool	Contains (IOutput Output)
	Checks if the specified IOutput exists in the list.
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.
	CabinetOutputList (Cabinet Cabinet)
	Initializes a new instance of the CabinetOutputList class.

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.
IOutput	this[int Index] [get]
	Indexer for the list.
int	Count [get]
	Returns the number of outputs for all output controlers.

Detailed Description

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

Constructor & Destructor Documentation

CabinetOutputList()

DirectOutput.Cab.CabinetOutputList.CabinetOutputList

(

Cabinet

Cabinet

)

Initializes a new instance of the CabinetOutputList class.

Parameters

Cabinet

The cabinet to which the list belongs.

Member Function Documentation

Contains() [1/2]

bool DirectOutput.Cab.CabinetOutputList.Contains

(

IOutput

Output

)

Checks if the specified IOutput exists in the list.

Parameters

Output

Output to check.

Returns

true/false

Contains() [2/2]

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

Name	Name or path to check.

Returns

true if a IOputput with the given name or path exists, otherwiese false.

GetEnumerator()

IEnumerator< IOutput > DirectOutput.Cab.CabinetOutputList.GetEnumerator

(

)

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

Property Documentation

Count

int DirectOutput.Cab.CabinetOutputList.Count

get

Returns the number of outputs for all output controlers.

this[int Index]

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

get

Indexer for the list.

Parameters

Index

Index of the list item to return.

Returns

IOutput at the given index.

this[string Name]

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

Name	Name 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:

• D:/a/DirectOutput/DirectOutput/DirectOutput/Cab/CabinetOutputList.cs