com.qualcomm.hardware.lynx

Class LynxUsbDeviceDelegate

java.lang.Object

com.qualcomm.hardware.lynx.LynxUsbDeviceDelegate

All Implemented Interfaces:

LynxUsbDevice, Engagable, HardwareDevice, HardwareDeviceCloseOnTearDown, RobotCoreLynxUsbDevice, RobotArmingStateNotifier, RobotUsbModule, GlobalWarningSource

public class LynxUsbDeviceDelegate
extends java.lang.Object
implements LynxUsbDevice, HardwareDeviceCloseOnTearDown

This delegation class simply forwards calls on, with the single exception that it turns a local close into a delegated reference count.

Nested Class Summary

Nested classes/interfaces inherited from interface com.qualcomm.robotcore.hardware.usb.RobotArmingStateNotifier

RobotArmingStateNotifier.ARMINGSTATE, RobotArmingStateNotifier.Callback

Nested classes/interfaces inherited from interface com.qualcomm.robotcore.hardware.HardwareDevice

HardwareDevice.Manufacturer

Field Summary

Fields

Modifier and Type	Field and Description
protected LynxUsbDeviceImpl	delegate
protected boolean	isOpen
protected boolean	releaseOnClose
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
LynxUsbDeviceDelegate(LynxUsbDeviceImpl lynxUsbDevice)

Method Summary

Modifier and Type	Method and Description
void	acquireNetworkTransmissionLock(LynxMessage message)
void	addConfiguredModule(LynxModule module)
void	arm() Causes the module to attempt to enter the armed state.
void	armOrPretend() Causes the module to attempt to enter the armed state, but if that is not possible, to enter the pretending state.
protected void	assertOpen()
void	changeModuleAddress(LynxModule module, int newAddress, java.lang.Runnable runnable)
void	clearGlobalWarning() Clears any currently set warning (if permitted) for this source, and zeros the sources suppression count.
void	close() Causes the module to attempt to enter the closed state.
void	disarm() Causes the module to attempt to enter the disarmed state.
LynxModuleMetaList	discoverModules()
void	disengage() Disengage the object from underlying services it uses to render its function.
void	engage() (Re)enage the object with its underlying services.
void	failSafe()
RobotArmingStateNotifier.ARMINGSTATE	getArmingState() Returns the current arming state of the object.
LynxModule	getConfiguredModule(int moduleAddress)
java.lang.String	getConnectionInfo() Get connection information about this device in a human readable format
LynxUsbDeviceImpl	getDelegationTarget()
java.lang.String	getDeviceName() Returns a string suitable for display to the user as to the type of device.
java.lang.String	getGlobalWarning() Returns the current warning associated with this warning source.
HardwareDevice.Manufacturer	getManufacturer() Returns an indication of the manufacturer of this device.
RobotUsbModule	getOwner()
RobotUsbDevice	getRobotUsbDevice()
SerialNumber	getSerialNumber() Returns the serial number of this USB module
ShutdownReason	getShutdownReason()
int	getVersion() Version
boolean	isEngaged() Returns whether the object is currently in the engaged state.
boolean	isSystemSynthetic()
void	lockNetworkLockAcquisitions()
void	noteMissingModule(LynxModule module, java.lang.String moduleName)
void	pretend() Causes the module to attempt to enter the pretending state.
void	registerCallback(RobotArmingStateNotifier.Callback callback, boolean doInitialCallback) Registers a callback for arming state notifications from this module.
void	releaseNetworkTransmissionLock(LynxMessage message)
void	removeConfiguredModule(LynxModule module)
void	resetDeviceConfigurationForOpMode() Resets the device's configuration to that which is expected at the beginning of an OpMode.
boolean	setControlHubModuleAddressIfNecessary()
void	setGlobalWarning(java.lang.String warning) Sets the current warning associated with this warning source, if permitted to do so by the source.
void	setOwner(RobotUsbModule owner)
void	setSystemSynthetic(boolean systemSynthetic)
void	setThrowOnNetworkLockAcquisition(boolean shouldThrow)
void	suppressGlobalWarning(boolean suppress) Suppress or desupress the contributions of warnings by this source.
void	transmit(LynxMessage message)
void	unregisterCallback(RobotArmingStateNotifier.Callback callback) Unregister a callback which has been registered for notifications with this module.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAG

public static java.lang.String TAG

delegate

protected LynxUsbDeviceImpl delegate

releaseOnClose

protected boolean releaseOnClose

isOpen

protected boolean isOpen

Constructor Detail

LynxUsbDeviceDelegate

public LynxUsbDeviceDelegate(LynxUsbDeviceImpl lynxUsbDevice)

Method Detail

getDelegationTarget

public LynxUsbDeviceImpl getDelegationTarget()

Specified by:

getDelegationTarget in interface LynxUsbDevice

close

public void close()

Description copied from interface: RobotUsbModule

Causes the module to attempt to enter the closed state. If the module is already closed, this method has no effect.

Specified by:

