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=shared]+classtype[@name=abstract] BEGIN
13  		
14  		// --- IMPORTS FROM extra/code/java/javapart/classcategory[@name=shared]+classtype[@name=abstract] END
15      
16   		/**
17           *  
18              				Abstract definition of the shared part of the GameBots2004 message ATR.  
19              			
20           *
21           *  <p></p><p></p>
22           *  Complete message documentation:               
23           *  
24  		Synchronous message. Contains the results of automatically
25  		casted rays. One ATR message is for one casted ray. New
26  		automatically casted rays can be defined by ADDRAY command and
27  		removed by REMOVERAY command.
28  	
29           */
30   	public abstract class AutoTraceRayShared 
31    						extends InfoMessage
32    						implements ISharedWorldObject
33    						
34  	    {
35   	
36      	
37      	
38      	/**
39      	 * Parameter-less contructor for the message.
40      	 */
41  		public AutoTraceRayShared()
42  		{
43  		}
44  		
45  				// abstract definition of the shared-part of the message, no more constructors is needed
46  			
47  	   		
48  			protected long SimTime;
49  				
50  			/**
51  			 * Simulation time in MILLI SECONDS !!!
52  			 */	
53  			@Override
54  			public long getSimTime() {
55  				return SimTime;
56  			}
57  						
58  			/**
59  			 * Used by Yylex to slip correct time of the object or programmatically.
60  			 */
61  			protected void setSimTime(long SimTime) {
62  				this.SimTime = SimTime;
63  			}
64  	   		
65  							
66  							public static final Set<Token> SharedPropertyTokens;
67  	
68  							static {
69  								Set<Token> tokens = new HashSet<Token>();
70  								
71  								SharedPropertyTokens = Collections.unmodifiableSet(tokens);
72  							}
73  	    				
74  	    			
75  	    				@Override
76  		    			public abstract 
77  		    			AutoTraceRayShared clone();
78  		    			
79  						@Override
80  						public Class getCompositeClass() {
81  							return AutoTraceRay.class;
82  						}
83  	
84  						
85  		    			
86   		/**
87           * 
88  			An Id for this ray (should be unique), assigned by the user
89  			when adding ray.
90  		 
91           */
92          public abstract UnrealId getId()
93   	;
94  		    			
95   		
96   	    public String toString() {
97              return
98              	super.toString() + "[" +
99              	
100 		              			"Id = " + String.valueOf(getId()
101  	) + " | " + 
102 		              		
103 				"]";           		
104         }
105  	
106  		
107  		public String toHtmlString() {
108  			return super.toString() + "[<br/>" +
109             	
110 		              			"<b>Id</b> = " + String.valueOf(getId()
111  	) + " <br/> " + 
112 		              		
113 				"<br/>]";     
114 		}
115  	
116  		
117  		// --- Extra Java from XML BEGIN (extra/code/java/javapart/classcategory[@name=all]) ---
118         	
119 		// --- Extra Java from XML END (extra/code/java/javapart/classcategory[@name=all]) ---
120 		
121 	    // --- Extra Java from XML BEGIN (extra/code/java/javapart/classcategory[@name=shared+classtype[@name=abstract]) ---
122 	        
123 	    // --- Extra Java from XML END (extra/code/java/javapart/classcategory[@name=shared+classtype[@name=abstract]) ---        	            	
124  	
125 		}
126