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

Common interface for all outputcontrollers. Only classes implementing this interface can be used as output controllers in the framework.
The abstract OutputControllerBase class implements this interface and can be inherited for other output controller classes.
It is important to ensure that all classes inherting this interface are XML serializeable. More...

Inheritance diagram for DirectOutput.Cab.Out.IOutputController:
Collaboration diagram for DirectOutput.Cab.Out.IOutputController:

Public Member Functions

void Init (Cabinet Cabinet)
 Must initialize the IOutputController. Is called after the objects have been instanciated. More...
 
void Finish ()
 Must finish the IOutputController and do all necessary cleanup task. Must turn off the physical outputs of the IOutputController. More...
 
void Update ()
 Must update resp. thrigger the update of the physical outputs of the IOutputController.
More...
 

Properties

new string Name [get, set]
 Name of the IOutputController. This property is fully implemented in the abstract OutputControllerBase class. More...
 
OutputList Outputs [get, set]
 OutputList containing the IOutput objects for a IOutputController. More...
 
- Properties inherited from DirectOutput.General.Generic.INamedItem
string Name [get, set]
 Gets or sets the name of the item.
Must fire the BeforeNameChange and AfterNameChange events when the value of the property is changed. More...
 

Additional Inherited Members

- Events inherited from DirectOutput.General.Generic.INamedItem
EventHandler< NameChangeEventArgsBeforeNameChange
 Occurs before the name of the item changes. More...
 
EventHandler< NameChangeEventArgsAfterNameChanged
 Occurs when after the name of the item has changed. More...
 

Detailed Description

Common interface for all outputcontrollers. Only classes implementing this interface can be used as output controllers in the framework.
The abstract OutputControllerBase class implements this interface and can be inherited for other output controller classes.
It is important to ensure that all classes inherting this interface are XML serializeable.

Member Function Documentation

void DirectOutput.Cab.Out.IOutputController.Update ( )

Must update resp. thrigger the update of the physical outputs of the IOutputController.

Remarks
Since communication with external components can be slow, it is a good practice to send the actual updates from a separate thread and to use this method only to notify the updater thread that data has to be sent.

Implemented in DirectOutput.Cab.Out.AdressableLedStrip.WS2811StripController, DirectOutput.Cab.Out.DMX.ArtNet, DirectOutput.Cab.Out.OutputControllerBase, DirectOutput.Cab.Out.LW.LedWiz, DirectOutput.Cab.Out.Pac.PacLed64, DirectOutput.Cab.Out.FTDIChip.FT245RBitbangController, DirectOutput.Cab.Out.NullOutputController.NullOutputController, and DirectOutput.Cab.Out.Pac.PacDrive.

Property Documentation

new string DirectOutput.Cab.Out.IOutputController.Name
getset

Name of the IOutputController. This property is fully implemented in the abstract OutputControllerBase class.

The name of the output controller.

OutputList DirectOutput.Cab.Out.IOutputController.Outputs
getset

OutputList containing the IOutput objects for a IOutputController.


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