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