cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages
Class ControlMessage

Package class diagram package ControlMessage
java.lang.Object
  extended by cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
      extended by cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.ControlMessage
All Implemented Interfaces:
IWorldChangeEvent, IWorldEvent, cz.cuni.amis.utils.listener.Event

public class ControlMessage
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event CTRLMSG.

Complete message documentation: Asynchronous message passing some control message.


Field Summary
protected  Boolean PB1
          Param Boolean 1
protected  Boolean PB2
          Param Boolean 2
protected  Boolean PB3
          Param Boolean 3
protected  Double PF1
          Param Double 1
protected  Double PF2
          Param Double 2
protected  Double PF3
          Param Double 3
protected  Integer PI1
          Param Integer 1
protected  Integer PI2
          Param Integer 2
protected  Integer PI3
          Param Integer 3
static String PROTOTYPE
          Example how the message looks like - used during parser tests.
protected  String PS1
          Param String 1
protected  String PS2
          Param String 2
protected  String PS3
          Param String 3
protected  long SimTime
           
protected  String Type
          Custom type of the message.
 
Constructor Summary
ControlMessage()
          Parameter-less contructor for the message.
ControlMessage(ControlMessage original)
          Cloning constructor from the full message.
ControlMessage(String Type, String PS1, String PS2, String PS3, Integer PI1, Integer PI2, Integer PI3, Double PF1, Double PF2, Double PF3, Boolean PB1, Boolean PB2, Boolean PB3)
          Creates new instance of the message ControlMessage.
 
Method Summary
 Double getPF1()
          Param Double 1
 Double getPF2()
          Param Double 2
 Double getPF3()
          Param Double 3
 Integer getPI1()
          Param Integer 1
 Integer getPI2()
          Param Integer 2
 Integer getPI3()
          Param Integer 3
 String getPS1()
          Param String 1
 String getPS2()
          Param String 2
 String getPS3()
          Param String 3
 long getSimTime()
          Simulation time in MILLI SECONDS !!!
 String getType()
          Custom type of the message.
 Boolean isPB1()
          Param Boolean 1
 Boolean isPB2()
          Param Boolean 2
 Boolean isPB3()
          Param Boolean 3
protected  void setSimTime(long SimTime)
          Used by Yylex to slip correct time of the object or programmatically.
 String toHtmlString()
           
 String toJsonLiteral()
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PROTOTYPE

public static final String PROTOTYPE
Example how the message looks like - used during parser tests.

See Also:
Constant Field Values

SimTime

protected long SimTime

Type

protected String Type
Custom type of the message.


PS1

protected String PS1
Param String 1


PS2

protected String PS2
Param String 2


PS3

protected String PS3
Param String 3


PI1

protected Integer PI1
Param Integer 1


PI2

protected Integer PI2
Param Integer 2


PI3

protected Integer PI3
Param Integer 3


PF1

protected Double PF1
Param Double 1


PF2

protected Double PF2
Param Double 2


PF3

protected Double PF3
Param Double 3


PB1

protected Boolean PB1
Param Boolean 1


PB2

protected Boolean PB2
Param Boolean 2


PB3

protected Boolean PB3
Param Boolean 3

Constructor Detail

ControlMessage

public ControlMessage()
Parameter-less contructor for the message.


ControlMessage

public ControlMessage(String Type,
                      String PS1,
                      String PS2,
                      String PS3,
                      Integer PI1,
                      Integer PI2,
                      Integer PI3,
                      Double PF1,
                      Double PF2,
                      Double PF3,
                      Boolean PB1,
                      Boolean PB2,
                      Boolean PB3)
Creates new instance of the message ControlMessage. Asynchronous message passing some control message. Corresponding GameBots message is CTRLMSG.

Parameters:
Type - Custom type of the message.
PS1 - Param String 1
PS2 - Param String 2
PS3 - Param String 3
PI1 - Param Integer 1
PI2 - Param Integer 2
PI3 - Param Integer 3
PF1 - Param Double 1
PF2 - Param Double 2
PF3 - Param Double 3
PB1 - Param Boolean 1
PB2 - Param Boolean 2
PB3 - Param Boolean 3

ControlMessage

public ControlMessage(ControlMessage original)
Cloning constructor from the full message.

Parameters:
original -
Method Detail

getSimTime

public long getSimTime()
Simulation time in MILLI SECONDS !!!

Specified by:
getSimTime in interface IWorldChangeEvent
Specified by:
getSimTime in interface IWorldEvent

setSimTime

protected void setSimTime(long SimTime)
Used by Yylex to slip correct time of the object or programmatically.


getType

public String getType()
Custom type of the message.


getPS1

public String getPS1()
Param String 1


getPS2

public String getPS2()
Param String 2


getPS3

public String getPS3()
Param String 3


getPI1

public Integer getPI1()
Param Integer 1


getPI2

public Integer getPI2()
Param Integer 2


getPI3

public Integer getPI3()
Param Integer 3


getPF1

public Double getPF1()
Param Double 1


getPF2

public Double getPF2()
Param Double 2


getPF3

public Double getPF3()
Param Double 3


isPB1

public Boolean isPB1()
Param Boolean 1


isPB2

public Boolean isPB2()
Param Boolean 2


isPB3

public Boolean isPB3()
Param Boolean 3


toString

public String toString()
Overrides:
toString in class InfoMessage

toHtmlString

public String toHtmlString()

toJsonLiteral

public String toJsonLiteral()
Overrides:
toJsonLiteral in class InfoMessage


Copyright © 2013 AMIS research group, Faculty of Mathematics and Physics, Charles University in Prague, Czech Republic. All Rights Reserved.