rp1.rossum.event
Class RsPlacementEvent

java.lang.Object
  rp1.rossum.event.RsEvent
      rp1.rossum.event.RsPlacementEvent

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class RsPlacementEvent
extends RsEvent

An event generated by the simulator when it accepts placement of a robot.

See Also:

Serialized Form

Field Summary

java.lang.String	name
double	orientation
boolean	valid
double	x
double	y

Fields inherited from class rp1.rossum.event.RsEvent

eventID, EVT_ARRAY_SIZE, EVT_CONTACT_SENSOR, EVT_ENCODER_STATUS, EVT_HEARTBEAT, EVT_MAX_CODE, EVT_MOTION_HALTED, EVT_MOTION_STARTED, EVT_MOUSE_CLICK, EVT_PAINT_SENSOR, EVT_PLACEMENT, EVT_PLAN, EVT_POSITION, EVT_RANGE_SENSOR, EVT_TARGET_SELECTION, EVT_TARGET_SENSOR, EVT_TIMEOUT, simTime

Constructor Summary

RsPlacementEvent(double simTime, boolean valid, java.lang.String name, double x, double y, double orientation)

Method Summary

java.lang.String	getName() The name of the placement object from the floor plan on which the robot was placed, May be null if the placement is not valid or an arbitrary placement based on (x,y) coordinate was requested.
boolean	getValid() A flag indicating that the placement request was valid.

Methods inherited from class rp1.rossum.event.RsEvent

consume, getEventID, getIndex, getSimTime, isConsumed

Methods inherited from class java.lang.Object

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

Field Detail

name

public final java.lang.String name

valid

public final boolean valid

x

public final double x

y

public final double y

orientation

public final double orientation

Constructor Detail

RsPlacementEvent

public RsPlacementEvent(double simTime,
                        boolean valid,
                        java.lang.String name,
                        double x,
                        double y,
                        double orientation)

Method Detail

getName

public java.lang.String getName()

The name of the placement object from the floor plan on which the robot was placed, May be null if the placement is not valid or an arbitrary placement based on (x,y) coordinate was requested.

getValid

public boolean getValid()

A flag indicating that the placement request was valid. This flag will be set to false if a placement would result in the robot body overlapping an object such as a wall or obstacle or if the named-placement designated in the request is not found.