Package pyrobot :: Package robot :: Module player :: Class PlayerDevice
[frames | no frames]

Class PlayerDevice

Device --+
         |
        PlayerDevice

Known Subclasses:
PlayerCommDevice, PlayerFiducialDevice, PlayerGripperDevice, PlayerLaserDevice, PlayerPositionDevice, PlayerPTZDevice, PlayerSimulationDevice, PlayerSonarDevice

Method Summary
  __init__(self, client, type, groups, mode, index, visible)
  getDeviceData(self)
Returns the device data, whatever it might be.
  getPose(self)
Move the device.
  setPose(self, xM, yM, thDeg)
Move the device.
  startDevice(self, mode)
    Inherited from Device
  __getitem__(self, item)
Get a SensorValue, a range, or a set.
  __iter__(self)
Used to iterate through SensorValues of device.
  addWidgets(self, window)
Method to addWidgets to the device window.
  angle(self, *args, **kwargs)
Device-level method to get all of the angles.
  destroy(self)
Hides the window.
  distance(self, *args, **kwargs)
Device-level method to get all of the distances.
  getActive(self)
Returns the value of .active.
  getDeviceState(self)
Returns the .state.
  getGroupNames(self, pos)
Return all of the groups a pos is in.
  getMaxvalue(self)
Get the maxvalue of the sensor.
  getSensorValue(self, pos)
Returns a specific SensorValue from the range device.
  getVisible(self)
Returns the .visible of the sensor.
  makeWindow(self)
Method to make and show the device window.
  rawToUnits(self, raw, noise, units)
Convert the sensor units into default units.
  setActive(self, value)
Sets the .active property.
  setMaxvalue(self, value)
Set the maxvalue of the sensor.
  setTitle(self, title)
Sets the title of the device.
  setup(self)
Use this to put setup code in (instead of in __init__).
  setVisible(self, value)
Sets the .visible attribute, and hides/shows window.
  stopDevice(self)
Stops the device (sets the .state).
  updateDevice(self)
Method called to update the device properties.
  updateWindow(self)
Method to update the device window.

Property Summary
    Inherited from Device
  geometry
  noise
  pos
  rawValue
  value

Method Details

getDeviceData(self, pos=0)

Returns the device data, whatever it might be.
Overrides:
pyrobot.robot.device.Device.getDeviceData (inherited documentation)

getPose(self)

Move the device. x, y are in meters

setPose(self, xM, yM, thDeg)

Move the device. x, y are in meters

Generated by Epydoc 2.1 on Mon Jul 25 01:39:27 2005 http://epydoc.sf.net