com.qualcomm.robotcore.util

Interface GlobalWarningSource

All Known Subinterfaces:

LynxUsbDevice

All Known Implementing Classes:

LynxUsbDeviceDelegate, LynxUsbDeviceImpl

public interface GlobalWarningSource

Instances of this interface can be registered with RobotLog as dynamic generators of robot warning messages.

See Also:

RobotLog.registerGlobalWarningSource(GlobalWarningSource)

Method Summary

Modifier and Type	Method and Description
void	clearGlobalWarning() Clears any currently set warning (if permitted) for this source, and zeros the sources suppression count.
java.lang.String	getGlobalWarning() Returns the current warning associated with this warning source.
void	setGlobalWarning(java.lang.String warning) Sets the current warning associated with this warning source, if permitted to do so by the source.
void	suppressGlobalWarning(boolean suppress) Suppress or desupress the contributions of warnings by this source.

Method Detail

getGlobalWarning

java.lang.String getGlobalWarning()

Returns the current warning associated with this warning source. If the source currently has no warning to contribute, it should return an empty string.

Returns:

the current warning associated with this warning source

suppressGlobalWarning

void suppressGlobalWarning(boolean suppress)

Suppress or desupress the contributions of warnings by this source. If warnings are suppressed, getGlobalWarning() will always return an empty string. Internally, a supression count is maintained which is incremented if 'suppress' is true and decremented if it is false. The initial value of the count is zero; suppression is in effect if the count is greater than zero.

Parameters:

suppress - whether to suppress or desupress warnings associated with this source

See Also:

clearGlobalWarning()

setGlobalWarning

void setGlobalWarning(java.lang.String warning)

Sets the current warning associated with this warning source, if permitted to do so by the source. Sources may refuse for various reasons: perhaps they only ever produce their warnings from internal state, or perhaps they don't accept another warning if a first has already been set.

Parameters:

warning - the warning to be associated with this sources

See Also:

clearGlobalWarning()

clearGlobalWarning

void clearGlobalWarning()

Clears any currently set warning (if permitted) for this source, and zeros the sources suppression count.

See Also:

setGlobalWarning(String)