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