FederateAmbassador.h

Go to the documentation of this file.

#pragma once
/***********************************************************************
   The IEEE hereby grants a general, royalty-free license to copy, distribute,
   display and make derivative works from this material, for all purposes,
   provided that any use of the material contains the following
   attribution: "Reprinted with permission from IEEE 1516.1(TM)-2025".
   Should you require additional information, contact the Manager, Standards
   Intellectual Property, IEEE Standards Association (stds-ipr@ieee.org).
***********************************************************************/

// This is a pure abstract interface that must be implemented by the
// federate to receive callbacks from the RTI.

namespace rti1516_2025
{
   class LogicalTime;
}

#include <RTI/SpecificConfig.h>
#include <RTI/Exception.h>
#include <RTI/Typedefs.h>
#include <RTI/Enums.h>

namespace rti1516_2025
{
   class RTI_EXPORT FederateAmbassador
   {
   protected:
      FederateAmbassador ();

   public:
      virtual ~FederateAmbassador ()
         noexcept = 0;

      // Federation Management Services //

      virtual void connectionLost(
         std::wstring const & faultDescription) = 0;

      virtual void reportFederationExecutions(
         FederationExecutionInformationVector const & report) = 0;

      virtual void reportFederationExecutionMembers(
         std::wstring const & federationName,
         FederationExecutionMemberInformationVector const & report) = 0;

      virtual void reportFederationExecutionDoesNotExist(
         std::wstring const & federationName) = 0;

      virtual void federateResigned(
         std::wstring const & reasonForResignDescription) = 0;

      virtual void synchronizationPointRegistrationSucceeded(
         std::wstring const & synchronizationPointLabel) = 0;

      virtual void synchronizationPointRegistrationFailed(
         std::wstring const & synchronizationPointLabel,
         SynchronizationPointFailureReason reason) = 0;

      virtual void announceSynchronizationPoint(
         std::wstring  const & synchronizationPointLabel,
         VariableLengthData const & userSuppliedTag) = 0;

      virtual void federationSynchronized(
         std::wstring const & synchronizationPointLabel,
         FederateHandleSet const & failedToSyncSet) = 0;

      virtual void initiateFederateSave(
         std::wstring const & label) = 0;

      virtual void initiateFederateSave(
         std::wstring const & label,
         LogicalTime const & time) = 0;

      virtual void federationSaved() = 0;

      virtual void federationNotSaved (
         SaveFailureReason reason) = 0;

      virtual void federationSaveStatusResponse(
         FederateHandleSaveStatusPairVector const & response) = 0;

      virtual void requestFederationRestoreSucceeded(
         std::wstring const & label) = 0;

      virtual void requestFederationRestoreFailed(
         std::wstring const & label) = 0;

      virtual void federationRestoreBegun() = 0;

      virtual void initiateFederateRestore(
         std::wstring const & label,
         std::wstring const & federateName,
         FederateHandle const & postRestoreFederateHandle) = 0;

      virtual void federationRestored() = 0;

      virtual void federationNotRestored (
         RestoreFailureReason reason) = 0;

      virtual void federationRestoreStatusResponse(
         FederateRestoreStatusVector const & response) = 0;

      // Declaration Management Services //

      virtual void startRegistrationForObjectClass(
         ObjectClassHandle const & objectClass) = 0;

      virtual void stopRegistrationForObjectClass(
         ObjectClassHandle const & objectClass) = 0;

      virtual void turnInteractionsOn(
         InteractionClassHandle const & interactionClass) = 0;

      virtual void turnInteractionsOff(
         InteractionClassHandle const & interactionClass) = 0;

      // Object Management Services //

      virtual void objectInstanceNameReservationSucceeded(
         std::wstring const & objectInstanceName) = 0;

      virtual void objectInstanceNameReservationFailed(
         std::wstring const & objectInstanceName) = 0;

      virtual void multipleObjectInstanceNameReservationSucceeded(
         std::set<std::wstring> const & objectInstanceNames) = 0;

      virtual void multipleObjectInstanceNameReservationFailed(
         std::set<std::wstring> const & objectInstanceNames) = 0;


      virtual void discoverObjectInstance(
         ObjectInstanceHandle const & objectInstance,
         ObjectClassHandle const & objectClass,
         std::wstring const & objectInstanceName,
         FederateHandle const & producingFederate) = 0;

      virtual void reflectAttributeValues(
         ObjectInstanceHandle const & objectInstance,
         AttributeHandleValueMap const & attributeValues,
         VariableLengthData const & userSuppliedTag,
         TransportationTypeHandle const & transportationType,
         FederateHandle const & producingFederate,
         RegionHandleSet const * optionalSentRegions) = 0;

      virtual void reflectAttributeValues(
         ObjectInstanceHandle const & objectInstance,
         AttributeHandleValueMap const & attributeValues,
         VariableLengthData const & userSuppliedTag,
         TransportationTypeHandle const & transportationType,
         FederateHandle const & producingFederate,
         RegionHandleSet const * optionalSentRegions,
         LogicalTime const & time,
         OrderType sentOrderType,
         OrderType receivedOrderType,
         MessageRetractionHandle const * optionalRetraction) = 0;

      virtual void receiveInteraction(
         InteractionClassHandle const & interactionClass,
         ParameterHandleValueMap const & parameterValues,
         VariableLengthData const & userSuppliedTag,
         TransportationTypeHandle const & transportationType,
         FederateHandle const & producingFederate,
         const RegionHandleSet * optionalSentRegions) = 0;