close in interface HardwareDevice

Specified by:

close in interface HardwareDeviceCloseOnTearDown

Specified by:

close in interface RobotCoreLynxUsbDevice

Specified by:

close in interface RobotUsbModule

See Also:

RobotUsbModule

assertOpen

protected void assertOpen()

disengage

public void disengage()

Description copied from interface: Engagable

Disengage the object from underlying services it uses to render its function. If the object is presently disenaged, this method has no effect.

Specified by:

disengage in interface Engagable

engage

public void engage()

Description copied from interface: Engagable

(Re)enage the object with its underlying services. If the object is presently engaged, this method has no effect.

Specified by:

engage in interface Engagable

isEngaged

public boolean isEngaged()

Description copied from interface: Engagable

Returns whether the object is currently in the engaged state.

Specified by:

isEngaged in interface Engagable

Returns:

whether the object is currently in the engaged state.

getRobotUsbDevice

public RobotUsbDevice getRobotUsbDevice()

Specified by:

getRobotUsbDevice in interface LynxUsbDevice

isSystemSynthetic

public boolean isSystemSynthetic()

Specified by:

isSystemSynthetic in interface LynxUsbDevice

setSystemSynthetic

public void setSystemSynthetic(boolean systemSynthetic)

Specified by:

setSystemSynthetic in interface LynxUsbDevice

failSafe

public void failSafe()

Specified by:

failSafe in interface LynxUsbDevice

Specified by:

failSafe in interface RobotCoreLynxUsbDevice

lockNetworkLockAcquisitions

public void lockNetworkLockAcquisitions()

Specified by:

lockNetworkLockAcquisitions in interface RobotCoreLynxUsbDevice

setThrowOnNetworkLockAcquisition

public void setThrowOnNetworkLockAcquisition(boolean shouldThrow)

Specified by:

setThrowOnNetworkLockAcquisition in interface RobotCoreLynxUsbDevice

changeModuleAddress

public void changeModuleAddress(LynxModule module,
                                int newAddress,
                                java.lang.Runnable runnable)

Specified by:

changeModuleAddress in interface LynxUsbDevice

noteMissingModule

public void noteMissingModule(LynxModule module,
                              java.lang.String moduleName)

Specified by:

noteMissingModule in interface LynxUsbDevice

addConfiguredModule

public void addConfiguredModule(LynxModule module)
                         throws RobotCoreException,
                                java.lang.InterruptedException,
                                LynxNackException

Specified by:

addConfiguredModule in interface LynxUsbDevice

Throws:

RobotCoreException

java.lang.InterruptedException

LynxNackException

getConfiguredModule

public LynxModule getConfiguredModule(int moduleAddress)

Specified by:

getConfiguredModule in interface LynxUsbDevice

removeConfiguredModule

public void removeConfiguredModule(LynxModule module)

Specified by:

removeConfiguredModule in interface LynxUsbDevice

discoverModules

public LynxModuleMetaList discoverModules()
                                   throws RobotCoreException,
                                          java.lang.InterruptedException

Specified by:

discoverModules in interface LynxUsbDevice

Specified by:

discoverModules in interface RobotCoreLynxUsbDevice

Throws:

RobotCoreException

java.lang.InterruptedException

acquireNetworkTransmissionLock

public void acquireNetworkTransmissionLock(LynxMessage message)
                                    throws java.lang.InterruptedException

Specified by:

acquireNetworkTransmissionLock in interface LynxUsbDevice

Throws:

java.lang.InterruptedException

releaseNetworkTransmissionLock

public void releaseNetworkTransmissionLock(LynxMessage message)
                                    throws java.lang.InterruptedException

Specified by:

releaseNetworkTransmissionLock in interface LynxUsbDevice

Throws:

java.lang.InterruptedException

transmit

public void transmit(LynxMessage message)
              throws java.lang.InterruptedException

Specified by:

transmit in interface LynxUsbDevice

Throws:

java.lang.InterruptedException

setControlHubModuleAddressIfNecessary

public boolean setControlHubModuleAddressIfNecessary()
                                              throws RobotCoreException,
                                                     java.lang.InterruptedException

Specified by:

setControlHubModuleAddressIfNecessary in interface LynxUsbDevice

Throws:

RobotCoreException

java.lang.InterruptedException

getDeviceName

public java.lang.String getDeviceName()

Description copied from interface: HardwareDevice

Returns a string suitable for display to the user as to the type of device. Note that this is a device-type-specific name; it has nothing to do with the name by which a user might have configured the device in a robot configuration.

Specified by:

getDeviceName in interface HardwareDevice

Returns:

device manufacturer and name

getConnectionInfo

public java.lang.String getConnectionInfo()

Description copied from interface: HardwareDevice

Get connection information about this device in a human readable format

Specified by:

getConnectionInfo in interface HardwareDevice

Returns:

connection info

getVersion

public int getVersion()

Description copied from interface: HardwareDevice

Version

Specified by:

getVersion in interface HardwareDevice

