com.qualcomm.ftccommon.configuration

Class RobotConfigMap

java.lang.Object

com.qualcomm.ftccommon.configuration.RobotConfigMap

All Implemented Interfaces:

java.io.Serializable

public class RobotConfigMap
extends java.lang.Object
implements java.io.Serializable

RobotConfigMap represents the loaded and parsed state of an XML robot configuration. It contains the set of ControllerConfigurations in the configuration, accessible by serial number.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RobotConfigMap()
RobotConfigMap(java.util.Collection<ControllerConfiguration> controllerConfigurations)
RobotConfigMap(java.util.Map<SerialNumber,ControllerConfiguration> map)
RobotConfigMap(RobotConfigMap him)

Method Summary

Modifier and Type	Method and Description
void	bindUnboundControllers(ScannedDevices scannedDevices) For each controller in this map that currently lacks a real serial number, try to choose an unused selection from the scanned devices to associate with same.
boolean	contains(SerialNumber serialNumber)
protected boolean	containsSerialNumber(java.util.List<ControllerConfiguration> list, SerialNumber serialNumber)
java.util.Collection<ControllerConfiguration>	controllerConfigurations()
protected java.lang.String	generateName(Context context, ConfigurationType type, java.util.List<ControllerConfiguration> resultSoFar) Generates a name that's unique across both this whole configuration and the candidate swaps that have been produced so far.
ControllerConfiguration	get(SerialNumber serialNumber)
java.util.List<ControllerConfiguration>	getEligibleSwapTargets(ControllerConfiguration target, ScannedDevices scannedDevices, Context context) Returns a list of the candidate configurations with which the target may be swapped.
boolean	isSwappable(ControllerConfiguration target, ScannedDevices scannedDevices, Context context)
protected boolean	nameExists(java.lang.String name, java.util.List<ControllerConfiguration> resultSoFar)
void	put(SerialNumber serialNumber, ControllerConfiguration controllerConfiguration)
boolean	remove(SerialNumber serialNumber)
java.util.Collection<SerialNumber>	serialNumbers()
void	setSerialNumber(ControllerConfiguration controllerConfiguration, SerialNumber serialNumber) Changes a serial number of a controller known to be in this configuration
int	size()
void	swapSerialNumbers(ControllerConfiguration a, ControllerConfiguration b) Swaps the serial numbers (and attachment status) of two controllers both known to be in this configuration
void	writeToLog(java.lang.String tag, java.lang.String message)
void	writeToLog(java.lang.String tag, java.lang.String message, ControllerConfiguration controllerConfiguration)

Methods inherited from class java.lang.Object

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

Constructor Detail

RobotConfigMap

public RobotConfigMap(java.util.Collection<ControllerConfiguration> controllerConfigurations)

RobotConfigMap

public RobotConfigMap(java.util.Map<SerialNumber,ControllerConfiguration> map)

RobotConfigMap

public RobotConfigMap(RobotConfigMap him)

RobotConfigMap

public RobotConfigMap()

Method Detail

contains

public boolean contains(SerialNumber serialNumber)

get

public ControllerConfiguration get(SerialNumber serialNumber)

put

public void put(SerialNumber serialNumber,
                ControllerConfiguration controllerConfiguration)

remove

public boolean remove(SerialNumber serialNumber)

size

public int size()

serialNumbers

public java.util.Collection<SerialNumber> serialNumbers()

controllerConfigurations

public java.util.Collection<ControllerConfiguration> controllerConfigurations()

writeToLog

public void writeToLog(java.lang.String tag,
                       java.lang.String message)

writeToLog

public void writeToLog(java.lang.String tag,
                       java.lang.String message,
                       ControllerConfiguration controllerConfiguration)

bindUnboundControllers

public void bindUnboundControllers(ScannedDevices scannedDevices)

For each controller in this map that currently lacks a real serial number, try to choose an unused selection from the scanned devices to associate with same.

setSerialNumber

public void setSerialNumber(ControllerConfiguration controllerConfiguration,
                            SerialNumber serialNumber)

Changes a serial number of a controller known to be in this configuration

swapSerialNumbers

public void swapSerialNumbers(ControllerConfiguration a,
                              ControllerConfiguration b)

Swaps the serial numbers (and attachment status) of two controllers both known to be in this configuration

isSwappable

public boolean isSwappable(ControllerConfiguration target,
                           ScannedDevices scannedDevices,
                           Context context)

getEligibleSwapTargets

public java.util.List<ControllerConfiguration> getEligibleSwapTargets(ControllerConfiguration target,
                                                                      ScannedDevices scannedDevices,
                                                                      Context context)

Returns a list of the candidate configurations with which the target may be swapped. Candidates must be of the same configuration type as the target but must not be the target itself. We pull candidates both from what's in this RobotConfigMap and what's currently attached to the USB bus: those are possibly intersecting sets, but each may have members which are not in the other.

generateName

protected java.lang.String generateName(Context context,
                                        ConfigurationType type,
                                        java.util.List<ControllerConfiguration> resultSoFar)

Generates a name that's unique across both this whole configuration and the candidate swaps that have been produced so far.

nameExists

protected boolean nameExists(java.lang.String name,
                             java.util.List<ControllerConfiguration> resultSoFar)

containsSerialNumber

protected boolean containsSerialNumber(java.util.List<ControllerConfiguration> list,
                                       SerialNumber serialNumber)