      virtual void receiveInteraction(
         InteractionClassHandle const & interactionClass,
         ParameterHandleValueMap const & parameterValues,
         VariableLengthData const & userSuppliedTag,
         TransportationTypeHandle const & transportationType,
         FederateHandle const & producingFederate,
         RegionHandleSet const * optionalSentRegions,
         LogicalTime const & time,
         OrderType sentOrderType,
         OrderType receivedOrderType,
         MessageRetractionHandle const * optionalRetraction) = 0;

      virtual void receiveDirectedInteraction(
         InteractionClassHandle const & interactionClass,
         ObjectInstanceHandle const & objectInstance,
         ParameterHandleValueMap const & parameterValues,
         VariableLengthData const & userSuppliedTag,
         TransportationTypeHandle const & transportationType,
         FederateHandle const & producingFederate) = 0;

      virtual void receiveDirectedInteraction(
         InteractionClassHandle const & interactionClass,
         ObjectInstanceHandle const & objectInstance,
         ParameterHandleValueMap const & parameterValues,
         VariableLengthData const & userSuppliedTag,
         TransportationTypeHandle const & transportationType,
         FederateHandle const & producingFederate,
         LogicalTime const & time,
         OrderType sentOrderType,
         OrderType receivedOrderType,
         MessageRetractionHandle const * optionalRetraction) = 0;

      virtual void removeObjectInstance(
         ObjectInstanceHandle const & objectInstance,
         VariableLengthData const & userSuppliedTag,
         FederateHandle const & producingFederate) = 0;

      virtual void removeObjectInstance(
         ObjectInstanceHandle const & objectInstance,
         VariableLengthData const & userSuppliedTag,
         FederateHandle const & producingFederate,
         LogicalTime const & time,
         OrderType sentOrderType,
         OrderType receivedOrderType,
         MessageRetractionHandle const * optionalRetraction) = 0;

      virtual void attributesInScope(
         ObjectInstanceHandle const & objectInstance,
         AttributeHandleSet const & attributes) = 0;

      virtual void attributesOutOfScope(
         ObjectInstanceHandle const & objectInstance,
         AttributeHandleSet const & attributes) = 0;

      virtual void provideAttributeValueUpdate(
         ObjectInstanceHandle const & objectInstance,
         AttributeHandleSet const & attributes,
         VariableLengthData const & userSuppliedTag) = 0;

      virtual void turnUpdatesOnForObjectInstance(
         ObjectInstanceHandle const & objectInstance,
         AttributeHandleSet const & attributes) = 0;

      virtual void turnUpdatesOnForObjectInstance(
         ObjectInstanceHandle const & objectInstance,
         AttributeHandleSet const & attributes,
         std::wstring const & updateRateDesignator) = 0;

      virtual void turnUpdatesOffForObjectInstance(
         ObjectInstanceHandle const & objectInstance,
         AttributeHandleSet const & attributes) = 0;

      virtual void confirmAttributeTransportationTypeChange(
         ObjectInstanceHandle const & objectInstance,
         AttributeHandleSet const & attributes,
         TransportationTypeHandle const & transportationType) = 0;

      virtual void reportAttributeTransportationType(
         ObjectInstanceHandle const & objectInstance,
         AttributeHandle const & attribute,
         TransportationTypeHandle const & transportationType) = 0;

      virtual void confirmInteractionTransportationTypeChange(
         InteractionClassHandle const & interactionClass,
         TransportationTypeHandle const & transportationType) = 0;

      virtual void reportInteractionTransportationType(
         FederateHandle const & federate,
         InteractionClassHandle const & interactionClass,
         TransportationTypeHandle const & transportationType) = 0;


      // Ownership Management Services //

      virtual void requestAttributeOwnershipAssumption(
         ObjectInstanceHandle const & objectInstance,
         AttributeHandleSet const & offeredAttributes,
         VariableLengthData const & userSuppliedTag) = 0;

      virtual void requestDivestitureConfirmation(
         ObjectInstanceHandle const & objectInstance,
         AttributeHandleSet const & releasedAttributes,
         VariableLengthData const & userSuppliedTag) = 0;

      virtual void attributeOwnershipAcquisitionNotification(
         ObjectInstanceHandle const & objectInstance,
         AttributeHandleSet const & securedAttributes,
         VariableLengthData const & userSuppliedTag) = 0;

      virtual void attributeOwnershipUnavailable(
         ObjectInstanceHandle const & objectInstance,
         AttributeHandleSet const & attributes,
         VariableLengthData const & userSuppliedTag) = 0;

      virtual void requestAttributeOwnershipRelease(
         ObjectInstanceHandle const & objectInstance,
         AttributeHandleSet const & candidateAttributes,
         VariableLengthData const & userSuppliedTag) = 0;

      virtual void confirmAttributeOwnershipAcquisitionCancellation(
         ObjectInstanceHandle const & objectInstance,
         AttributeHandleSet const & attributes) = 0;

      virtual void informAttributeOwnership(
         ObjectInstanceHandle const & objectInstance,
         AttributeHandleSet const & attributes,
         FederateHandle const & owner) = 0;

      virtual void attributeIsNotOwned (
         ObjectInstanceHandle const & objectInstance,
         AttributeHandleSet const & attributes) = 0;

      virtual void attributeIsOwnedByRTI (
         ObjectInstanceHandle const & objectInstance,
         AttributeHandleSet const & attributes) = 0;

      // Time Management Services //

      virtual void timeRegulationEnabled(
         LogicalTime const & time) = 0;

      virtual void timeConstrainedEnabled(
         LogicalTime const & time) = 0;

      virtual void flushQueueGrant(
         LogicalTime const & time, LogicalTime const & optimisticTime) = 0;

      virtual void timeAdvanceGrant(
         LogicalTime const & time) = 0;

      virtual void requestRetraction(
         MessageRetractionHandle const & retraction) = 0;
   };
}