Package xbot.common.injection

Class DevicePolice

java.lang.Object

xbot.common.injection.DevicePolice

@Singleton
public class DevicePolice
extends Object

Tracks how many devices are registered and prevents incorrectly re-using devices

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DevicePolice.DeviceType	Types of devices

Field Summary

Fields

Modifier and Type	Field	Description
Map<String,Object>	registeredChannels	A list of all the channels in use, and what device is using them.
List<Object>	registeredDevices	A list of all the devices in use

Constructor Summary

Constructors

Constructor	Description
DevicePolice(RobotAssertionManager assertionManager)	Creates a new DevicePolice instance

Method Summary

Modifier and Type	Method	Description
void	registerDevice(DevicePolice.DeviceType type, int id)	Deprecated.
void	registerDevice(DevicePolice.DeviceType type, int id, int minId, int maxId)	Register a device with an id falling into an allowable range
void	registerDevice(DevicePolice.DeviceType type, int id, int minId, int maxId, Object device)	Register a device with an id falling into an allowable range
String	registerDevice(DevicePolice.DeviceType type, int id, Object device)	Register a device
String	registerDevice(DevicePolice.DeviceType type, CANBusId busId, int id, Object device)	Register a CAN device

Methods inherited from class java.lang.Object

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

Field Details

registeredChannels

public Map<String,Object> registeredChannels

A list of all the channels in use, and what device is using them.

registeredDevices

public List<Object> registeredDevices

A list of all the devices in use

Constructor Details

DevicePolice

@Inject
public DevicePolice(RobotAssertionManager assertionManager)

Creates a new DevicePolice instance

Method Details

registerDevice

@Deprecated
public void registerDevice(DevicePolice.DeviceType type,
 int id)

Deprecated.

Register a device. Please use registerDevice(DeviceType, int, Object) instead

Parameters:

type - Device type

id - Device id

registerDevice

public String registerDevice(DevicePolice.DeviceType type,
 int id,
 Object device)

Register a device

Parameters:

type - Device type

id - Device id

registerDevice

public String registerDevice(DevicePolice.DeviceType type,
 CANBusId busId,
 int id,
 Object device)

Register a CAN device

Parameters:

type - Device type

busId - Device CAN bus id

id - Device id

device - Device object

registerDevice

public void registerDevice(DevicePolice.DeviceType type,
 int id,
 int minId,
 int maxId)

Register a device with an id falling into an allowable range

Parameters:

type - Device type

id - Device id

minId - Minimum allowable id

maxId - Maximum allowable id

registerDevice

public void registerDevice(DevicePolice.DeviceType type,
 int id,
 int minId,
 int maxId,
 Object device)

Register a device with an id falling into an allowable range

Parameters:

type - Device type

id - Device id

minId - Minimum allowable id

maxId - Maximum allowable id