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 IPTH.
19           		
20           *
21           *  <p></p><p></p>
22           *  Complete message documentation:               
23           *  
24  		Info batch message. A series of pathnodes in response to a
25  		GETPATH command from the client. Starts with SPTH, ends with
26  		EPTH. Represents some path in the map (sequence of traversable
27  		navigation points).
28  	
29           */
30   	public class PathList 
31    				extends InfoMessage
32      			implements IWorldEvent, IWorldChangeEvent
33      			
34  	    {
35   	
36      	/** Example how the message looks like - used during parser tests. */
37      	public static final String PROTOTYPE =
38      		"IPTH {RouteId unreal_id}  {Location 0,0,0} ";
39      
40      	
41      	
42      	/**
43      	 * Parameter-less contructor for the message.
44      	 */
45  		public PathList()
46  		{
47  		}
48  	
49      	
50      	
51      	
52      	/**
53  		 * Creates new instance of the message PathList.
54  		 * 
55  		Info batch message. A series of pathnodes in response to a
56  		GETPATH command from the client. Starts with SPTH, ends with
57  		EPTH. Represents some path in the map (sequence of traversable
58  		navigation points).
59  	
60  		 * Corresponding GameBots message
61  		 *   
62  		 *   is
63  		 *   IPTH.
64  		 * 
65   	  	 * 
66  		 *   
67  		 *     @param RouteId 
68  			Unique Id of one navigation point in the path (well it
69  			should be navigation point - safer is to use location).
70  		
71  		 *   
72  		 * 
73  		 *   
74  		 *     @param Location 
75  			Location of one navigation point in the path.
76  		
77  		 *   
78  		 * 
79  		 */
80  		public PathList(
81  			UnrealId RouteId,  Location Location
82  		) {
83  			
84  					this.RouteId = RouteId;
85  				
86  					this.Location = Location;
87  				
88  		}
89      
90      	/**
91  		 * Cloning constructor from the full message.
92  		 *
93  		 * @param original
94  		 */
95  		public PathList(PathList original) {		
96  			
97  					this.RouteId = original.getRouteId()
98   	;
99  				
100 					this.Location = original.getLocation()
101  	;
102 				
103 			this.SimTime = original.getSimTime();			
104 		}
105 		
106 	   		
107 			protected long SimTime;
108 				
109 			/**
110 			 * Simulation time in MILLI SECONDS !!!
111 			 */	
112 			@Override
113 			public long getSimTime() {
114 				return SimTime;
115 			}
116 						
117 			/**
118 			 * Used by Yylex to slip correct time of the object or programmatically.
119 			 */
120 			protected void setSimTime(long SimTime) {
121 				this.SimTime = SimTime;
122 			}
123 	   	
124     	
125 	    /**
126          * 
127 			Unique Id of one navigation point in the path (well it
128 			should be navigation point - safer is to use location).
129 		 
130          */
131         protected
132          UnrealId RouteId =
133        	null;
134 	
135  		/**
136          * 
137 			Unique Id of one navigation point in the path (well it
138 			should be navigation point - safer is to use location).
139 		 
140          */
141         public  UnrealId getRouteId()
142  	 {
143     					return RouteId;
144     				}
145     			
146     	
147 	    /**
148          * 
149 			Location of one navigation point in the path.
150 		 
151          */
152         protected
153          Location Location =
154        	null;
155 	
156  		/**
157          * 
158 			Location of one navigation point in the path.
159 		 
160          */
161         public  Location getLocation()
162  	 {
163     					return Location;
164     				}
165     			
166  		
167  	    public String toString() {
168             return
169             	super.toString() + "[" +
170             	
171 		              			"RouteId = " + String.valueOf(getRouteId()
172  	) + " | " + 
173 		              		
174 		              			"Location = " + String.valueOf(getLocation()
175  	) + " | " + 
176 		              		
177 				"]";           		
178         }
179  	
180  		
181  		public String toHtmlString() {
182  			return super.toString() + "[<br/>" +
183             	
184 		              			"<b>RouteId</b> = " + String.valueOf(getRouteId()
185  	) + " <br/> " + 
186 		              		
187 		              			"<b>Location</b> = " + String.valueOf(getLocation()
188  	) + " <br/> " + 
189 		              		
190 				"<br/>]";     
191 		}
192  	
193  		
194  		// --- Extra Java from XML BEGIN (extra/code/java/javapart/classcategory[@name=all]) ---
195         	
196 		// --- Extra Java from XML END (extra/code/java/javapart/classcategory[@name=all]) ---
197 		
198 	    // --- Extra Java from XML BEGIN (extra/code/java/javapart/classcategory[@name=event+classtype[@name=impl]) ---
199 	        
200 	    // --- Extra Java from XML END (extra/code/java/javapart/classcategory[@name=event+classtype[@name=impl]) ---        	            	
201  	
202 		}
203