|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Robot
A Robot provides access to a List of Joints backed by a List of JointControllers.
Nested Class Summary | |
---|---|
static class |
Robot.Id
Id is an immutable globally unique identifier for a Robot. |
static class |
Robot.JointId
JointId is an immutable globally unique identifier for a Joint belonging to a Robot. |
static class |
Robot.RobotPositionHashMap
RobotPositionMap backed by java.util.HashMap. |
static interface |
Robot.RobotPositionMap
RobotPositionMap expected by the Robot. |
Field Summary | |
---|---|
static String |
PROP_ID
Property String for the Id. |
Method Summary | |
---|---|
boolean |
connect()
The Robot will accept commands only after it is successfully connected. |
void |
disconnect()
Disconnect the Robot. |
Robot.RobotPositionMap |
getCurrentPositions()
Returns a map of the Robot's Joint's ids and their current positions. |
Robot.RobotPositionMap |
getDefaultPositions()
Returns a map of the Robot's Joint's ids and their default positions. |
Robot.RobotPositionMap |
getGoalPositions()
Returns a map of the Robot's Joint's ids and their goal positions. |
Joint |
getJoint(Robot.JointId id)
Return the Joint with the given id. |
Set<Robot.JointId> |
getJointIds()
Returns a set of the Robot's Joint ids. |
List<Joint> |
getJointList()
Returns a List of the Robot's Joints. |
String |
getJointName(Robot.JointId id)
The Robot's name for the Joint with the given logical id. |
Map<Robot.JointId,String> |
getJointNames()
Returns a map of the Robot's Joint's ids and their names. |
Map<Robot.JointId,? extends Joint> |
getJoints()
Returns a map of the Robot's Joints and their ids. |
Robot.Id |
getRobotId()
Returns a String uniquely identifying this Robot. |
boolean |
isConnected()
Returns true if the Robot is connected. |
boolean |
isEnabled()
Returns true if the Robot is enabled and accepting commands. |
void |
move(Robot.RobotPositionMap positions,
long lenMillisec)
Move the Joints with the given ids to the corresponding positions. |
void |
setEnabled(boolean val)
Sets the enabled status of the Robot. |
Field Detail |
---|
static final String PROP_ID
Method Detail |
---|
Robot.Id getRobotId()
boolean connect()
void disconnect()
boolean isConnected()
void setEnabled(boolean val)
val
- enabled valueboolean isEnabled()
Joint getJoint(Robot.JointId id)
id
- Joint's logical id
Set<Robot.JointId> getJointIds()
List<Joint> getJointList()
Map<Robot.JointId,? extends Joint> getJoints()
String getJointName(Robot.JointId id)
id
- Joint's logical id
Map<Robot.JointId,String> getJointNames()
Robot.RobotPositionMap getDefaultPositions()
Robot.RobotPositionMap getCurrentPositions()
Robot.RobotPositionMap getGoalPositions()
void move(Robot.RobotPositionMap positions, long lenMillisec)
positions
- map of Joint logical ids and positionslenMillisec
- duration of the movement in milliseconds
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |