VR-Link API Documentation for HLA 1.3
vrlRtiAmb13.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 1992-2010 VT MAK
3 ** All rights reserved.
4 *********************************************************************/
5 
9 
10 #if DtHLA
11 #if !DtHLA_1516
12 
13 #ifndef DtVrlRtiAmbassador_H_
14 #define DtVrlRtiAmbassador_H_
15 
16 
17 #include <RTI.hh>
18 
19 #include <vlutil/vlMachineTypes.h>
20 
24 class DT_DLL_VL DtVrlRtiAmbassador
25 {
26 public:
27 
29  DtVrlRtiAmbassador();
30 
32  virtual ~DtVrlRtiAmbassador();
33 
34 private:
36  DtVrlRtiAmbassador(const DtVrlRtiAmbassador& orig);
37 
39  DtVrlRtiAmbassador& operator=(const DtVrlRtiAmbassador& orig);
40 
41 public:
42 
45  virtual RTI::RTIambassador* rtiAmb();
46 
47  virtual void createFederationExecution (
48  const char *executionName,
49  const char *FED) = 0;
50 
51  virtual void destroyFederationExecution (
52  const char *executionName) = 0;
53 
54  virtual RTI::FederateHandle joinFederationExecution (
55  const char* yourName,
56  const char* executionName,
57  RTI::FederateAmbassadorPtr federateAmbassadorReference) = 0;
58 
59  virtual void resignFederationExecution(
60  RTI::ResignAction theAction) = 0;
61 
62  virtual void registerFederationSynchronizationPoint(
63  const char* label,
64  const char* theTag) = 0;
65 
66  virtual void registerFederationSynchronizationPoint(
67  const char* label,
68  const char* theTag,
69  const RTI::FederateHandleSet& syncSet) = 0;
70 
71  virtual void synchronizationPointAchieved(
72  const char* label) = 0;
73 
74  virtual void requestFederationSave (
75  const char* label,
76  const RTI::FedTime& theTime) = 0;
77 
78  virtual void requestFederationSave (
79  const char *label) = 0;
80 
81  virtual void federateSaveBegun() = 0;
82 
83  virtual void federateSaveComplete() = 0;
84 
85  virtual void federateSaveNotComplete() = 0;
86 
87  virtual void requestFederationRestore(const char* label) = 0;
88 
89  virtual void federateRestoreComplete() = 0;
90 
91  virtual void federateRestoreNotComplete() = 0;
92 
93  virtual void publishObjectClass(
94  RTI::ObjectClassHandle theClass,
95  const RTI::AttributeHandleSet& attributeList) = 0;
96 
97  virtual void unpublishObjectClass(
98  RTI::ObjectClassHandle theClass) = 0;
99 
100  virtual void publishInteractionClass(
101  RTI::InteractionClassHandle theInteraction) = 0;
102 
103  virtual void unpublishInteractionClass(
104  RTI::InteractionClassHandle theInteraction) = 0;
105 
106  virtual void subscribeObjectClassAttributes(
107  RTI::ObjectClassHandle theClass,
108  const RTI::AttributeHandleSet& attributeList,
109  RTI::Boolean active = RTI::RTI_TRUE) = 0;
110 
111  virtual void unsubscribeObjectClass(
112  RTI::ObjectClassHandle theClass) = 0;
113 
114  virtual void subscribeInteractionClass(
115  RTI::InteractionClassHandle theClass,
116  RTI::Boolean active = RTI::RTI_TRUE) = 0;
117 
118  virtual void unsubscribeInteractionClass(
119  RTI::InteractionClassHandle theClass) = 0;
120 
121  virtual RTI::ObjectHandle registerObjectInstance(
122  RTI::ObjectClassHandle theClass, const char* theObject) = 0;
123 
124  virtual RTI::ObjectHandle registerObjectInstance(
125  RTI::ObjectClassHandle theClass) = 0;
126 
127  virtual RTI::EventRetractionHandle updateAttributeValues(
128  RTI::ObjectHandle theObject,
129  const RTI::AttributeHandleValuePairSet& theAttributes,
130  const RTI::FedTime& theTime,
131  const char* theTag) = 0;
132 
133  virtual void updateAttributeValues(
134  RTI::ObjectHandle theObject,
135  const RTI::AttributeHandleValuePairSet& theAttributes,
136  const char* theTag) = 0;
137 
138  virtual RTI::EventRetractionHandle sendInteraction(
139  RTI::InteractionClassHandle theInteraction,
140  const RTI::ParameterHandleValuePairSet& theParameters,
141  const RTI::FedTime& theTime,
142  const char* theTag) = 0;
143 
144  virtual void sendInteraction(
145  RTI::InteractionClassHandle theInteraction,
146  const RTI::ParameterHandleValuePairSet& theParameters,
147  const char* theTag) = 0;
148 
149  virtual RTI::EventRetractionHandle deleteObjectInstance(
150  RTI::ObjectHandle theObject,
151  const RTI::FedTime& theTime,
152  const char* theTag) = 0;
153 
154  virtual void deleteObjectInstance(
155  RTI::ObjectHandle theObject,
156  const char* theTag) = 0;
157 
158  virtual void localDeleteObjectInstance(
159  RTI::ObjectHandle theObject) = 0;
160 
161  virtual void changeAttributeTransportationType (
162  RTI::ObjectHandle theObject,
163  const RTI::AttributeHandleSet& theAttributes,
164  RTI::TransportationHandle theType) = 0;
165 
166  virtual void changeInteractionTransportationType (
167  RTI::InteractionClassHandle theClass,
168  RTI::TransportationHandle theType) = 0;
169 
170  virtual void requestObjectAttributeValueUpdate (
171  RTI::ObjectHandle theObject,
172  const RTI::AttributeHandleSet& theAttributes) = 0;
173 
174  virtual void requestClassAttributeValueUpdate (
175  RTI::ObjectClassHandle theClass,
176  const RTI::AttributeHandleSet& theAttributes) = 0;
177 
178  virtual void unconditionalAttributeOwnershipDivestiture(
179  RTI::ObjectHandle theObject,
180  const RTI::AttributeHandleSet& theAttributes) = 0;
181 
182  virtual void negotiatedAttributeOwnershipDivestiture(
183  RTI::ObjectHandle theObject,
184  const RTI::AttributeHandleSet& theAttributes,
185  const char* theTag) = 0;
186 
187  virtual void attributeOwnershipAcquisition(
188  RTI::ObjectHandle theObject,
189  const RTI::AttributeHandleSet& desiredAttributes,
190  const char* theTag) = 0;
191 
192  virtual void attributeOwnershipAcquisitionIfAvailable(
193  RTI::ObjectHandle theObject,
194  const RTI::AttributeHandleSet& desiredAttributes) = 0;
195 
196  virtual RTI::AttributeHandleSet* attributeOwnershipReleaseResponse(
197  RTI::ObjectHandle theObject,
198  const RTI::AttributeHandleSet& theAttributes) = 0;
199 
200  virtual void cancelNegotiatedAttributeOwnershipDivestiture(
201  RTI::ObjectHandle theObject,
202  const RTI::AttributeHandleSet& theAttributes) = 0;
203 
204  virtual void cancelAttributeOwnershipAcquisition(
205  RTI::ObjectHandle theObject,
206  const RTI::AttributeHandleSet& theAttributes) = 0;
207 
208  virtual void queryAttributeOwnership(
209  RTI::ObjectHandle theObject,
210  RTI::AttributeHandle theAttribute) = 0;
211 
212  virtual RTI::Boolean isAttributeOwnedByFederate(
213  RTI::ObjectHandle theObject,
214  RTI::AttributeHandle theAttribute) = 0;
215 
216  virtual void enableTimeRegulation (
217  const RTI::FedTime& theFederateTime,
218  const RTI::FedTime& theLookahead) = 0;
219 
220  virtual void disableTimeRegulation() = 0;
221 
222  virtual void enableTimeConstrained() = 0;
223 
224  virtual void disableTimeConstrained() = 0;
225 
226  virtual void timeAdvanceRequest(
227  const RTI::FedTime& theTime) = 0;
228 
229  virtual void timeAdvanceRequestAvailable (
230  const RTI::FedTime& theTime) = 0;
231 
232  virtual void nextEventRequest(
233  const RTI::FedTime& theTime) = 0;
234 
235  virtual void nextEventRequestAvailable (
236  const RTI::FedTime& theTime) = 0;
237 
238  virtual void flushQueueRequest (
239  const RTI::FedTime& theTime) = 0;
240 
241  virtual void enableAsynchronousDelivery() = 0;
242 
243  virtual void disableAsynchronousDelivery() = 0;
244 
245  virtual void queryLBTS(RTI::FedTime& theTime) = 0;
246 
247  virtual void queryFederateTime(RTI::FedTime& theTime) = 0;
248 
249  virtual void queryMinNextEventTime (
250  RTI::FedTime& theTime) = 0;
251 
252  virtual void modifyLookahead (
253  const RTI::FedTime& theLookahead) = 0;
254 
255  virtual void queryLookahead (
256  RTI::FedTime& theTime) = 0;
257 
258  virtual void retract(
259  RTI::EventRetractionHandle theHandle) = 0;
260 
261  virtual void changeAttributeOrderType(
262  RTI::ObjectHandle theObject,
263  const RTI::AttributeHandleSet& theAttributes,
264  RTI::OrderingHandle theType) = 0;
265 
266  virtual void changeInteractionOrderType(
267  RTI::InteractionClassHandle theClass,
268  RTI::OrderingHandle theType) = 0;
269 
270  virtual RTI::Region* createRegion (
271  RTI::SpaceHandle theSpace,
272  RTI::ULong numberOfExtents) = 0;
273 
274  virtual void notifyAboutRegionModification (
275  RTI::Region &theRegion) = 0;
276 
277  virtual void deleteRegion(RTI::Region *theRegion) = 0;
278 
279  virtual RTI::ObjectHandle registerObjectInstanceWithRegion(
280  RTI::ObjectClassHandle theClass,
281  const char* theObject,
282  RTI::AttributeHandle theAttributes[],
283  RTI::Region* theRegions[],
284  RTI::ULong theNumberOfHandles) = 0;
285 
286  virtual RTI::ObjectHandle registerObjectInstanceWithRegion(
287  RTI::ObjectClassHandle theClass,
288  RTI::AttributeHandle theAttributes[],
289  RTI::Region* theRegions[],
290  RTI::ULong theNumberOfHandles) = 0;
291 
292  virtual void associateRegionForUpdates (
293  RTI::Region& theRegion,
294  RTI::ObjectHandle theObject,
295  const RTI::AttributeHandleSet& theAttributes) = 0;
296 
297  virtual void unassociateRegionForUpdates(
298  RTI::Region& theRegion,
299  RTI::ObjectHandle theObject) = 0;
300 
301  virtual void subscribeObjectClassAttributesWithRegion(
302  RTI::ObjectClassHandle theClass,
303  RTI::Region& theRegion,
304  const RTI::AttributeHandleSet &attributeList,
305  RTI::Boolean active = RTI::RTI_TRUE) = 0;
306 
307  virtual void unsubscribeObjectClassWithRegion(
308  RTI::ObjectClassHandle theClass,
309  RTI::Region& theRegion) = 0;
310 
311  virtual void subscribeInteractionClassWithRegion (
312  RTI::InteractionClassHandle theClass,
313  RTI::Region& theRegion,
314  RTI::Boolean active = RTI::RTI_TRUE) = 0;
315 
316  virtual void unsubscribeInteractionClassWithRegion (
317  RTI::InteractionClassHandle theClass,
318  RTI::Region& theRegion) = 0;
319 
320  virtual RTI::EventRetractionHandle sendInteractionWithRegion(
321  RTI::InteractionClassHandle theInteraction,
322  const RTI::ParameterHandleValuePairSet &theParameters,
323  const RTI::FedTime& theTime,
324  const char* theTag,
325  const RTI::Region& theRegion) = 0;
326 
327  virtual void sendInteractionWithRegion(
328  RTI::InteractionClassHandle theInteraction,
329  const RTI::ParameterHandleValuePairSet &theParameters,
330  const char* theTag,
331  const RTI::Region& theRegion) = 0;
332 
333  virtual void requestClassAttributeValueUpdateWithRegion(
334  RTI::ObjectClassHandle theClass,
335  const RTI::AttributeHandleSet& theAttributes,
336  const RTI::Region& theRegion) = 0;
337 
338  virtual RTI::ObjectClassHandle getObjectClassHandle (
339  const char* theName) = 0;
340 
341  virtual char* getObjectClassName (
342  RTI::ObjectClassHandle theHandle) = 0;
343 
344  virtual RTI::AttributeHandle getAttributeHandle (
345  const char* theName,
346  RTI::ObjectClassHandle whichClass) = 0;
347 
348  virtual char* getAttributeName (
349  RTI::AttributeHandle theHandle,
350  RTI::ObjectClassHandle whichClass) = 0;
351 
352  virtual RTI::InteractionClassHandle getInteractionClassHandle (
353  const char* theName) = 0;
354 
355  virtual char* getInteractionClassName (
356  RTI::InteractionClassHandle theHandle) = 0;
357 
358  virtual RTI::ParameterHandle getParameterHandle (
359  const char* theName,
360  RTI::InteractionClassHandle whichClass) = 0;
361 
362  virtual char* getParameterName (
363  RTI::ParameterHandle theHandle,
364  RTI::InteractionClassHandle whichClass) = 0;
365 
366  virtual RTI::ObjectHandle getObjectInstanceHandle(
367  const char* theName) = 0;
368 
369  virtual char* getObjectInstanceName(
370  RTI::ObjectHandle theHandle) = 0;
371 
372  virtual RTI::SpaceHandle getRoutingSpaceHandle (
373  const char* theName) = 0;
374 
375  virtual const char* getRoutingSpaceName (
376  const RTI::SpaceHandle theHandle) = 0;
377 
378  virtual RTI::DimensionHandle getDimensionHandle(
379  const char* theName,
380  RTI::SpaceHandle whichSpace) = 0;
381 
382  virtual char* getDimensionName(
383  RTI::DimensionHandle theHandle,
384  RTI::SpaceHandle whichSpace) = 0;
385 
386  virtual RTI::SpaceHandle
387  getAttributeRoutingSpaceHandle(
388  RTI::AttributeHandle theHandle,
389  RTI::ObjectClassHandle whichClass) = 0;
390 
391  virtual RTI::ObjectClassHandle getObjectClass (
392  RTI::ObjectHandle theObject) = 0;
393 
394  virtual RTI::SpaceHandle getInteractionRoutingSpaceHandle(
395  RTI::InteractionClassHandle theHandle) = 0;
396 
397  virtual RTI::TransportationHandle getTransportationHandle(
398  const char *theName) = 0;
399 
400  virtual char* getTransportationName(
401  RTI::TransportationHandle theHandle) = 0;
402 
403  virtual RTI::OrderingHandle getOrderingHandle(
404  const char *theName) = 0;
405 
406  virtual char* getOrderingName(
407  RTI::OrderingHandle theHandle) = 0;
408 
409  virtual void enableClassRelevanceAdvisorySwitch() = 0;
410 
411  virtual void disableClassRelevanceAdvisorySwitch() = 0;
412 
413  virtual void enableAttributeRelevanceAdvisorySwitch() = 0;
414 
415  virtual void disableAttributeRelevanceAdvisorySwitch() = 0;
416 
417  virtual void enableAttributeScopeAdvisorySwitch() = 0;
418 
419  virtual void disableAttributeScopeAdvisorySwitch() = 0;
420 
421  virtual void enableInteractionRelevanceAdvisorySwitch() = 0;
422 
423  virtual void disableInteractionRelevanceAdvisorySwitch() = 0;
424 
425  virtual RTI::Boolean tick() = 0;
426 
427  virtual RTI::Boolean tick(
428  RTI::TickTime minimum,
429  RTI::TickTime maximum) = 0;
430 
431  virtual RTI::RegionToken getRegionToken(RTI::Region*) = 0;
432 
433  virtual RTI::Region* getRegion(RTI::RegionToken) = 0;
434 };
435 
436 #endif
437 #endif
438 #endif
439 
Document ID: Generated on Wed Aug 14 15:35:11 EDT 2013 from SVN revision 130445
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)