com.qualcomm.robotcore.hardware.configuration

Interface ConfigurationType

All Known Implementing Classes:

AnalogSensorConfigurationType, BuiltInConfigurationType, DigitalIoDeviceConfigurationType, I2cDeviceConfigurationType, InstantiableUserConfigurationType, MotorConfigurationType, ServoConfigurationType, UserConfigurationType

public interface ConfigurationType

ConfigurationType instances represent the type of various kinds of hardware device configurations that might exist within the SDK.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ConfigurationType.DeviceFlavor
static class	ConfigurationType.DisplayNameFlavor

Method Summary

Modifier and Type	Method and Description
ConfigurationType.DeviceFlavor	getDeviceFlavor() Returns the configuration type's most specific flavor.
java.lang.String	getDisplayName(ConfigurationType.DisplayNameFlavor flavor) Returns a user-understandable string form of this configuration type
java.lang.String	getXmlTag() Returns the XML element tag to be used when serializing configurations of this type
java.lang.String[]	getXmlTagAliases() Returns any additional XML tags that will resolve to this type
boolean	isDeprecated() Whether the type should be presented as deprecated in the user interface
boolean	isDeviceFlavor(ConfigurationType.DeviceFlavor flavor) Returns whether this configuration type is of the indicated flavor
DeviceManager.UsbDeviceType	toUSBDeviceType() If this configuration type has a corresponding USB device configuration type, returns same; otherwise, returns FTDI_USB_UNKNOWN_DEVICE.

Method Detail

getDisplayName

java.lang.String getDisplayName(ConfigurationType.DisplayNameFlavor flavor)

Returns a user-understandable string form of this configuration type

Returns:

a user-understandable string form of this configuration type

isDeprecated

boolean isDeprecated()

Whether the type should be presented as deprecated in the user interface

getXmlTag

java.lang.String getXmlTag()

Returns the XML element tag to be used when serializing configurations of this type

Returns:

the XML element tag to be used when serializing configurations of this type

getXmlTagAliases

java.lang.String[] getXmlTagAliases()

Returns any additional XML tags that will resolve to this type

Returns:

the XML tag aliases

toUSBDeviceType

DeviceManager.UsbDeviceType toUSBDeviceType()

If this configuration type has a corresponding USB device configuration type, returns same; otherwise, returns FTDI_USB_UNKNOWN_DEVICE.

Returns:

the USB device type that corresponds to this configuration type, if any

isDeviceFlavor

boolean isDeviceFlavor(ConfigurationType.DeviceFlavor flavor)

Returns whether this configuration type is of the indicated flavor

Returns:

whether this configuration type is of the indicated flavor;

getDeviceFlavor

ConfigurationType.DeviceFlavor getDeviceFlavor()

Returns the configuration type's most specific flavor. Types defined in BuiltInConfigurationType will only return DeviceFlavor.BUILT_IN if none of the other types apply. If you need to know if this type is defined in the BuiltInConfigurationType enum, use isDeviceFlavor(BUILT_IN). For BuiltInConfigurationType instances that are defined both as a legacy device and as a modern device, this will assume you're asking about the modern variant.