FastTraceResponse (pogamut-ut2004 3.3.1-SNAPSHOT API)

java.lang.Object
- cz.cuni.amis.pogamut.base.communication.messages.InfoMessage
- - cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.FastTraceResponse

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, cz.cuni.amis.utils.listener.Event
```
public class FastTraceResponse
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent
```
Definition of the event FTR.
Complete message documentation: Asynchronous message. Response of the FASTTRACE command. Note that trace commands are computationally expensive.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Location`	`From` Location from which the ray is emitted.
`protected String`	`Id` An Id matching the one sent by client.
`static String`	`PROTOTYPE` Example how the message looks like - used during parser tests.
`protected boolean`	`Result` True if it hit something, false if not.
`protected long`	`SimTime`
`protected Location`	`To` Location to which the ray is sent.

Constructor Summary

Constructors
Constructor and Description
`FastTraceResponse()` Parameter-less contructor for the message.
`FastTraceResponse(FastTraceResponse original)` Cloning constructor from the full message.
`FastTraceResponse(String Id, Location From, Location To, boolean Result)` Creates new instance of the message FastTraceResponse.

Method Summary

Methods
Modifier and Type	Method and Description
`Location`	`getFrom()` Location from which the ray is emitted.
`String`	`getId()` An Id matching the one sent by client.
`long`	`getSimTime()` Simulation time in MILLI SECONDS !!!
`Location`	`getTo()` Location to which the ray is sent.
`boolean`	`isResult()` True if it hit something, false if not.
`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
```
  - Id
```
protected String Id
```
    An Id matching the one sent by client. Allows bot to match answer with right query.
  - From
```
protected Location From
```
    Location from which the ray is emitted.
  - To
```
protected Location To
```
    Location to which the ray is sent.
  - Result
```
protected boolean Result
```
    True if it hit something, false if not.
- Constructor Detail
  - FastTraceResponse
```
public FastTraceResponse()
```
    Parameter-less contructor for the message.
  - FastTraceResponse
```
public FastTraceResponse(String Id,
                 Location From,
                 Location To,
                 boolean Result)
```
    Creates new instance of the message FastTraceResponse. Asynchronous message. Response of the FASTTRACE command. Note that trace commands are computationally expensive. Corresponding GameBots message is FTR.
    
    Parameters:
    Id - An Id matching the one sent by client. Allows bot to match answer with right query.
    From - Location from which the ray is emitted.
    To - Location to which the ray is sent.
    Result - True if it hit something, false if not.
  - FastTraceResponse
```
public FastTraceResponse(FastTraceResponse 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.
  - getId
```
public String getId()
```
    An Id matching the one sent by client. Allows bot to match answer with right query.
  - getFrom
```
public Location getFrom()
```
    Location from which the ray is emitted.
  - getTo
```
public Location getTo()
```
    Location to which the ray is sent.
  - isResult
```
public boolean isResult()
```
    True if it hit something, false if not.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class InfoMessage
  - toHtmlString
```
public String toHtmlString()
```
  - toJsonLiteral
```
public String toJsonLiteral()
```
    Overrides:
    
    toJsonLiteral in class InfoMessage

Class FastTraceResponse

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROTOTYPE

SimTime

Id

From

To

Result

Constructor Detail

FastTraceResponse

FastTraceResponse

FastTraceResponse

Method Detail

getSimTime

setSimTime

getId

getFrom

getTo

isResult

toString

toHtmlString

toJsonLiteral