View Javadoc

1   package cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages;
2    		
3    		// --- IMPORTS FROM /messages/settings/javasettings/javaimport BEGIN
4   			import java.util.*;import javax.vecmath.*;import cz.cuni.amis.pogamut.base.communication.messages.*;import cz.cuni.amis.pogamut.base.communication.worldview.*;import cz.cuni.amis.pogamut.base.communication.worldview.event.*;import cz.cuni.amis.pogamut.base.communication.worldview.object.*;import cz.cuni.amis.pogamut.multi.communication.worldview.object.*;import cz.cuni.amis.pogamut.base.communication.translator.event.*;import cz.cuni.amis.pogamut.multi.communication.translator.event.*;import cz.cuni.amis.pogamut.base3d.worldview.object.*;import cz.cuni.amis.pogamut.base3d.worldview.object.event.*;import cz.cuni.amis.pogamut.ut2004.communication.messages.*;import cz.cuni.amis.pogamut.ut2004.communication.worldview.objects.*;import cz.cuni.amis.pogamut.ut2004multi.communication.worldview.objects.*;import cz.cuni.amis.pogamut.ut2004.communication.translator.itemdescriptor.*;import cz.cuni.amis.pogamut.ut2004.communication.messages.ItemType.Category;import cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId;import cz.cuni.amis.utils.exception.*;import cz.cuni.amis.pogamut.base.communication.translator.event.IWorldObjectUpdateResult.Result;import cz.cuni.amis.utils.SafeEquals;import cz.cuni.amis.pogamut.base.agent.*;import cz.cuni.amis.pogamut.multi.agent.*;import cz.cuni.amis.pogamut.multi.communication.worldview.property.*;import cz.cuni.amis.pogamut.ut2004multi.communication.worldview.property.*;import cz.cuni.amis.utils.token.*;import cz.cuni.amis.utils.*;
5   		// --- IMPORTS FROM /messages/settings/javasettings/javaimport END
6   		
7   		
8   		// --- IMPORTS FROM extra/code/java/javapart/classcategory[@name='all'] BEGIN
9   				
10  		// --- IMPORTS FROM extra/code/java/javapart/classcategory[@name='all'] END
11  		
12  		// --- IMPORTS FROM extra/code/java/javapart/classcategory[@name=event]+classtype[@name=impl] BEGIN
13  		
14  		// --- IMPORTS FROM extra/code/java/javapart/classcategory[@name=event]+classtype[@name=impl] END
15      
16   		/**
17           *  
18           			Definition of the event END.
19           		
20           *
21           *  <p></p><p></p>
22           *  Complete message documentation:               
23           *  
24  		Synchronous message. This message signalizes end of
25  		synchronous
26  		batch.
27  	
28           */
29   	public class EndMessage 
30    				extends InfoMessage
31      			implements IWorldEvent, IWorldChangeEvent
32      			
33  	    {
34   	
35      	/** Example how the message looks like - used during parser tests. */
36      	public static final String PROTOTYPE =
37      		"END {Time 0} ";
38      
39      	
40      	
41      	/**
42      	 * Parameter-less contructor for the message.
43      	 */
44  		public EndMessage()
45  		{
46  		}
47  	
48      	
49      	
50      	
51      	/**
52  		 * Creates new instance of the message EndMessage.
53  		 * 
54  		Synchronous message. This message signalizes end of
55  		synchronous
56  		batch.
57  	
58  		 * Corresponding GameBots message
59  		 *   
60  		 *   is
61  		 *   END.
62  		 * 
63   	  	 * 
64  		 *   
65  		 *     @param Time 
66  			Time, when the message was sent - intern UT time.
67  		
68  		 *   
69  		 * 
70  		 */
71  		public EndMessage(
72  			double Time
73  		) {
74  			
75  					this.Time = Time;
76  				
77  		}
78      
79      	/**
80  		 * Cloning constructor from the full message.
81  		 *
82  		 * @param original
83  		 */
84  		public EndMessage(EndMessage original) {		
85  			
86  					this.Time = original.getTime()
87   	;
88  				
89  			this.SimTime = original.getSimTime();			
90  		}
91  		
92  	   		
93  			protected long SimTime;
94  				
95  			/**
96  			 * Simulation time in MILLI SECONDS !!!
97  			 */	
98  			@Override
99  			public long getSimTime() {
100 				return SimTime;
101 			}
102 						
103 			/**
104 			 * Used by Yylex to slip correct time of the object or programmatically.
105 			 */
106 			protected void setSimTime(long SimTime) {
107 				this.SimTime = SimTime;
108 			}
109 	   	
110     	
111 	    /**
112          * 
113 			Time, when the message was sent - intern UT time.
114 		 
115          */
116         protected
117          double Time =
118        	0;
119 	
120  		/**
121          * 
122 			Time, when the message was sent - intern UT time.
123 		 
124          */
125         public  double getTime()
126  	 {
127     					return Time;
128     				}
129     			
130  		
131  	    public String toString() {
132             return
133             	super.toString() + "[" +
134             	
135 		              			"Time = " + String.valueOf(getTime()
136  	) + " | " + 
137 		              		
138 				"]";           		
139         }
140  	
141  		
142  		public String toHtmlString() {
143  			return super.toString() + "[<br/>" +
144             	
145 		              			"<b>Time</b> = " + String.valueOf(getTime()
146  	) + " <br/> " + 
147 		              		
148 				"<br/>]";     
149 		}
150  	 
151  	    public String toJsonLiteral() {
152             return "EndMessage(null, "
153             		
154                    + ")";
155         }
156  	
157  		
158  		// --- Extra Java from XML BEGIN (extra/code/java/javapart/classcategory[@name=all]) ---
159         	
160 		// --- Extra Java from XML END (extra/code/java/javapart/classcategory[@name=all]) ---
161 		
162 	    // --- Extra Java from XML BEGIN (extra/code/java/javapart/classcategory[@name=event+classtype[@name=impl]) ---
163 	        
164 	    // --- Extra Java from XML END (extra/code/java/javapart/classcategory[@name=event+classtype[@name=impl]) ---        	            	
165  	
166 		}
167