com.qualcomm.robotcore.hardware.configuration.typecontainers

Class UserConfigurationType

java.lang.Object

com.qualcomm.robotcore.hardware.configuration.typecontainers.UserConfigurationType

All Implemented Interfaces:

ConfigurationType, java.io.Serializable

Direct Known Subclasses:

InstantiableUserConfigurationType, MotorConfigurationType

public abstract class UserConfigurationType
extends java.lang.Object
implements ConfigurationType, java.io.Serializable

UserConfigurationType contains metadata regarding classes which have been declared as user-defined sensor implementations. Subclasses should be either abstract or final.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	UserConfigurationType.SerializationProxy

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

ConfigurationType.DeviceFlavor, ConfigurationType.DisplayNameFlavor

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	description
protected java.lang.String	name

Constructor Summary

Constructors

Modifier	Constructor and Description
	UserConfigurationType(java.lang.Class clazz, ConfigurationType.DeviceFlavor flavor, java.lang.String xmlTag)
protected	UserConfigurationType(ConfigurationType.DeviceFlavor flavor)

Method Summary

Modifier and Type	Method and Description
void	finishedAnnotations(java.lang.Class clazz)
java.lang.String	getDescription()
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	getName()
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	isBuiltIn() This is about whether the type "comes with" the SDK, not whether it lives in BuiltInConfigurationType
boolean	isCompatibleWith(ControlSystem controlSystem)
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
boolean	isOnBotJava()
void	processAnnotation(DeviceProperties deviceProperties)
DeviceManager.UsbDeviceType	toUSBDeviceType() If this configuration type has a corresponding USB device configuration type, returns same; otherwise, returns FTDI_USB_UNKNOWN_DEVICE.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

description

protected java.lang.String description

Constructor Detail

UserConfigurationType

public UserConfigurationType(java.lang.Class clazz,
                             ConfigurationType.DeviceFlavor flavor,
                             java.lang.String xmlTag)

UserConfigurationType

protected UserConfigurationType(ConfigurationType.DeviceFlavor flavor)

Method Detail

processAnnotation

public void processAnnotation(DeviceProperties deviceProperties)

finishedAnnotations

public void finishedAnnotations(java.lang.Class clazz)

isCompatibleWith

public boolean isCompatibleWith(ControlSystem controlSystem)

getDeviceFlavor

public ConfigurationType.DeviceFlavor getDeviceFlavor()

Description copied from interface: ConfigurationType

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.

Specified by:

getDeviceFlavor in interface ConfigurationType

getName

public java.lang.String getName()

getDescription

public java.lang.String getDescription()

isOnBotJava

public boolean isOnBotJava()

isBuiltIn

public boolean isBuiltIn()

This is about whether the type "comes with" the SDK, not whether it lives in BuiltInConfigurationType

getDisplayName

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

Description copied from interface: ConfigurationType

Returns a user-understandable string form of this configuration type

Specified by:

getDisplayName in interface ConfigurationType

Returns:

a user-understandable string form of this configuration type

getXmlTag

public java.lang.String getXmlTag()

Description copied from interface: ConfigurationType

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

Specified by:

getXmlTag in interface ConfigurationType

Returns:

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

getXmlTagAliases

public java.lang.String[] getXmlTagAliases()

Description copied from interface: ConfigurationType

Returns any additional XML tags that will resolve to this type

Specified by:

getXmlTagAliases in interface ConfigurationType

Returns:

the XML tag aliases

toUSBDeviceType

public DeviceManager.UsbDeviceType toUSBDeviceType()

Description copied from interface: ConfigurationType

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

Specified by:

toUSBDeviceType in interface ConfigurationType

Returns:

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

isDeviceFlavor

public boolean isDeviceFlavor(ConfigurationType.DeviceFlavor flavor)

Description copied from interface: ConfigurationType

Returns whether this configuration type is of the indicated flavor

Specified by:

isDeviceFlavor in interface ConfigurationType

Returns:

whether this configuration type is of the indicated flavor;

isDeprecated

public boolean isDeprecated()

Description copied from interface: ConfigurationType

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

Specified by:

isDeprecated in interface ConfigurationType