Returns:

get the version of this device

getManufacturer

public HardwareDevice.Manufacturer getManufacturer()

Description copied from interface: HardwareDevice

Returns an indication of the manufacturer of this device.

Specified by:

getManufacturer in interface HardwareDevice

Returns:

the device's manufacturer

resetDeviceConfigurationForOpMode

public void resetDeviceConfigurationForOpMode()

Description copied from interface: HardwareDevice

Resets the device's configuration to that which is expected at the beginning of an OpMode. For example, motors will reset the their direction to 'forward'.

Specified by:

resetDeviceConfigurationForOpMode in interface HardwareDevice

getShutdownReason

public ShutdownReason getShutdownReason()

setOwner

public void setOwner(RobotUsbModule owner)

getOwner

public RobotUsbModule getOwner()

getSerialNumber

public SerialNumber getSerialNumber()

Description copied from interface: RobotArmingStateNotifier

Returns the serial number of this USB module

Specified by:

getSerialNumber in interface RobotArmingStateNotifier

Returns:

the serial number of this USB module

getArmingState

public RobotArmingStateNotifier.ARMINGSTATE getArmingState()

Description copied from interface: RobotArmingStateNotifier

Returns the current arming state of the object.

Specified by:

getArmingState in interface RobotArmingStateNotifier

Returns:

the current arming state of the object

registerCallback

public void registerCallback(RobotArmingStateNotifier.Callback callback,
                             boolean doInitialCallback)

Description copied from interface: RobotArmingStateNotifier

Registers a callback for arming state notifications from this module. If this callback is already registered for notifications from this module, this method has no effect. Note that multiple callbacks may be simultaneously registered with a given one module: they all receive state-change notifications, in an arbitrary order.

Specified by:

registerCallback in interface RobotArmingStateNotifier

See Also:

RobotArmingStateNotifier.unregisterCallback(Callback)

unregisterCallback

public void unregisterCallback(RobotArmingStateNotifier.Callback callback)

Description copied from interface: RobotArmingStateNotifier

Unregister a callback which has been registered for notifications with this module. If the callback was not previously registered, this method has no effect.

Specified by:

unregisterCallback in interface RobotArmingStateNotifier

See Also:

RobotArmingStateNotifier.registerCallback(Callback, boolean)

arm

public void arm()
         throws RobotCoreException,
                java.lang.InterruptedException

Description copied from interface: RobotUsbModule

Causes the module to attempt to enter the armed state. If the module is already armed, this method has no effect.

Specified by:

arm in interface RobotUsbModule

Throws:

RobotCoreException

java.lang.InterruptedException

See Also:

RobotUsbModule

pretend

public void pretend()
             throws RobotCoreException,
                    java.lang.InterruptedException

Description copied from interface: RobotUsbModule

Causes the module to attempt to enter the pretending state. If the module is already pretending, this method has no effect.

Specified by:

pretend in interface RobotUsbModule

Throws:

RobotCoreException

java.lang.InterruptedException

See Also:

RobotUsbModule

armOrPretend

public void armOrPretend()
                  throws RobotCoreException,
                         java.lang.InterruptedException

Description copied from interface: RobotUsbModule

Causes the module to attempt to enter the armed state, but if that is not possible, to enter the pretending state.

Specified by:

armOrPretend in interface RobotUsbModule

Throws:

RobotCoreException

java.lang.InterruptedException

See Also:

RobotUsbModule

disarm

public void disarm()
            throws RobotCoreException,
                   java.lang.InterruptedException

Description copied from interface: RobotUsbModule

Causes the module to attempt to enter the disarmed state. If the module is already disarmed, this method has no effect.

Specified by:

disarm in interface RobotUsbModule

Throws:

RobotCoreException

java.lang.InterruptedException

See Also:

RobotUsbModule

getGlobalWarning

public java.lang.String getGlobalWarning()

Description copied from interface: GlobalWarningSource

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

Specified by:

getGlobalWarning in interface GlobalWarningSource

Returns:

the current warning associated with this warning source

suppressGlobalWarning

public void suppressGlobalWarning(boolean suppress)

Description copied from interface: GlobalWarningSource

Suppress or desupress the contributions of warnings by this source. If warnings are suppressed, GlobalWarningSource.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.

Specified by:

suppressGlobalWarning in interface GlobalWarningSource

Parameters:

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

See Also:

GlobalWarningSource.clearGlobalWarning()

setGlobalWarning

public void setGlobalWarning(java.lang.String warning)

Description copied from interface: GlobalWarningSource

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.

Specified by:

setGlobalWarning in interface GlobalWarningSource

Parameters:

warning - the warning to be associated with this sources

See Also:

GlobalWarningSource.clearGlobalWarning()

clearGlobalWarning

public void clearGlobalWarning()

Description copied from interface: GlobalWarningSource

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

Specified by:

clearGlobalWarning in interface GlobalWarningSource

See Also:

GlobalWarningSource.setGlobalWarning(String)