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 SPTH.
19           		
20           *
21           *  <p></p><p></p>
22           *  Complete message documentation:               
23           *  
24  		Start of the path list sent as an response to GETPATH command
25  		(IPTH messages).
26  	
27           */
28   	public class PathListStart 
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      		"SPTH {MessageId text} ";
37      
38      	
39      	
40      	/**
41      	 * Parameter-less contructor for the message.
42      	 */
43  		public PathListStart()
44  		{
45  		}
46  	
47      	
48      	
49      	
50      	/**
51  		 * Creates new instance of the message PathListStart.
52  		 * 
53  		Start of the path list sent as an response to GETPATH command
54  		(IPTH messages).
55  	
56  		 * Corresponding GameBots message
57  		 *   
58  		 *   is
59  		 *   SPTH.
60  		 * 
61   	  	 * 
62  		 *   
63  		 *     @param MessageId 
64  			An Id matching the one sent by client. Allows bot to match
65  			answer with right query.
66  		
67  		 *   
68  		 * 
69  		 */
70  		public PathListStart(
71  			String MessageId
72  		) {
73  			
74  					this.MessageId = MessageId;
75  				
76  		}
77      
78      	/**
79  		 * Cloning constructor from the full message.
80  		 *
81  		 * @param original
82  		 */
83  		public PathListStart(PathListStart original) {		
84  			
85  					this.MessageId = original.getMessageId()
86   	;
87  				
88  			this.SimTime = original.getSimTime();			
89  		}
90  		
91  	   		
92  			protected long SimTime;
93  				
94  			/**
95  			 * Simulation time in MILLI SECONDS !!!
96  			 */	
97  			@Override
98  			public long getSimTime() {
99  				return SimTime;
100 			}
101 						
102 			/**
103 			 * Used by Yylex to slip correct time of the object or programmatically.
104 			 */
105 			protected void setSimTime(long SimTime) {
106 				this.SimTime = SimTime;
107 			}
108 	   	
109     	
110 	    /**
111          * 
112 			An Id matching the one sent by client. Allows bot to match
113 			answer with right query.
114 		 
115          */
116         protected
117          String MessageId =
118        	null;
119 	
120  		/**
121          * 
122 			An Id matching the one sent by client. Allows bot to match
123 			answer with right query.
124 		 
125          */
126         public  String getMessageId()
127  	 {
128     					return MessageId;
129     				}
130     			
131  		
132  	    public String toString() {
133             return
134             	super.toString() + "[" +
135             	
136 		              			"MessageId = " + String.valueOf(getMessageId()
137  	) + " | " + 
138 		              		
139 				"]";           		
140         }
141  	
142  		
143  		public String toHtmlString() {
144  			return super.toString() + "[<br/>" +
145             	
146 		              			"<b>MessageId</b> = " + String.valueOf(getMessageId()
147  	) + " <br/> " + 
148 		              		
149 				"<br/>]";     
150 		}
151  	 
152  	    public String toJsonLiteral() {
153             return "PathListStart(null, "
154             		
155                    + ")";
156         }
157  	
158  		
159  		// --- Extra Java from XML BEGIN (extra/code/java/javapart/classcategory[@name=all]) ---
160         	
161 		// --- Extra Java from XML END (extra/code/java/javapart/classcategory[@name=all]) ---
162 		
163 	    // --- Extra Java from XML BEGIN (extra/code/java/javapart/classcategory[@name=event+classtype[@name=impl]) ---
164 	        
165 	    // --- Extra Java from XML END (extra/code/java/javapart/classcategory[@name=event+classtype[@name=impl]) ---        	            	
166  	
167 		}
168