|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.ocap.hardware.frontpanel.FrontPanelManager
public class FrontPanelManager
This class represents an optional front panel display and SHOULD not be present in any device that does not support one. A front panel may include a text based display with one or more rows of characters. This API is agnostic as to the type of hardware used in the display (e.g. segmented LED, LCD). The display may also contain individual indicators for status indication such as power.
Method Summary | |
---|---|
IndicatorDisplay |
getIndicatorDisplay(String[] indicators)
Gets the individual indicators display. |
static FrontPanelManager |
getInstance()
Gets the singleton instance of the front panel manager. |
String[] |
getSupportedIndicators()
Gets the set of available indicators. |
TextDisplay |
getTextDisplay()
Gets the front panel text display. |
void |
releaseIndicator(String indicator)
Releases a front panel indicator from a previous reservation. |
void |
releaseTextDisplay()
Releases the front panel text display from a previous reservation. |
boolean |
reserveIndicator(ResourceClient resourceClient,
String indicator)
Reserves one of the indicators for exclusive use by an application. |
boolean |
reserveTextDisplay(ResourceClient resourceClient)
Reserves the front panel text display for exclusive use by an application. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static FrontPanelManager getInstance()
SecurityException
- if the calling application does not have
MonitorAppPermission("frontpanel").public boolean reserveTextDisplay(ResourceClient resourceClient)
resourceClient
- A DAVIC resource client for resource control.
public boolean reserveIndicator(ResourceClient resourceClient, String indicator) throws IllegalArgumentException
resourceClient
- A DAVIC resource client for resource control.indicator
- One of the indicator String names found in the
table returned by IndicatorDisplay.getIndicators()
method.
IllegalArgumentException
- if indicator does not equal one of
the indicator names.public void releaseTextDisplay()
public void releaseIndicator(String indicator) throws IllegalArgumentException
IllegalArgumentException
- if the indicator argument is not
contained in the table returned by the
IndicatorDisplay.getIndicators()
method.public TextDisplay getTextDisplay()
public String[] getSupportedIndicators()
getIndicatorDisplay(String[])
. The set of standardized indicators
includes "power", "rfbypass", "message", and "record" and these MAY be
returned.
public IndicatorDisplay getIndicatorDisplay(String[] indicators)
indicators
- Set of indicator names.
IllegalArgumentException
- if any of the indicator arguments are
not contained in the table returned by the
IndicatorDisplay.getIndicators()
method.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |