sk.robotics.rlcs.agents.robot
Class ConnectionAgent.Cfg

java.lang.Object
  extended by sk.robotics.rlcs.agentspace.Agent.Cfg
      extended by sk.robotics.rlcs.agents.robot.ConnectionAgent.Cfg
Enclosing class:
ConnectionAgent

public static class ConnectionAgent.Cfg
extends Agent.Cfg


Nested Class Summary
static class ConnectionAgent.Cfg.PredefinedRobot
           
 
Nested classes/interfaces inherited from class sk.robotics.rlcs.agentspace.Agent.Cfg
Agent.Cfg.Limited, Agent.Cfg.NoDefault, Agent.Cfg.Required, Agent.Cfg.Validator
 
Field Summary
 java.lang.String blockComm
          Name of block with the robot control object, made available for other agents.
 boolean exclusive
          Request exclusive access to the robot? True if we want to control the robot, false if we only want to track its position.
 java.lang.String password
          Password for use with username.
 ConnectionAgent.Cfg.PredefinedRobot robot
          Predefined robot to connect to.
 java.lang.String robotdHost
          Host name or IP address where the robot daemon runs.
 java.lang.Integer robotdPort
          TCP port on which the robot daemon is listening.
 java.lang.String username
          User name to use for connection to the robot.
 
Fields inherited from class sk.robotics.rlcs.agentspace.Agent.Cfg
enabled, id, logLevel, timerPeriodMs, triggers
 
Constructor Summary
ConnectionAgent.Cfg()
           
 
Method Summary
 void validate()
          Config validation.
 
Methods inherited from class sk.robotics.rlcs.agentspace.Agent.Cfg
createAgent, equals, getHiddenFields, hideFields
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

robotdHost

public java.lang.String robotdHost
Host name or IP address where the robot daemon runs. Not set means localhost.


robotdPort

public java.lang.Integer robotdPort
TCP port on which the robot daemon is listening. Can be not-set, if robot is set (see below).


username

public java.lang.String username
User name to use for connection to the robot. Does not have to be set, there is a working default username, which will be used if this is not set. However, it is possible to register in the robotics laboratory for exclusive access robots.


password

public java.lang.String password
Password for use with username. Set this only if you also set username, and if you have registered in the robotics laboratory for exclusive access to robots.


robot

public ConnectionAgent.Cfg.PredefinedRobot robot
Predefined robot to connect to. Alternative to setting robotdPort directly.


exclusive

public boolean exclusive
Request exclusive access to the robot? True if we want to control the robot, false if we only want to track its position.


blockComm

public java.lang.String blockComm
Name of block with the robot control object, made available for other agents. However, they must synchronize on it to use it.

Block access:
read/write
Stored type:
sk.robotics.robot.Robot
Constructor Detail

ConnectionAgent.Cfg

public ConnectionAgent.Cfg()
Method Detail

validate

public void validate()
Description copied from class: Agent.Cfg
Config validation. This base versions checks that fields declared as required (through the Required annotation) are filled. Derived agent config classes may override this to provide custom validation function for user defined configuration. It can be as well used for setting default values for uninitialized fields, or any other processing. To veto launching the agent, it can throw an exception.

Overrides:
validate in class Agent.Cfg