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