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

Class FactoryUsed

java.lang.Object

cz.cuni.amis.pogamut.base.communication.messages.InfoMessage

cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.FactoryUsed

All Implemented Interfaces:

IWorldChangeEvent, IWorldEvent, cz.cuni.amis.utils.listener.Event

public class FactoryUsed
extends InfoMessage
implements IWorldEvent, IWorldChangeEvent

Definition of the event USED.

Complete message documentation: Asynchronous message. Response to USE (FactoryUse) command.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROTOTYPE Example how the message looks like - used during parser tests.
protected String	Reason If success is false, the reason why we couldn't use a factory will be here.
protected long	SimTime
protected boolean	Success If we have successfully used the factory.

Constructor Summary

Constructors

Constructor and Description
FactoryUsed() Parameter-less contructor for the message.
FactoryUsed(boolean Success, String Reason) Creates new instance of the message FactoryUsed.
FactoryUsed(FactoryUsed original) Cloning constructor from the full message.

Method Summary

Methods

Modifier and Type	Method and Description
String	getReason() If success is false, the reason why we couldn't use a factory will be here.
long	getSimTime() Simulation time in MILLI SECONDS !!!
boolean	isSuccess() If we have successfully used the factory.
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

Success

protected boolean Success

If we have successfully used the factory.

Reason

protected String Reason

If success is false, the reason why we couldn't use a factory will be here.

Constructor Detail

FactoryUsed

public FactoryUsed()

Parameter-less contructor for the message.

FactoryUsed

public FactoryUsed(boolean Success,
           String Reason)

Creates new instance of the message FactoryUsed. Asynchronous message. Response to USE (FactoryUse) command. Corresponding GameBots message is USED.

Parameters:

Success - If we have successfully used the factory.

Reason - If success is false, the reason why we couldn't use a factory will be here.

FactoryUsed

public FactoryUsed(FactoryUsed 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.

isSuccess

public boolean isSuccess()

If we have successfully used the factory.

getReason

public String getReason()

If success is false, the reason why we couldn't use a factory will be here.

toString

public String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public String toHtmlString()

toJsonLiteral

public String toJsonLiteral()

Overrides:

toJsonLiteral in class InfoMessage