View Javadoc

1   
2   	 	/**
3            IMPORTANT !!!
4   
5            DO NOT EDIT THIS FILE. IT IS GENERATED FROM approriate xml file in xmlresources/gbcommands BY
6            THE JavaClassesGenerator.xslt. MODIFY THAT FILE INSTEAD OF THIS ONE.
7            
8            Use Ant task process-gb-messages after that to generate .java files again.
9            
10           IMPORTANT END !!!
11          */
12   	package cz.cuni.amis.pogamut.ut2004.communication.messages.gbcommands;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.*;
13   		/**
14   		 * Representation of the GameBots2004 command FTRACE.
15   		 *
16   		 * 
17  		Will send a ray from specified location to specified
18  		destination, responds with FTR message. FTRACE uses FastTrace
19  		function, which is faster then Trace function, but still rather
20  		slow.
21  	
22           */
23   	public class FastTrace 
24  		extends CommandMessage
25  	        {
26  	        	
27  		        
28      	/** Example how the message looks like - used during parser tests. */
29      	public static final String PROTOTYPE =
30      		" {Id text}  {From 0,0,0}  {To 0,0,0} ";
31      
32  		/**
33  		 * Creates new instance of command FastTrace.
34  		 * 
35  		Will send a ray from specified location to specified
36  		destination, responds with FTR message. FTRACE uses FastTrace
37  		function, which is faster then Trace function, but still rather
38  		slow.
39  	
40  		 * Corresponding GameBots message for this command is
41  		 * FTRACE.
42  		 *
43  		 * 
44  		 *    @param Id 
45  			Message Id made up by you and echoed in response so you can
46  			match up response with query.
47  		
48  		 *    @param From 
49  			Origin point of the ray. If you won't support From
50  			attribute, current bot location will be taken as From.
51  		
52  		 *    @param To Target point of the ray.
53  		 */
54  		public FastTrace(
55  			String Id,  Location From,  Location To
56  		) {
57  			
58  				this.Id = Id;
59              
60  				this.From = From;
61              
62  				this.To = To;
63              
64  		}
65  
66  		
67  			/**
68  			 * Creates new instance of command FastTrace.
69  			 * 
70  		Will send a ray from specified location to specified
71  		destination, responds with FTR message. FTRACE uses FastTrace
72  		function, which is faster then Trace function, but still rather
73  		slow.
74  	
75  			 * Corresponding GameBots message for this command is
76  			 * FTRACE.
77  			 * <p></p>
78  			 * WARNING: this is empty-command constructor, you have to use setters to fill it up with data that should be sent to GameBots2004!
79  		     */
80  		    public FastTrace() {
81  		    }
82  			
83  		
84  		/**
85  		 * Cloning constructor.
86  		 *
87  		 * @param original
88  		 */
89  		public FastTrace(FastTrace original) {
90  		   
91  		        this.Id = original.Id;
92  		   
93  		        this.From = original.From;
94  		   
95  		        this.To = original.To;
96  		   
97  		}
98      
99  	        /**
100 	        
101 			Message Id made up by you and echoed in response so you can
102 			match up response with query.
103 		 
104 	        */
105 	        protected
106 	         String Id =
107 	       	
108 	        		null
109 	        	;
110 	
111 	        
112 	        
113  		/**
114          * 
115 			Message Id made up by you and echoed in response so you can
116 			match up response with query.
117 		 
118          */
119         public String getId()
120  	
121 	        {
122 	            return
123 	        	 Id;
124 	        }
125 	        
126 	        
127 	        
128  		
129  		/**
130          * 
131 			Message Id made up by you and echoed in response so you can
132 			match up response with query.
133 		 
134          */
135         public FastTrace 
136         setId(String Id)
137  	
138 			{
139 				this.Id = Id;
140 				return this;
141 			}
142 		
143 	        /**
144 	        
145 			Origin point of the ray. If you won't support From
146 			attribute, current bot location will be taken as From.
147 		 
148 	        */
149 	        protected
150 	         Location From =
151 	       	
152 	        		null
153 	        	;
154 	
155 	        
156 	        
157  		/**
158          * 
159 			Origin point of the ray. If you won't support From
160 			attribute, current bot location will be taken as From.
161 		 
162          */
163         public Location getFrom()
164  	
165 	        {
166 	            return
167 	        	 From;
168 	        }
169 	        
170 	        
171 	        
172  		
173  		/**
174          * 
175 			Origin point of the ray. If you won't support From
176 			attribute, current bot location will be taken as From.
177 		 
178          */
179         public FastTrace 
180         setFrom(Location From)
181  	
182 			{
183 				this.From = From;
184 				return this;
185 			}
186 		
187 	        /**
188 	        Target point of the ray. 
189 	        */
190 	        protected
191 	         Location To =
192 	       	
193 	        		null
194 	        	;
195 	
196 	        
197 	        
198  		/**
199          * Target point of the ray. 
200          */
201         public Location getTo()
202  	
203 	        {
204 	            return
205 	        	 To;
206 	        }
207 	        
208 	        
209 	        
210  		
211  		/**
212          * Target point of the ray. 
213          */
214         public FastTrace 
215         setTo(Location To)
216  	
217 			{
218 				this.To = To;
219 				return this;
220 			}
221 		
222  	    public String toString() {
223             return toMessage();
224         }
225  	
226  		public String toHtmlString() {
227 			return super.toString() + "[<br/>" +
228             	
229             	"<b>Id</b> = " +
230             	String.valueOf(getId()
231  	) +
232             	" <br/> " +
233             	
234             	"<b>From</b> = " +
235             	String.valueOf(getFrom()
236  	) +
237             	" <br/> " +
238             	
239             	"<b>To</b> = " +
240             	String.valueOf(getTo()
241  	) +
242             	" <br/> " +
243             	 
244             	"<br/>]"
245             ;
246 		}
247  	
248 		public String toMessage() {
249      		StringBuffer buf = new StringBuffer();
250      		buf.append("FTRACE");
251      		
252 						if (Id != null) {
253 							buf.append(" {Id " + Id + "}");
254 						}
255 					
256 					    if (From != null) {
257 					        buf.append(" {From " +
258 					            From.getX() + "," +
259 					            From.getY() + "," +
260 					            From.getZ() + "}");
261 					    }
262 					
263 					    if (To != null) {
264 					        buf.append(" {To " +
265 					            To.getX() + "," +
266 					            To.getY() + "," +
267 					            To.getZ() + "}");
268 					    }
269 					
270    			return buf.toString();
271    		}
272  	
273  		// --- Extra Java from XML BEGIN (extra/code/java)
274         	
275 		// --- Extra Java from XML END (extra/code/java)
276  	
277 	        }
278