MAK RTIspy API Documentation for HLA Evolved
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
rtiSimpleFedAmb1516_2025.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 {
20 public:
21  bool listFederationsReturned;
22 
23  bool connectionLost;
24  bool federateResigned;
25 
26  bool nameReservationReturned;
27  bool nameReservationSucceeded;
28 
29  std::map<rti1516_2025::ObjectClassHandle, std::wstring> objectClassMap;
30  std::map<rti1516_2025::ObjectInstanceHandle, std::wstring> objectInstanceNameMap;
31  std::map<rti1516_2025::ObjectInstanceHandle, rti1516_2025::ObjectClassHandle> objectInstanceClassMap;
32  rti1516_2025::TransportationTypeHandle bestEffortTransportationTypeHandle;
33  rti1516_2025::TransportationTypeHandle reliableTransportationTypeHandle;
34 
35  std::set<rti1516_2025::ObjectInstanceHandle> discoveredObjects;
36 
37  rti1516_2025::FederationExecutionInformationVector reportedFederationExecutions;
38  bool reportFederationExecutionMembersReceived;
39 
40  rti1516_2025::RTIambassador* rtiAmbassador;
41 
42  DtSimpleData()
43  {
44  clear();
45  }
46 
47  void clear()
48  {
49  connectionLost =
50  federateResigned =
51  listFederationsReturned =
52  nameReservationReturned =
53  nameReservationSucceeded = false;
54  objectClassMap.clear();
55  objectInstanceNameMap.clear();
56  objectInstanceClassMap.clear();
57  discoveredObjects.clear();
58  reportedFederationExecutions.clear();
59  }
60 };
61 
62 class MyFederateAmbassador : public rti1516_2025::NullFederateAmbassador
63 {
64 public:
65 
66  MyFederateAmbassador(DtSimpleData& data);
67 
68  virtual ~MyFederateAmbassador();
69 
70  // 4.4
71  virtual void connectionLost(
72  std::wstring const& faultDescription) override;
73 
74  // 4.8
75  virtual void reportFederationExecutions (
76  rti1516_2025::FederationExecutionInformationVector const& theFederationExecutionInformationList) override;
77 
78  // 4.10
79  virtual void reportFederationExecutionMembers(
80  std::wstring const& federationName,
81  rti1516_2025::FederationExecutionMemberInformationVector const& report) override;
82 
83  // 4.11
84  virtual void reportFederationExecutionDoesNotExist(
85  std::wstring const& federationName) override;
86 
87  // 4.13
88  virtual void federateResigned(
89  const std::wstring& reason) override;
90 
91  // 6.3
92  virtual void objectInstanceNameReservationSucceeded(
93  std::wstring const& theObjectInstanceName) override;
94 
95  // 6.3
96  virtual void objectInstanceNameReservationFailed(
97  std::wstring const& theObjectInstanceName) override;
98 
99  // 6.9
100  virtual void discoverObjectInstance(
101  rti1516_2025::ObjectInstanceHandle const& theObject,
102  rti1516_2025::ObjectClassHandle const& theObjectClass,
103  std::wstring const& theObjectInstanceName,
104  rti1516_2025::FederateHandle const& producingFederate) override;
105 
106  // 6.11
107  virtual void reflectAttributeValues(
108  rti1516_2025::ObjectInstanceHandle const& theObject,
109  rti1516_2025::AttributeHandleValueMap const& theAttributeValues,
110  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
111  rti1516_2025::TransportationTypeHandle const& theType,
112  rti1516_2025::FederateHandle const& theProducingFederate,
113  rti1516_2025::RegionHandleSet const* theOptionalSentRegions) override;
114 
115  // 6.11
116  virtual void reflectAttributeValues(
117  rti1516_2025::ObjectInstanceHandle const& theObject,
118  rti1516_2025::AttributeHandleValueMap const& theAttributeValues,
119  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
120  rti1516_2025::TransportationTypeHandle const& theType,
121  rti1516_2025::FederateHandle const& theProducingFederate,
122  rti1516_2025::RegionHandleSet const* theOptionalSentRegions,
123  rti1516_2025::LogicalTime const& theTime,
124  rti1516_2025::OrderType theSentOrder,
125  rti1516_2025::OrderType theReceivedOrder,
126  rti1516_2025::MessageRetractionHandle const* theOptionalRetraction) override;
127 
128  // 6.13
129  virtual void receiveInteraction(
130  rti1516_2025::InteractionClassHandle const& theInteraction,
131  rti1516_2025::ParameterHandleValueMap const& theParameterValues,
132  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
133  rti1516_2025::TransportationTypeHandle const& theType,
134  rti1516_2025::FederateHandle const& theProducingFederate,
135  const rti1516_2025::RegionHandleSet* theOptionalSentRegions) override;
136 
137  // 6.13
138  virtual void receiveInteraction(
139  rti1516_2025::InteractionClassHandle const& theInteraction,
140  rti1516_2025::ParameterHandleValueMap const& theParameterValues,
141  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
142  rti1516_2025::TransportationTypeHandle const& theType,
143  rti1516_2025::FederateHandle const& theProducingFederate,
144  rti1516_2025::RegionHandleSet const* theOptionalSentRegions,
145  rti1516_2025::LogicalTime const& theTime,
146  rti1516_2025::OrderType theSentOrder,
147  rti1516_2025::OrderType theReceivedOrder,
148  rti1516_2025::MessageRetractionHandle const* theOptionalRetraction) override;
149 
150  // 6.17
151  virtual void removeObjectInstance(
152  rti1516_2025::ObjectInstanceHandle const& theObject,
153  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
154  rti1516_2025::FederateHandle const& theProducingFederate) override;
155 
156  // 6.17
157  virtual void removeObjectInstance(
158  rti1516_2025::ObjectInstanceHandle const& theObject,
159  rti1516_2025::VariableLengthData const& theUserSuppliedTag,
160  rti1516_2025::FederateHandle const& theProducingFederate,
161  rti1516_2025::LogicalTime const& theTime,
162  rti1516_2025::OrderType theSentOrder,
163  rti1516_2025::OrderType theReceivedOrder,
164  rti1516_2025::MessageRetractionHandle const* theOptionalRetraction) override;
165 
167 
168  virtual std::wstring& getParameterName(rti1516_2025::InteractionClassHandle const& classHandle,
169  rti1516_2025::ParameterHandle const& parameterHandle, std::wstring& parameterName) const;
170  virtual void printParameterValues(rti1516_2025::InteractionClassHandle const& classHandle,
171  rti1516_2025::ParameterHandleValueMap const& parameterValues) const;
172  virtual std::wstring& getAttributeName(rti1516_2025::ObjectClassHandle const& classHandle,
173  rti1516_2025::AttributeHandle const& attributeHandle, std::wstring& attributeName) const;
174  virtual void printAttributeHandles(rti1516_2025::ObjectInstanceHandle const& objectHandle,
175  rti1516_2025::AttributeHandleSet const& attributeHandles) const;
176  virtual void printAttributeValues(rti1516_2025::ObjectInstanceHandle const& objectHandle,
177  rti1516_2025::AttributeHandleValueMap const& attrVals) const;
179 
180 public:
181 
182  // Access to shared data
183  DtSimpleData& myData;
184 };
DtSimpleData::reliableTransportationTypeHandle
rti1516_2025::TransportationTypeHandle reliableTransportationTypeHandle
Definition: rtiSimpleFedAmb1516_2025.h:33
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::fedpro::OrderType
OrderType
Definition: datatypes.pb.h:472
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
DtSimpleData::objectClassMap
std::map< rti1516_2025::ObjectClassHandle, std::wstring > objectClassMap
Definition: rtiSimpleFedAmb1516_2025.h:29
MyFederateAmbassador
Basic federate ambassador service callback implementation.
Definition: rtiSimpleFedAmb13.h:35
DtSimpleData::listFederationsReturned
bool listFederationsReturned
Definition: rtiSimpleFedAmb1516_2025.h:21
rti1516e::AttributeHandleSet
std::set< AttributeHandle > AttributeHandleSet
Definition: Typedefs.h:35
DtSimpleData::rtiAmbassador
rti1516_2025::RTIambassador * rtiAmbassador
Definition: rtiSimpleFedAmb1516_2025.h:40
DtSimpleData::nameReservationSucceeded
bool nameReservationSucceeded
Definition: rtiSimpleFedAmb1516.h:21
MyFederateAmbassador::receiveInteraction
virtual void receiveInteraction(RTI::InteractionClassHandle theInteraction, const RTI::ParameterHandleValuePairSet &theParameters, const RTI::FedTime &theTime, const char *theTag, RTI::EventRetractionHandle theHandle)
DtSimpleData::clear
void clear()
Definition: rtiSimpleFedAmb13.h:27
MyFederateAmbassador::objectInstanceNameReservationSucceeded
virtual void objectInstanceNameReservationSucceeded(std::wstring const &theObjectInstanceName)
DtSimpleData::nameReservationReturned
bool nameReservationReturned
Definition: rtiSimpleFedAmb1516.h:20
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)
DtSimpleData::federateResigned
bool federateResigned
Definition: rtiSimpleFedAmb1516_2025.h:24
rti1516e::FederationExecutionInformationVector
std::vector< FederationExecutionInformation > FederationExecutionInformationVector
Definition: Typedefs.h:99
MyFederateAmbassador::reportFederationExecutions
virtual void reportFederationExecutions(rti1516_2025::FederationExecutionInformationVector const &theFederationExecutionInformationList) override
DtSimpleData::objectInstanceNameMap
std::map< rti1516_2025::ObjectInstanceHandle, std::wstring > objectInstanceNameMap
Definition: rtiSimpleFedAmb1516_2025.h:30
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.
DtSimpleData::connectionLost
bool connectionLost
Definition: rtiSimpleFedAmb1516_2025.h:23
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.
rti1516e::RegionHandleSet
std::set< RegionHandle > RegionHandleSet
Definition: Typedefs.h:39
DtSimpleData::discoveredObjects
std::set< rti1516_2025::ObjectInstanceHandle > discoveredObjects
Definition: rtiSimpleFedAmb1516_2025.h:35
DtSimpleData::reportFederationExecutionMembersReceived
bool reportFederationExecutionMembersReceived
Definition: rtiSimpleFedAmb1516_2025.h:38
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.
DtSimpleData::DtSimpleData
DtSimpleData()
Definition: rtiSimpleFedAmb1516_2025.h:42
DtSimpleData::objectClassMap
std::map< RTI::ObjectClassHandle, std::string > objectClassMap
Definition: rtiSimpleFedAmb13.h:18
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.
rti1516e::AttributeHandleValueMap
std::map< AttributeHandle, VariableLengthData > AttributeHandleValueMap
Definition: Typedefs.h:44
MyFederateAmbassador::~MyFederateAmbassador
virtual ~MyFederateAmbassador()
DtSimpleData::bestEffortTransportationTypeHandle
rti1516_2025::TransportationTypeHandle bestEffortTransportationTypeHandle
Definition: rtiSimpleFedAmb1516_2025.h:32
NullFederateAmbassador.h
This file provides an example derivation of the rti1516_2025::FederateAmbassador with NULL actions fo...
MyFederateAmbassador::MyFederateAmbassador
MyFederateAmbassador(DtSimpleData &data)
DtSimpleData::reportedFederationExecutions
rti1516_2025::FederationExecutionInformationVector reportedFederationExecutions
Definition: rtiSimpleFedAmb1516_2025.h:37
DtSimpleData::objectInstanceClassMap
std::map< rti1516_2025::ObjectInstanceHandle, rti1516_2025::ObjectClassHandle > objectInstanceClassMap
Definition: rtiSimpleFedAmb1516_2025.h:31
rti1516e::ParameterHandleValueMap
std::map< ParameterHandle, VariableLengthData > ParameterHandleValueMap
Definition: Typedefs.h:49
Document ID: Generated on Sun Jul 20 16:15:30 EDT 2025 from SVN revision 277985
Copyright © 2005-2025 MAK Technologies Inc. All Rights Reserved (www.mak.com)