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, 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

static java.lang.String	PROTOTYPE Example how the message looks like - used during parser tests.
protected java.lang.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

FactoryUsed()
Parameter-less contructor for the message.

FactoryUsed(boolean Success, java.lang.String Reason)
Creates new instance of the message FactoryUsed.

FactoryUsed(FactoryUsed original)
Cloning constructor from the full message.

Method Summary

java.lang.String	getReason() If success is false, the reason why we couldn't use a factory will be here.
long	getSimTime() Returns the simulation time when the event has occurred.
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.
java.lang.String	toHtmlString()
java.lang.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 java.lang.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 java.lang.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,
                   java.lang.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()

Description copied from interface: IWorldEvent

Returns the simulation time when the event has occurred.

Specified by:

getSimTime in interface IWorldChangeEvent

Specified by:

getSimTime in interface IWorldEvent

Returns:

timestamp

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 java.lang.String getReason()

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

toString

public java.lang.String toString()

Overrides:

toString in class InfoMessage

toHtmlString

public java.lang.String toHtmlString()