MAK RTIspy API Documentation for HLA 4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
simpleFederateAmbassador.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2010 MaK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
6 #pragma once
7 
8 #pragma warning(disable: 4251)
9 #pragma warning(disable: 4786)
10 #pragma warning(disable: 4290)
11 
12 #include <RTI/RTI1516.h>
13 #include <RTI/NullFederateAmbassador.h>
14 #include <string>
15 #include <map>
16 
17 
18 class DtSimpleData;
19 
21 class MyFederateAmbassador : public rti1516_2025::NullFederateAmbassador
22 {
23 public:
24 
25  MyFederateAmbassador(DtSimpleData& data);
26 
27  virtual ~MyFederateAmbassador();
28 
29  virtual void connectionLost(std::wstring const& faultDescription) override;
30 
31  // 4.8
32  virtual void reportFederationExecutions(
33  rti1516_2025::FederationExecutionInformationVector const& theFederationExecutionInformationList) override;
34 
35  // 4.10
36  virtual void reportFederationExecutionMembers(std::wstring const& federationName,
37  rti1516_2025::FederationExecutionMemberInformationVector const& report) override;
38 
39  // 4.11
40  virtual void reportFederationExecutionDoesNotExist(std::wstring const& federationName) override;
41 
42  // 4.13
43  virtual void federateResigned(const std::wstring& reason) override;
44 
45  // 6.3
46  virtual void objectInstanceNameReservationSucceeded(std::wstring const& theObjectInstanceName) override;
47 
48  // 6.3
49  virtual void objectInstanceNameReservationFailed(std::wstring const& theObjectInstanceName) override;
50 
51  // 6.6
52  virtual void multipleObjectInstanceNameReservationSucceeded(std::set<std::wstring> const& theObjectInstanceNames) override;
53 
54  // 6.6
55  virtual void multipleObjectInstanceNameReservationFailed(std::set<std::wstring> const& theObjectInstanceNames) override;
56 
57  // 6.9
58  virtual void discoverObjectInstance(
59  rti1516_2025::ObjectInstanceHandle const& theObject,
60  rti1516_2025::ObjectClassHandle const& theObjectClass,
61  std::wstring const& theObjectInstanceName,
62  rti1516_2025::FederateHandle const& producingFederate) override;
63 
64  // 6.11
65  virtual void reflectAttributeValues(
66  rti1516_2025::ObjectInstanceHandle const& theObject,
67  rti1516_2025::AttributeHandleValueMap const& theAttributeValues,
68  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
69  rti1516_2025::TransportationTypeHandle const& theType,
70  rti1516_2025::FederateHandle const& theProducingFederate,
71  rti1516_2025::RegionHandleSet const* theOptionalSentRegions) override;
72 
73  // 6.11
74  virtual void reflectAttributeValues(
75  rti1516_2025::ObjectInstanceHandle const& theObject,
76  rti1516_2025::AttributeHandleValueMap const& theAttributeValues,
77  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
78  rti1516_2025::TransportationTypeHandle const& theType,
79  rti1516_2025::FederateHandle const& theProducingFederate,
80  rti1516_2025::RegionHandleSet const* theOptionalSentRegions,
81  rti1516_2025::LogicalTime const& theTime,
82  rti1516_2025::OrderType theSentOrder,
83  rti1516_2025::OrderType theReceivedOrder,
84  rti1516_2025::MessageRetractionHandle const* theOptionalRetraction) override;
85 
86  // 6.13
87  virtual void receiveInteraction(
88  rti1516_2025::InteractionClassHandle const& theInteraction,
89  rti1516_2025::ParameterHandleValueMap const& theParameterValues,
90  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
91  rti1516_2025::TransportationTypeHandle const& theType,
92  rti1516_2025::FederateHandle const& theProducingFederate,
93  const rti1516_2025::RegionHandleSet* theOptionalSentRegions) override;
94 
95  // 6.13
96  virtual void receiveInteraction(
97  rti1516_2025::InteractionClassHandle const& theInteraction,
98  rti1516_2025::ParameterHandleValueMap const& theParameterValues,
99  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
100  rti1516_2025::TransportationTypeHandle const& theType,
101  rti1516_2025::FederateHandle const& theProducingFederate,
102  rti1516_2025::RegionHandleSet const* theOptionalSentRegions,
103  rti1516_2025::LogicalTime const& theTime,
104  rti1516_2025::OrderType theSentOrder,
105  rti1516_2025::OrderType theReceivedOrder,
106  rti1516_2025::MessageRetractionHandle const* theOptionalRetraction) override;
107 
108  // 6.15
109  virtual void receiveDirectedInteraction(
110  rti1516_2025::InteractionClassHandle const& theInteraction,
111  rti1516_2025::ObjectInstanceHandle const& theObject,
112  rti1516_2025::ParameterHandleValueMap const& theParameterValues,
113  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
114  rti1516_2025::TransportationTypeHandle const& theType,
115  rti1516_2025::FederateHandle const& producingFederate) override;
116 
117  // 6.15
118  virtual void receiveDirectedInteraction(
119  rti1516_2025::InteractionClassHandle const& theInteraction,
120  rti1516_2025::ObjectInstanceHandle const& theObject,
121  rti1516_2025::ParameterHandleValueMap const& theParameterValues,
122  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
123  rti1516_2025::TransportationTypeHandle const& theType,
124  rti1516_2025::FederateHandle const& theProducingFederate,
125  rti1516_2025::LogicalTime const& theTime,
126  rti1516_2025::OrderType theSentOrder,
127  rti1516_2025::OrderType theReceivedOrder,
128  rti1516_2025::MessageRetractionHandle const* theOptionalRetraction) override;
129 
130  // 6.17
131  virtual void removeObjectInstance(
132  rti1516_2025::ObjectInstanceHandle const& theObject,
133  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
134  rti1516_2025::FederateHandle const& theProducingFederate) override;
135 
136  // 6.17
137  virtual void removeObjectInstance(
138  rti1516_2025::ObjectInstanceHandle const& theObject,
139  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
140  rti1516_2025::FederateHandle const& theProducingFederate,
141  rti1516_2025::LogicalTime const& theTime,
142  rti1516_2025::OrderType theSentOrder,
143  rti1516_2025::OrderType theReceivedOrder,
144  rti1516_2025::MessageRetractionHandle const* theOptionalRetraction) override;
145 
146  // 6.26
147  virtual void confirmAttributeTransportationTypeChange(
148  rti1516_2025::ObjectInstanceHandle const& theObject,
149  rti1516_2025::AttributeHandleSet const& theAttributes,
150  rti1516_2025::TransportationTypeHandle const& theTransportation) override;
151 
152  // 6.29
153  virtual void reportAttributeTransportationType(
154  rti1516_2025::ObjectInstanceHandle const& theObject,
155  rti1516_2025::AttributeHandle const& theAttribute,
156  rti1516_2025::TransportationTypeHandle const& theTransportation) override;
157 
158  // 6.31
159  virtual void confirmInteractionTransportationTypeChange(
160  rti1516_2025::InteractionClassHandle const& theInteraction,
161  rti1516_2025::TransportationTypeHandle const& theTransportation) override;
162 
163  // 6.33
164  virtual void reportInteractionTransportationType(
165  rti1516_2025::FederateHandle const& federateHandle,
166  rti1516_2025::InteractionClassHandle const& theInteraction,
167  rti1516_2025::TransportationTypeHandle const& theTransportation) override;
168 
170  virtual std::wstring& getParameterName(rti1516_2025::InteractionClassHandle const& classHandle,
171  rti1516_2025::ParameterHandle const& parameterHandle, std::wstring& parameterName) const;
172  virtual void printParameterValues(rti1516_2025::InteractionClassHandle const& classHandle,
173  rti1516_2025::ParameterHandleValueMap const& parameterValues) const;
174  virtual std::wstring& getAttributeName(rti1516_2025::ObjectClassHandle const& classHandle,
175  rti1516_2025::AttributeHandle const& attributeHandle, std::wstring& attributeName) const;
176  virtual void printAttributeHandles(rti1516_2025::ObjectInstanceHandle const& objectHandle,
177  rti1516_2025::AttributeHandleSet const& attributeHandles) const;
178  virtual void printAttributeValues(rti1516_2025::ObjectInstanceHandle const& objectHandle,
179  rti1516_2025::AttributeHandleValueMap const& attrVals) const;
180 
181 
182 public:
183 
184  // Access to shared data
185  DtSimpleData& myData;
186 };
rti1516_2025::LogicalTime
Definition: LogicalTime.h:30
rti1516_2025::AttributeHandleSet
std::set< AttributeHandle > AttributeHandleSet
Definition: Typedefs.h:29
MyFederateAmbassador::connectionLost
virtual void connectionLost(std::wstring const &faultDescription) override
MyFederateAmbassador::objectInstanceNameReservationFailed
virtual void objectInstanceNameReservationFailed(std::wstring const &theObjectInstanceName)
RTI1516.h
A convenience header provided for developers that would like to include everything all at once...
rti1516_2025::FederationExecutionInformationVector
std::vector< FederationExecutionInformation > FederationExecutionInformationVector
Definition: Typedefs.h:112
DtSimpleData
Data for interacting with the federate ambassador.
Definition: rtiSimpleFedAmb13.h:15
MyFederateAmbassador::reportFederationExecutionMembers
virtual void reportFederationExecutionMembers(std::wstring const &federationName, rti1516_2025::FederationExecutionMemberInformationVector const &report) override
MyFederateAmbassador
Basic federate ambassador service callback implementation.
Definition: rtiSimpleFedAmb13.h:35
rti1516_2025::OrderType
OrderType
Definition: Enums.h:28
MyFederateAmbassador::receiveDirectedInteraction
void receiveDirectedInteraction(rti1516_2025::InteractionClassHandle const &interactionClass, rti1516_2025::ObjectInstanceHandle const &objectInstance, rti1516_2025::ParameterHandleValueMap const &parameterValues, rti1516_2025::VariableLengthData const &userSuppliedTag, rti1516_2025::TransportationTypeHandle const &transportationType, rti1516_2025::FederateHandle const &producingFederate) override
MyFederateAmbassador::multipleObjectInstanceNameReservationSucceeded
virtual void multipleObjectInstanceNameReservationSucceeded(std::set< std::wstring > const &theObjectInstanceNames) override
MyFederateAmbassador::receiveInteraction
virtual void receiveInteraction(RTI::InteractionClassHandle theInteraction, const RTI::ParameterHandleValuePairSet &theParameters, const RTI::FedTime &theTime, const char *theTag, RTI::EventRetractionHandle theHandle)
MyFederateAmbassador::objectInstanceNameReservationSucceeded
virtual void objectInstanceNameReservationSucceeded(std::wstring const &theObjectInstanceName)
MyFederateAmbassador::removeObjectInstance
virtual void removeObjectInstance(RTI::ObjectHandle theObject, const RTI::FedTime &theTime, const char *theTag, RTI::EventRetractionHandle theHandle)
MyFederateAmbassador::reportFederationExecutionDoesNotExist
virtual void reportFederationExecutionDoesNotExist(std::wstring const &federationName) override
MyFederateAmbassador::reflectAttributeValues
virtual void reflectAttributeValues(RTI::ObjectHandle theObject, const RTI::AttributeHandleValuePairSet &theAttributes, const RTI::FedTime &theTime, const char *theTag, RTI::EventRetractionHandle theHandle)
MyFederateAmbassador::reportInteractionTransportationType
virtual void reportInteractionTransportationType(rti1516_2025::FederateHandle const &federateHandle, rti1516_2025::InteractionClassHandle const &theInteraction, rti1516_2025::TransportationTypeHandle const &theTransportation) override
MyFederateAmbassador::reportFederationExecutions
virtual void reportFederationExecutions(rti1516_2025::FederationExecutionInformationVector const &theFederationExecutionInformationList) override
rti1516_2025::FederationExecutionMemberInformationVector
std::vector< FederationExecutionMemberInformation > FederationExecutionMemberInformationVector
Definition: Typedefs.h:129
MyFederateAmbassador::multipleObjectInstanceNameReservationFailed
virtual void multipleObjectInstanceNameReservationFailed(std::set< std::wstring > const &theObjectInstanceNames) override
MyFederateAmbassador::myData
DtSimpleData & myData
Definition: rtiSimpleFedAmb13.h:98
MyFederateAmbassador::printAttributeHandles
virtual void printAttributeHandles(rti1516_2025::ObjectInstanceHandle const &objectHandle, rti1516_2025::AttributeHandleSet const &attributeHandles) const
Help with printing callback data.
MyFederateAmbassador::discoverObjectInstance
virtual void discoverObjectInstance(RTI::ObjectHandle theObject, RTI::ObjectClassHandle theObjectClass, const char *theObjectName)
MyFederateAmbassador::federateResigned
virtual void federateResigned(const std::wstring &reason) override
MyFederateAmbassador::printAttributeValues
virtual void printAttributeValues(rti1516_2025::ObjectInstanceHandle const &objectHandle, rti1516_2025::AttributeHandleValueMap const &attrVals) const
Help with printing callback data.
MyFederateAmbassador::getParameterName
virtual std::wstring & getParameterName(rti1516_2025::InteractionClassHandle const &classHandle, rti1516_2025::ParameterHandle const &parameterHandle, std::wstring &parameterName) const
Help with printing callback data.
MyFederateAmbassador::confirmAttributeTransportationTypeChange
virtual void confirmAttributeTransportationTypeChange(rti1516_2025::ObjectInstanceHandle const &theObject, rti1516_2025::AttributeHandleSet const &theAttributes, rti1516_2025::TransportationTypeHandle const &theTransportation) override
MyFederateAmbassador::confirmInteractionTransportationTypeChange
virtual void confirmInteractionTransportationTypeChange(rti1516_2025::InteractionClassHandle const &theInteraction, rti1516_2025::TransportationTypeHandle const &theTransportation) override
rti1516_2025::AttributeHandleValueMap
std::map< AttributeHandle, VariableLengthData > AttributeHandleValueMap
Definition: Typedefs.h:39
MyFederateAmbassador::reportAttributeTransportationType
virtual void reportAttributeTransportationType(rti1516_2025::ObjectInstanceHandle const &theObject, rti1516_2025::AttributeHandle const &theAttribute, rti1516_2025::TransportationTypeHandle const &theTransportation) override
MyFederateAmbassador::getAttributeName
virtual std::wstring & getAttributeName(rti1516_2025::ObjectClassHandle const &classHandle, rti1516_2025::AttributeHandle const &attributeHandle, std::wstring &attributeName) const
Help with printing callback data.
MyFederateAmbassador::printParameterValues
virtual void printParameterValues(rti1516_2025::InteractionClassHandle const &classHandle, rti1516_2025::ParameterHandleValueMap const &parameterValues) const
Help with printing callback data.
rti1516_2025::NullFederateAmbassador
Definition: NullFederateAmbassador.h:20
MyFederateAmbassador::~MyFederateAmbassador
virtual ~MyFederateAmbassador()
NullFederateAmbassador.h
This file provides an example derivation of the rti1516_2025::FederateAmbassador with NULL actions fo...
MyFederateAmbassador::MyFederateAmbassador
MyFederateAmbassador(DtSimpleData &data)
rti1516_2025::VariableLengthData
Definition: VariableLengthData.h:28
rti1516_2025::ParameterHandleValueMap
std::map< ParameterHandle, VariableLengthData > ParameterHandleValueMap
Definition: Typedefs.h:44
rti1516_2025::RegionHandleSet
std::set< RegionHandle > RegionHandleSet
Definition: Typedefs.h:34
Document ID: Generated on Wed Jul 8 16:20:32 EDT 2026 from SVN revision 291616
Copyright © 2005-2025 MAK Technologies Inc. All Rights Reserved (www.mak.com)