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