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 MAPCHANGE.
19           		
20           *
21           *  <p></p><p></p>
22           *  Complete message documentation:               
23           *  
24  		Asynchronous message. Sent when the map is changed (we will
25  		loose connection to the server for some time).
26  	
27           */
28   	public class MapChange 
29    				extends InfoMessage
30      			implements IWorldEvent, IWorldChangeEvent
31      			
32  	    {
33   	
34      	/** Example how the message looks like - used during parser tests. */
35      	public static final String PROTOTYPE =
36      		"MAPCHANGE {MapName text} ";
37      
38      	
39      	
40      	/**
41      	 * Parameter-less contructor for the message.
42      	 */
43  		public MapChange()
44  		{
45  		}
46  	
47      	
48      	
49      	
50      	/**
51  		 * Creates new instance of the message MapChange.
52  		 * 
53  		Asynchronous message. Sent when the map is changed (we will
54  		loose connection to the server for some time).
55  	
56  		 * Corresponding GameBots message
57  		 *   
58  		 *   is
59  		 *   MAPCHANGE.
60  		 * 
61   	  	 * 
62  		 *   
63  		 *     @param MapName Name of the new map.
64  		 *   
65  		 * 
66  		 */
67  		public MapChange(
68  			String MapName
69  		) {
70  			
71  					this.MapName = MapName;
72  				
73  		}
74      
75      	/**
76  		 * Cloning constructor from the full message.
77  		 *
78  		 * @param original
79  		 */
80  		public MapChange(MapChange original) {		
81  			
82  					this.MapName = original.getMapName()
83   	;
84  				
85  			this.SimTime = original.getSimTime();			
86  		}
87  		
88  	   		
89  			protected long SimTime;
90  				
91  			/**
92  			 * Simulation time in MILLI SECONDS !!!
93  			 */	
94  			@Override
95  			public long getSimTime() {
96  				return SimTime;
97  			}
98  						
99  			/**
100 			 * Used by Yylex to slip correct time of the object or programmatically.
101 			 */
102 			protected void setSimTime(long SimTime) {
103 				this.SimTime = SimTime;
104 			}
105 	   	
106     	
107 	    /**
108          * Name of the new map. 
109          */
110         protected
111          String MapName =
112        	null;
113 	
114  		/**
115          * Name of the new map. 
116          */
117         public  String getMapName()
118  	 {
119     					return MapName;
120     				}
121     			
122  		
123  	    public String toString() {
124             return
125             	super.toString() + "[" +
126             	
127 		              			"MapName = " + String.valueOf(getMapName()
128  	) + " | " + 
129 		              		
130 				"]";           		
131         }
132  	
133  		
134  		public String toHtmlString() {
135  			return super.toString() + "[<br/>" +
136             	
137 		              			"<b>MapName</b> = " + String.valueOf(getMapName()
138  	) + " <br/> " + 
139 		              		
140 				"<br/>]";     
141 		}
142  	
143  	    public String toJsonLiteral() {
144             return "mapchange( "
145             		+
146 									(getMapName()
147  	 == null ? "null" :
148 										"\"" + getMapName()
149  	 + "\"" 
150 									)
151 								
152                    + ")";
153         }
154  	
155  		
156  		// --- Extra Java from XML BEGIN (extra/code/java/javapart/classcategory[@name=all]) ---
157         	
158 		// --- Extra Java from XML END (extra/code/java/javapart/classcategory[@name=all]) ---
159 		
160 	    // --- Extra Java from XML BEGIN (extra/code/java/javapart/classcategory[@name=event+classtype[@name=impl]) ---
161 	        
162 	    // --- Extra Java from XML END (extra/code/java/javapart/classcategory[@name=event+classtype[@name=impl]) ---        	            	
163  	
164 		}
165