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=local]+classtype[@name=abstract] BEGIN
13  		
14  		// --- IMPORTS FROM extra/code/java/javapart/classcategory[@name=local]+classtype[@name=abstract] END
15      
16   		/**
17           *  
18              				Abstract definition of the local part of the GameBots2004 message ALIVE.  
19              			
20           *
21           *  <p></p><p></p>
22           *  Complete message documentation:               
23           *  
24  		Synchronous message. Alive message are for confirmation, that
25  		the connection is still working. They are sent periodically with
26  		usual period of one second (this can change depending on the
27  		configuration of ControlServer)
28  	
29           */
30   	public abstract class AliveMessageLocal 
31    						extends InfoMessage
32    						implements ILocalWorldObject
33    						
34  	    {
35   	
36      	
37      	
38      	/**
39      	 * Parameter-less contructor for the message.
40      	 */
41  		public AliveMessageLocal()
42  		{
43  		}
44  		
45  				// abstract definition of the local-part of the message, no more constructors is needed
46  			
47  						
48  						public static final UnrealId AliveMessageId = UnrealId.get("AliveMessageId");
49  					
50  						
51  						public UnrealId getId() {						
52  							return cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.AliveMessage.AliveMessageId;
53  						}
54  					
55  	   		
56  			protected long SimTime;
57  				
58  			/**
59  			 * Simulation time in MILLI SECONDS !!!
60  			 */	
61  			@Override
62  			public long getSimTime() {
63  				return SimTime;
64  			}
65  						
66  			/**
67  			 * Used by Yylex to slip correct time of the object or programmatically.
68  			 */
69  			protected void setSimTime(long SimTime) {
70  				this.SimTime = SimTime;
71  			}
72  	   	
73  	    			
74  	    				@Override
75  		    			public abstract 
76  		    			AliveMessageLocal clone();
77  		    			
78  						@Override
79  						public Class getCompositeClass() {
80  							return AliveMessage.class;
81  						}
82  	
83  						
84  		    			
85   		/**
86           * 
87  			Game time when this message was send.
88  		 
89           */
90          public abstract double getTime()
91   	;
92  		    			
93      	
94      	
95      	
96      	public AliveMessageLocal getLocal() {
97  			return this;
98      	}
99  		public ISharedWorldObject getShared() {
100 		 	throw new UnsupportedOperationException("Could not return LOCAL");
101 		}
102 		public IStaticWorldObject getStatic() {
103 		    throw new UnsupportedOperationException("Could not return LOCAL");
104 		}
105  	
106  		
107  		
108  	    public String toString() {
109             return
110             	super.toString() + "[" +
111             	
112 		              			"Time = " + String.valueOf(getTime()
113  	) + " | " + 
114 		              		
115 				"]";           		
116         }
117  	
118  		
119  		public String toHtmlString() {
120  			return super.toString() + "[<br/>" +
121             	
122 		              			"<b>Time</b> = " + String.valueOf(getTime()
123  	) + " <br/> " + 
124 		              		
125 				"<br/>]";     
126 		}
127  	
128  		
129  		// --- Extra Java from XML BEGIN (extra/code/java/javapart/classcategory[@name=all]) ---
130         	
131 		// --- Extra Java from XML END (extra/code/java/javapart/classcategory[@name=all]) ---
132 		
133 	    // --- Extra Java from XML BEGIN (extra/code/java/javapart/classcategory[@name=local+classtype[@name=abstract]) ---
134 	        
135 	    // --- Extra Java from XML END (extra/code/java/javapart/classcategory[@name=local+classtype[@name=abstract]) ---        	            	
136  	
137 		}
138