robot.RobotEvent Class Reference

Event representing the status of a fictional robot that moves in a two-dimensional space. More...

Classes
class	GetAngle
	BeepBeep function that extracts the orientation of a RobotEvent.
class	GetPosition
	BeepBeep function that extracts the x-position of a RobotEvent.
class	GetVelocity
	BeepBeep function that extracts the velocity of a RobotEvent.

Public Member Functions
	RobotEvent (Vector< Float > position, Vector< Float > velocity, float theta)
	Creates a new robot event. More...
Vector< Float >	getPosition ()
	Gets the position of the robot. More...
Vector< Float >	getVelocity ()
	Gets the velocity of the robot. More...
float	getOrientation ()
	Gets the angle of orientation of the robot. More...
String	toString ()

Static Public Attributes
static final GetPosition	getPos = new GetPosition()
	Static reference to the function GetPosition.
static final GetVelocity	getVel = new GetVelocity()
	Static reference to the function GetVelocity.
static final GetAngle	getAngle = new GetAngle()
	Static reference to the function GetAngle.

Protected Attributes
final Vector< Float >	m_position
	A vector indicating the position of the robot.
final Vector< Float >	m_velocity
	A vector indicating the velocity of the robot.
final float	m_theta
	The the angle of orientation of the robot (in radians).

Detailed Description

Event representing the status of a fictional robot that moves in a two-dimensional space.

Author

Sylvain Hallé

Definition at line 29 of file RobotEvent.java.

Constructor & Destructor Documentation

RobotEvent()

robot.RobotEvent.RobotEvent	(	Vector< Float >	position,
		Vector< Float >	velocity,
		float	theta
	)

Creates a new robot event.

Parameters

position	The position of the robot
velocity	The velocity of the robot
theta	The angle of orientation of the robot (in radians)

Definition at line 67 of file RobotEvent.java.

  {
    super();
    m_position = position;
    m_velocity = velocity;
    m_theta = theta;
  }

Member Function Documentation

getOrientation()

float robot.RobotEvent.getOrientation

(

)

Gets the angle of orientation of the robot.

Returns

The angle (in radians)

Definition at line 97 of file RobotEvent.java.

  {
    return m_theta;
  }

getPosition()

Vector<Float> robot.RobotEvent.getPosition

(

)

Gets the position of the robot.

Returns

The position

Definition at line 79 of file RobotEvent.java.

  {
    return m_position;
  }

getVelocity()

Vector<Float> robot.RobotEvent.getVelocity

(

)

Gets the velocity of the robot.

Returns

The velocity

Definition at line 88 of file RobotEvent.java.

  {
    return m_velocity;
  }

---

The documentation for this class was generated from the following file:

• Source/src/robot/RobotEvent.java