com.kuka.nav.robot
Interface MobileRobotManager

All Superinterfaces:

FacadePool

public interface MobileRobotManager
extends FacadePool

The robot manager is the central class where mobile robots are managed. Mobile robots must establish a connection to a robot manager to appear in the system and be considered online. So a list of all online robots can be obtained here.

Method Summary

void	addListener(MobileRobotListener listener) Adds a listener for events if any mobile robot is added to or removed from the system.
AsyncCount	getCount()
ResourcePool	getResourcePool() Provides access to the mobile robot resources directly.
<T> T	getRobot(Class<T> robotInterface, int robotId) Provides a more specialised access to a robot.
<T> T	getRobot(Class<T> robotInterface, String name) Provides a more specialised access to a robot.
MobileRobot	getRobot(int robotId)
MobileRobot	getRobot(String name)
Collection<MobileRobot>	getRobots()
<T> Collection<T>	getRobots(Class<T> robotInterface) Returns only those robots that are compatible with a specialised robot facade type.
MobileRobotType	getType(int typeId) Returns the mobile robot type specified by the corresponding type id.
MobileRobotType	getType(String typeName) Returns the mobile robot type specified by the corresponding type name.
Collection<MobileRobotType>	getTypes() Returns all available mobile robot types.
boolean	hasRobot(int robotId)
boolean	hasRobot(String name)
boolean	hasType(int typeId) Returns true if the mobile robot type with the given id exists.
boolean	hasType(String typeName) Returns true if the mobile robot type with the given name exists.

Methods inherited from interface com.kuka.resource.pool.FacadePool

addFacadeListener, facade, getAll, getAll, getAny, getAny, getAny, getFacade, removeFacadeListener, size

Method Detail

getResourcePool

ResourcePool getResourcePool()

Provides access to the mobile robot resources directly.

Returns:

the resource pool containing all mobile robots

getCount

AsyncCount getCount()

Returns:

an asynchronously updated count of the current number of managed robots

hasRobot

boolean hasRobot(String name)

Parameters:

name - a robot name

Returns:

true if a robot of that name is currently in the system

getRobot

MobileRobot getRobot(String name)

Parameters:

name - a robot name

Returns:

a standard facade to access the robot with the specified name or null if no robot with that name exists currently in the system

getRobot

<T> T getRobot(Class<T> robotInterface,
               String name)

Provides a more specialised access to a robot.

Type Parameters:

T - the specialised robot interface type

Parameters:

robotInterface - a specialised robot interface type

name - name of the robot

Returns:

an interface with more specialised access to the robot with the specified name or null if no robot exists with that name

Throws:

IllegalArgumentException - if the specified facade type is incompatible with the robot

hasRobot

boolean hasRobot(int robotId)

Parameters:

robotId - a robot id

Returns:

true if a robot with that id is currently in the system

getRobot

MobileRobot getRobot(int robotId)

Parameters:

robotId - a robot id

Returns:

a standard facade to access the robot with the specified id or null if no robot with that id exists currently in the system

getRobot

<T> T getRobot(Class<T> robotInterface,
               int robotId)

Provides a more specialised access to a robot.

Type Parameters:

T - the specialised robot interface type

Parameters:

robotInterface - a specialised robot interface type

robotId - a robot id

Returns:

an interface with more specialised access to the robot with the specified id or null if no robot exists with that id

Throws:

IllegalArgumentException - if the specified facade type is incompatible with the robot

getRobots

Collection<MobileRobot> getRobots()

Returns:

standard access interfaces to all robots currently in the system

getRobots

<T> Collection<T> getRobots(Class<T> robotInterface)

Returns only those robots that are compatible with a specialised robot facade type.

Type Parameters:

T - the specialised robot interface type

Parameters:

robotInterface - a specialised robot interface type

Returns:

only those robots in the system that are compatible with the specified specialised robot interface type

addListener

void addListener(MobileRobotListener listener)

Adds a listener for events if any mobile robot is added to or removed from the system.

Parameters:

listener - a listener for mobile robots going on- or offline

getTypes

Collection<MobileRobotType> getTypes()

Returns all available mobile robot types.

Returns:

the mobile robot types

hasType

boolean hasType(int typeId)

Returns true if the mobile robot type with the given id exists.

Parameters:

typeId - the id of the mobile robot type

Returns:

true if the mobile robot type with the given id exists

getType

MobileRobotType getType(int typeId)

Returns the mobile robot type specified by the corresponding type id.

Parameters:

typeId - the id of the mobile robot type

Returns:

the mobile robot type

hasType

boolean hasType(String typeName)

Returns true if the mobile robot type with the given name exists.

Parameters:

typeName - the name of the mobile robot type

Returns:

true if the mobile robot type with the given name exists

getType

MobileRobotType getType(String typeName)

Returns the mobile robot type specified by the corresponding type name.

Parameters:

typeName - the name of the mobile robot type

Returns:

the mobile robot type