cz.cuni.amis.pogamut.usar2004.communication.messages.usarinfomessages
Class MissionPackageMessage

java.lang.Object
  cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
      cz.cuni.amis.pogamut.usar2004.communication.messages.GBEvent
          cz.cuni.amis.pogamut.usar2004.communication.messages.usarinfomessages.MissionPackageMessage

All Implemented Interfaces:

cz.cuni.amis.pogamut.base.communication.translator.event.IWorldChangeEvent, cz.cuni.amis.pogamut.base.communication.translator.event.IWorldEventWrapper, cz.cuni.amis.pogamut.base.communication.worldview.event.IWorldEvent, IGBWorldEvent, cz.cuni.amis.utils.listener.Event

public class MissionPackageMessage
extends GBEvent
implements cz.cuni.amis.pogamut.base.communication.worldview.event.IWorldEvent, cz.cuni.amis.pogamut.base.communication.translator.event.IWorldChangeEvent

A Mission Package state message reports the mission package links current properties. Every mission package state includes a Name segment and several link segments. Corresponding GameBots message is MISSTA.

Field Summary

protected LinkStateSet	Links
protected String	Name
static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected double	Time

Constructor Summary

MissionPackageMessage()
Used by Yylex to create empty message then to fill it's protected fields (Yylex is in the same package).

MissionPackageMessage(double Time, String Name, int Link, double Value, double Torque)
Creates new instance of command MissionPackageMessage.

MissionPackageMessage(double Time, String Name, LinkState LS)

MissionPackageMessage(MissionPackageMessage original)
Cloning constructor.

Method Summary

List<LinkState>	getLinkStateSet() This parameter gives the link number that will be described by the next two parameters (Value and Torque).
String	getName() Name of the mission package
double	getTime() Timestamp form the UT since server start in seconds.
String	toHtmlString() Gets all properties and values to create a HTML formated string;
String	toString()

Methods inherited from class cz.cuni.amis.pogamut.usar2004.communication.messages.GBEvent

getSimTime, getWorldEvent

Methods inherited from class cz.cuni.amis.pogamut.base.communication.messages.InfoMessage

toJsonLiteral

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface cz.cuni.amis.pogamut.base.communication.worldview.event.IWorldEvent

getSimTime

Methods inherited from interface cz.cuni.amis.pogamut.base.communication.translator.event.IWorldChangeEvent

getSimTime

Field Detail

PROTOTYPE

public static final String PROTOTYPE

Example how the message looks like - used during parser tests.

See Also:

Constant Field Values

Time

protected double Time

Name

protected String Name

Links

protected LinkStateSet Links

Constructor Detail

MissionPackageMessage

public MissionPackageMessage(double Time,
                             String Name,
                             int Link,
                             double Value,
                             double Torque)

Creates new instance of command MissionPackageMessage.

Parameters:

Time - Timestamp form the UT since server start in seconds.

Name - Name of the mission package

Link - This parameter gives the link number that will be described by the next two parameters (Value and Torque). Please note that you will have as many as these parameters as you have links.

Value - This parameter has two possible meanings. If the link being described is a prismatic joint, double gives the distance (in meters) from the original position of the link. If the link being described is a revolute joint, it gives a sector(probably).

Torque - The Torque parameter gives the current torque of the link being described.

MissionPackageMessage

public MissionPackageMessage(double Time,
                             String Name,
                             LinkState LS)

MissionPackageMessage

public MissionPackageMessage(MissionPackageMessage original)

Cloning constructor.

MissionPackageMessage

public MissionPackageMessage()

Used by Yylex to create empty message then to fill it's protected fields (Yylex is in the same package).

Method Detail

getTime

public double getTime()

Timestamp form the UT since server start in seconds.

Returns:

Returns seconds elapsed from the start of the server.

getName

public String getName()

Name of the mission package

getLinkStateSet

public List<LinkState> getLinkStateSet()

This parameter gives the link number that will be described by the next two parameters (Value and Torque). Please note that you will have as many as these parameters as you have links. VALUE parameter has two possible meanings. If the link being described is a prismatic joint, double gives the distance (in meters) from the original position of the link. If the link being described is a revolute joint, it gives a sector(probably). The TORQUE parameter gives the current torque of the link being described. * All of the above are collected into one data structure below this text.

Returns:

Returns collection of Link States.

toString

public String toString()

Overrides:

toString in class cz.cuni.amis.pogamut.base.communication.messages.InfoMessage

toHtmlString

public String toHtmlString()

Gets all properties and values to create a HTML formated string;

Returns:

Returns all properties in HTML format