@hla4ts/hla-api 0.1.0

package/src/federate-ambassador.ts

@@ -0,0 +1,874 @@
+/**
+ * Federate Ambassador Interface
+ *
+ * This module defines the FederateAmbassador interface that users implement
+ * to receive callbacks from the RTI.
+ *
+ * The callbacks are grouped by service category according to the HLA specification.
+ */
+
+import type {
+  FederateHandle,
+  ObjectClassHandle,
+  AttributeHandle,
+  InteractionClassHandle,
+  ObjectInstanceHandle,
+  AttributeHandleSet,
+  AttributeHandleValueMap,
+  ParameterHandleValueMap,
+  TransportationTypeHandle,
+  LogicalTime,
+  MessageRetractionHandle,
+  UserSuppliedTag,
+  FederationExecutionInformationSet,
+  FederationExecutionMemberInformationSet,
+  FederateHandleSaveStatusPairArray,
+  FederateRestoreStatusArray,
+  ConveyedRegionSet,
+  OrderType,
+  SynchronizationPointFailureReason,
+  SaveFailureReason,
+  RestoreFailureReason,
+} from "./types.ts";
+
+/**
+ * FederateAmbassador interface.
+ *
+ * Implement this interface to receive callbacks from the RTI.
+ * All methods are optional - implement only the callbacks your federate needs.
+ *
+ * @example
+ * ```ts
+ * const myFederateAmbassador: FederateAmbassador = {
+ *   discoverObjectInstance(objectInstance, objectClass, objectInstanceName) {
+ *     console.log(`Discovered object: ${objectInstanceName}`);
+ *   },
+ *
+ *   reflectAttributeValues(objectInstance, attributeValues, tag) {
+ *     console.log(`Received update for object`);
+ *   },
+ *
+ *   receiveInteraction(interactionClass, parameterValues, tag) {
+ *     console.log(`Received interaction`);
+ *   },
+ * };
+ * ```
+ */
+export interface FederateAmbassador {
+  // ===========================================================================
+  // Connection Management
+  // ===========================================================================
+
+  /**
+   * Called when the connection to the RTI is lost.
+   *
+   * @param faultDescription - Description of why the connection was lost
+   */
+  connectionLost?(faultDescription: string): void;
+
+  // ===========================================================================
+  // Federation Management
+  // ===========================================================================
+
+  /**
+   * Reports the list of federation executions (async response to listFederationExecutions).
+   *
+   * @param federations - Information about available federations
+   */
+  reportFederationExecutions?(federations: FederationExecutionInformationSet): void;
+
+  /**
+   * Reports the list of members in a federation (async response to listFederationExecutionMembers).
+   *
+   * @param federationName - Name of the federation
+   * @param members - Information about federation members
+   */
+  reportFederationExecutionMembers?(
+    federationName: string,
+    members: FederationExecutionMemberInformationSet
+  ): void;
+
+  /**
+   * Reports that the requested federation does not exist.
+   *
+   * @param federationName - Name of the federation that doesn't exist
+   */
+  reportFederationExecutionDoesNotExist?(federationName: string): void;
+
+  /**
+   * Called when another federate resigns from the federation.
+   *
+   * @param reasonForResignDescription - Description of why the federate resigned
+   */
+  federateResigned?(reasonForResignDescription: string): void;
+
+  // ===========================================================================
+  // Synchronization Point Services
+  // ===========================================================================
+
+  /**
+   * Called when a synchronization point registration succeeds.
+   *
+   * @param label - The synchronization point label
+   */
+  synchronizationPointRegistrationSucceeded?(label: string): void;
+
+  /**
+   * Called when a synchronization point registration fails.
+   *
+   * @param label - The synchronization point label
+   * @param reason - Why the registration failed
+   */
+  synchronizationPointRegistrationFailed?(
+    label: string,
+    reason: SynchronizationPointFailureReason
+  ): void;
+
+  /**
+   * Called when a synchronization point is announced.
+   *
+   * @param label - The synchronization point label
+   * @param userSuppliedTag - User-supplied tag from the registering federate
+   */
+  announceSynchronizationPoint?(label: string, userSuppliedTag: UserSuppliedTag): void;
+
+  /**
+   * Called when all federates have achieved a synchronization point.
+   *
+   * @param label - The synchronization point label
+   * @param failedToSyncSet - Set of federates that failed to synchronize (may be empty)
+   */
+  federationSynchronized?(label: string, failedToSyncSet: FederateHandle[]): void;
+
+  // ===========================================================================
+  // Save Services
+  // ===========================================================================
+
+  /**
+   * Called to initiate a federate save.
+   *
+   * @param label - The save label
+   */
+  initiateFederateSave?(label: string): void;
+
+  /**
+   * Called to initiate a federate save at a specific time.
+   *
+   * @param label - The save label
+   * @param time - The logical time for the save
+   */
+  initiateFederateSaveWithTime?(label: string, time: LogicalTime): void;
+
+  /**
+   * Called when the federation has been saved.
+   */
+  federationSaved?(): void;
+
+  /**
+   * Called when the federation save failed.
+   *
+   * @param reason - Why the save failed
+   */
+  federationNotSaved?(reason: SaveFailureReason): void;
+
+  /**
+   * Response to queryFederationSaveStatus.
+   *
+   * @param saveStatusPairs - Status of each federate's save
+   */
+  federationSaveStatusResponse?(saveStatusPairs: FederateHandleSaveStatusPairArray): void;
+
+  // ===========================================================================
+  // Restore Services
+  // ===========================================================================
+
+  /**
+   * Called when a federation restore request succeeds.
+   *
+   * @param label - The restore label
+   */
+  requestFederationRestoreSucceeded?(label: string): void;
+
+  /**
+   * Called when a federation restore request fails.
+   *
+   * @param label - The restore label
+   */
+  requestFederationRestoreFailed?(label: string): void;
+
+  /**
+   * Called when a federation restore has begun.
+   */
+  federationRestoreBegun?(): void;
+
+  /**
+   * Called to initiate a federate restore.
+   *
+   * @param label - The restore label
+   * @param federateName - Name to restore as
+   * @param postRestoreFederateHandle - Handle after restore
+   */
+  initiateFederateRestore?(
+    label: string,
+    federateName: string,
+    postRestoreFederateHandle: FederateHandle
+  ): void;
+
+  /**
+   * Called when the federation has been restored.
+   */
+  federationRestored?(): void;
+
+  /**
+   * Called when the federation restore failed.
+   *
+   * @param reason - Why the restore failed
+   */
+  federationNotRestored?(reason: RestoreFailureReason): void;
+
+  /**
+   * Response to queryFederationRestoreStatus.
+   *
+   * @param restoreStatuses - Status of each federate's restore
+   */
+  federationRestoreStatusResponse?(restoreStatuses: FederateRestoreStatusArray): void;
+
+  // ===========================================================================
+  // Declaration Management
+  // ===========================================================================
+
+  /**
+   * Called when another federate subscribes to an object class this federate publishes.
+   *
+   * @param objectClass - The object class handle
+   */
+  startRegistrationForObjectClass?(objectClass: ObjectClassHandle): void;
+
+  /**
+   * Called when no federates are subscribed to an object class this federate publishes.
+   *
+   * @param objectClass - The object class handle
+   */
+  stopRegistrationForObjectClass?(objectClass: ObjectClassHandle): void;
+
+  /**
+   * Called when another federate subscribes to an interaction class this federate publishes.
+   *
+   * @param interactionClass - The interaction class handle
+   */
+  turnInteractionsOn?(interactionClass: InteractionClassHandle): void;
+
+  /**
+   * Called when no federates are subscribed to an interaction class this federate publishes.
+   *
+   * @param interactionClass - The interaction class handle
+   */
+  turnInteractionsOff?(interactionClass: InteractionClassHandle): void;
+
+  // ===========================================================================
+  // Object Instance Name Reservation
+  // ===========================================================================
+
+  /**
+   * Called when an object instance name reservation succeeds.
+   *
+   * @param objectInstanceName - The reserved name
+   */
+  objectInstanceNameReservationSucceeded?(objectInstanceName: string): void;
+
+  /**
+   * Called when an object instance name reservation fails.
+   *
+   * @param objectInstanceName - The name that could not be reserved
+   */
+  objectInstanceNameReservationFailed?(objectInstanceName: string): void;
+
+  /**
+   * Called when multiple object instance name reservations succeed.
+   *
+   * @param objectInstanceNames - The reserved names
+   */
+  multipleObjectInstanceNameReservationSucceeded?(objectInstanceNames: string[]): void;
+
+  /**
+   * Called when multiple object instance name reservations fail.
+   *
+   * @param objectInstanceNames - The names that could not be reserved
+   */
+  multipleObjectInstanceNameReservationFailed?(objectInstanceNames: string[]): void;
+
+  // ===========================================================================
+  // Object Management - Discovery & Removal
+  // ===========================================================================
+
+  /**
+   * Called when a new object instance is discovered.
+   *
+   * @param objectInstance - Handle of the discovered object
+   * @param objectClass - Handle of the object's class
+   * @param objectInstanceName - Name of the object instance
+   * @param producingFederate - Handle of the federate that registered the object
+   */
+  discoverObjectInstance?(
+    objectInstance: ObjectInstanceHandle,
+    objectClass: ObjectClassHandle,
+    objectInstanceName: string,
+    producingFederate: FederateHandle
+  ): void;
+
+  /**
+   * Called when an object instance is removed (deleted) without time.
+   *
+   * @param objectInstance - Handle of the removed object
+   * @param userSuppliedTag - User-supplied tag
+   * @param producingFederate - Handle of the federate that deleted the object
+   */
+  removeObjectInstance?(
+    objectInstance: ObjectInstanceHandle,
+    userSuppliedTag: UserSuppliedTag,
+    producingFederate: FederateHandle
+  ): void;
+
+  /**
+   * Called when an object instance is removed (deleted) with time.
+   *
+   * @param objectInstance - Handle of the removed object
+   * @param userSuppliedTag - User-supplied tag
+   * @param producingFederate - Handle of the federate that deleted the object
+   * @param time - Logical time of deletion
+   * @param sentOrderType - Order type used by sender
+   * @param receivedOrderType - Order type as received
+   * @param retractionHandle - Handle for potential retraction (optional)
+   */
+  removeObjectInstanceWithTime?(
+    objectInstance: ObjectInstanceHandle,
+    userSuppliedTag: UserSuppliedTag,
+    producingFederate: FederateHandle,
+    time: LogicalTime,
+    sentOrderType: OrderType,
+    receivedOrderType: OrderType,
+    retractionHandle?: MessageRetractionHandle
+  ): void;
+
+  // ===========================================================================
+  // Object Management - Attribute Updates
+  // ===========================================================================
+
+  /**
+   * Called when attribute values are reflected (updated) without time.
+   *
+   * @param objectInstance - Handle of the object
+   * @param attributeValues - Map of attribute handles to values
+   * @param userSuppliedTag - User-supplied tag
+   * @param transportationType - Transportation type used
+   * @param producingFederate - Handle of the updating federate
+   * @param sentRegions - Regions used by sender (optional, for DDM)
+   */
+  reflectAttributeValues?(
+    objectInstance: ObjectInstanceHandle,
+    attributeValues: AttributeHandleValueMap,
+    userSuppliedTag: UserSuppliedTag,
+    transportationType: TransportationTypeHandle,
+    producingFederate: FederateHandle,
+    sentRegions?: ConveyedRegionSet
+  ): void;
+
+  /**
+   * Called when attribute values are reflected (updated) with time.
+   *
+   * @param objectInstance - Handle of the object
+   * @param attributeValues - Map of attribute handles to values
+   * @param userSuppliedTag - User-supplied tag
+   * @param transportationType - Transportation type used
+   * @param producingFederate - Handle of the updating federate
+   * @param sentRegions - Regions used by sender (optional, for DDM)
+   * @param time - Logical time of update
+   * @param sentOrderType - Order type used by sender
+   * @param receivedOrderType - Order type as received
+   * @param retractionHandle - Handle for potential retraction (optional)
+   */
+  reflectAttributeValuesWithTime?(
+    objectInstance: ObjectInstanceHandle,
+    attributeValues: AttributeHandleValueMap,
+    userSuppliedTag: UserSuppliedTag,
+    transportationType: TransportationTypeHandle,
+    producingFederate: FederateHandle,
+    sentRegions: ConveyedRegionSet | undefined,
+    time: LogicalTime,
+    sentOrderType: OrderType,
+    receivedOrderType: OrderType,
+    retractionHandle?: MessageRetractionHandle
+  ): void;
+
+  // ===========================================================================
+  // Object Management - Interactions
+  // ===========================================================================
+
+  /**
+   * Called when an interaction is received without time.
+   *
+   * @param interactionClass - Handle of the interaction class
+   * @param parameterValues - Map of parameter handles to values
+   * @param userSuppliedTag - User-supplied tag
+   * @param transportationType - Transportation type used
+   * @param producingFederate - Handle of the sending federate
+   * @param sentRegions - Regions used by sender (optional, for DDM)
+   */
+  receiveInteraction?(
+    interactionClass: InteractionClassHandle,
+    parameterValues: ParameterHandleValueMap,
+    userSuppliedTag: UserSuppliedTag,
+    transportationType: TransportationTypeHandle,
+    producingFederate: FederateHandle,
+    sentRegions?: ConveyedRegionSet
+  ): void;
+
+  /**
+   * Called when an interaction is received with time.
+   *
+   * @param interactionClass - Handle of the interaction class
+   * @param parameterValues - Map of parameter handles to values
+   * @param userSuppliedTag - User-supplied tag
+   * @param transportationType - Transportation type used
+   * @param producingFederate - Handle of the sending federate
+   * @param sentRegions - Regions used by sender (optional, for DDM)
+   * @param time - Logical time of interaction
+   * @param sentOrderType - Order type used by sender
+   * @param receivedOrderType - Order type as received
+   * @param retractionHandle - Handle for potential retraction (optional)
+   */
+  receiveInteractionWithTime?(
+    interactionClass: InteractionClassHandle,
+    parameterValues: ParameterHandleValueMap,
+    userSuppliedTag: UserSuppliedTag,
+    transportationType: TransportationTypeHandle,
+    producingFederate: FederateHandle,
+    sentRegions: ConveyedRegionSet | undefined,
+    time: LogicalTime,
+    sentOrderType: OrderType,
+    receivedOrderType: OrderType,
+    retractionHandle?: MessageRetractionHandle
+  ): void;
+
+  /**
+   * Called when a directed interaction is received without time.
+   * (Directed interactions target a specific object instance)
+   *
+   * @param interactionClass - Handle of the interaction class
+   * @param objectInstance - Handle of the target object
+   * @param parameterValues - Map of parameter handles to values
+   * @param userSuppliedTag - User-supplied tag
+   * @param transportationType - Transportation type used
+   * @param producingFederate - Handle of the sending federate
+   */
+  receiveDirectedInteraction?(
+    interactionClass: InteractionClassHandle,
+    objectInstance: ObjectInstanceHandle,
+    parameterValues: ParameterHandleValueMap,
+    userSuppliedTag: UserSuppliedTag,
+    transportationType: TransportationTypeHandle,
+    producingFederate: FederateHandle
+  ): void;
+
+  /**
+   * Called when a directed interaction is received with time.
+   *
+   * @param interactionClass - Handle of the interaction class
+   * @param objectInstance - Handle of the target object
+   * @param parameterValues - Map of parameter handles to values
+   * @param userSuppliedTag - User-supplied tag
+   * @param transportationType - Transportation type used
+   * @param producingFederate - Handle of the sending federate
+   * @param time - Logical time of interaction
+   * @param sentOrderType - Order type used by sender
+   * @param receivedOrderType - Order type as received
+   * @param retractionHandle - Handle for potential retraction (optional)
+   */
+  receiveDirectedInteractionWithTime?(
+    interactionClass: InteractionClassHandle,
+    objectInstance: ObjectInstanceHandle,
+    parameterValues: ParameterHandleValueMap,
+    userSuppliedTag: UserSuppliedTag,
+    transportationType: TransportationTypeHandle,
+    producingFederate: FederateHandle,
+    time: LogicalTime,
+    sentOrderType: OrderType,
+    receivedOrderType: OrderType,
+    retractionHandle?: MessageRetractionHandle
+  ): void;
+
+  // ===========================================================================
+  // Object Management - Attribute Value Update Requests
+  // ===========================================================================
+
+  /**
+   * Called when another federate requests attribute value updates.
+   *
+   * @param objectInstance - Handle of the object
+   * @param attributes - Set of attributes to update
+   * @param userSuppliedTag - User-supplied tag
+   */
+  provideAttributeValueUpdate?(
+    objectInstance: ObjectInstanceHandle,
+    attributes: AttributeHandleSet,
+    userSuppliedTag: UserSuppliedTag
+  ): void;
+
+  /**
+   * Called when updates should be turned on for an object instance.
+   *
+   * @param objectInstance - Handle of the object
+   * @param attributes - Set of attributes
+   */
+  turnUpdatesOnForObjectInstance?(
+    objectInstance: ObjectInstanceHandle,
+    attributes: AttributeHandleSet
+  ): void;
+
+  /**
+   * Called when updates should be turned on with a specific rate.
+   *
+   * @param objectInstance - Handle of the object
+   * @param attributes - Set of attributes
+   * @param updateRateDesignator - Update rate identifier
+   */
+  turnUpdatesOnForObjectInstanceWithRate?(
+    objectInstance: ObjectInstanceHandle,
+    attributes: AttributeHandleSet,
+    updateRateDesignator: string
+  ): void;
+
+  /**
+   * Called when updates should be turned off for an object instance.
+   *
+   * @param objectInstance - Handle of the object
+   * @param attributes - Set of attributes
+   */
+  turnUpdatesOffForObjectInstance?(
+    objectInstance: ObjectInstanceHandle,
+    attributes: AttributeHandleSet
+  ): void;
+
+  // ===========================================================================
+  // Object Management - Attribute Scope
+  // ===========================================================================
+
+  /**
+   * Called when attributes come into scope.
+   *
+   * @param objectInstance - Handle of the object
+   * @param attributes - Set of attributes that came into scope
+   */
+  attributesInScope?(
+    objectInstance: ObjectInstanceHandle,
+    attributes: AttributeHandleSet
+  ): void;
+
+  /**
+   * Called when attributes go out of scope.
+   *
+   * @param objectInstance - Handle of the object
+   * @param attributes - Set of attributes that went out of scope
+   */
+  attributesOutOfScope?(
+    objectInstance: ObjectInstanceHandle,
+    attributes: AttributeHandleSet
+  ): void;
+
+  // ===========================================================================
+  // Ownership Management
+  // ===========================================================================
+
+  /**
+   * Called to request assumption of attribute ownership.
+   *
+   * @param objectInstance - Handle of the object
+   * @param attributes - Set of attributes to assume ownership of
+   * @param userSuppliedTag - User-supplied tag
+   */
+  requestAttributeOwnershipAssumption?(
+    objectInstance: ObjectInstanceHandle,
+    attributes: AttributeHandleSet,
+    userSuppliedTag: UserSuppliedTag
+  ): void;
+
+  /**
+   * Called to request divestiture confirmation.
+   *
+   * @param objectInstance - Handle of the object
+   * @param attributes - Set of attributes to divest
+   */
+  requestDivestitureConfirmation?(
+    objectInstance: ObjectInstanceHandle,
+    attributes: AttributeHandleSet
+  ): void;
+
+  /**
+   * Called when attribute ownership acquisition succeeds.
+   *
+   * @param objectInstance - Handle of the object
+   * @param attributes - Set of acquired attributes
+   * @param userSuppliedTag - User-supplied tag
+   */
+  attributeOwnershipAcquisitionNotification?(
+    objectInstance: ObjectInstanceHandle,
+    attributes: AttributeHandleSet,
+    userSuppliedTag: UserSuppliedTag
+  ): void;
+
+  /**
+   * Called when requested attributes are unavailable for acquisition.
+   *
+   * @param objectInstance - Handle of the object
+   * @param attributes - Set of unavailable attributes
+   */
+  attributeOwnershipUnavailable?(
+    objectInstance: ObjectInstanceHandle,
+    attributes: AttributeHandleSet
+  ): void;
+
+  /**
+   * Called when another federate requests release of attribute ownership.
+   *
+   * @param objectInstance - Handle of the object
+   * @param attributes - Set of attributes to release
+   * @param userSuppliedTag - User-supplied tag
+   */
+  requestAttributeOwnershipRelease?(
+    objectInstance: ObjectInstanceHandle,
+    attributes: AttributeHandleSet,
+    userSuppliedTag: UserSuppliedTag
+  ): void;
+
+  /**
+   * Called to confirm cancellation of attribute ownership acquisition.
+   *
+   * @param objectInstance - Handle of the object
+   * @param attributes - Set of attributes whose acquisition was cancelled
+   */
+  confirmAttributeOwnershipAcquisitionCancellation?(
+    objectInstance: ObjectInstanceHandle,
+    attributes: AttributeHandleSet
+  ): void;
+
+  /**
+   * Reports attribute ownership status.
+   *
+   * @param objectInstance - Handle of the object
+   * @param attribute - Handle of the attribute
+   * @param owner - Handle of the owning federate
+   */
+  informAttributeOwnership?(
+    objectInstance: ObjectInstanceHandle,
+    attribute: AttributeHandle,
+    owner: FederateHandle
+  ): void;
+
+  /**
+   * Reports that an attribute is not owned.
+   *
+   * @param objectInstance - Handle of the object
+   * @param attribute - Handle of the attribute
+   */
+  attributeIsNotOwned?(
+    objectInstance: ObjectInstanceHandle,
+    attribute: AttributeHandle
+  ): void;
+
+  /**
+   * Reports that an attribute is owned by the RTI.
+   *
+   * @param objectInstance - Handle of the object
+   * @param attribute - Handle of the attribute
+   */
+  attributeIsOwnedByRTI?(
+    objectInstance: ObjectInstanceHandle,
+    attribute: AttributeHandle
+  ): void;
+
+  // ===========================================================================
+  // Time Management
+  // ===========================================================================
+
+  /**
+   * Called when time regulation is enabled.
+   *
+   * @param time - The federate's logical time
+   */
+  timeRegulationEnabled?(time: LogicalTime): void;
+
+  /**
+   * Called when time constrained mode is enabled.
+   *
+   * @param time - The federate's logical time
+   */
+  timeConstrainedEnabled?(time: LogicalTime): void;
+
+  /**
+   * Called when a time advance is granted.
+   *
+   * @param time - The granted logical time
+   */
+  timeAdvanceGrant?(time: LogicalTime): void;
+
+  /**
+   * Called when a flush queue grant is received.
+   *
+   * @param time - The granted logical time
+   */
+  flushQueueGrant?(time: LogicalTime): void;
+
+  /**
+   * Called to request retraction of a previously sent message.
+   *
+   * @param retractionHandle - Handle of the message to retract
+   */
+  requestRetraction?(retractionHandle: MessageRetractionHandle): void;
+
+  // ===========================================================================
+  // Transportation Type Change Confirmations
+  // ===========================================================================
+
+  /**
+   * Confirms attribute transportation type change.
+   *
+   * @param objectInstance - Handle of the object
+   * @param attributes - Set of affected attributes
+   * @param transportationType - The new transportation type
+   */
+  confirmAttributeTransportationTypeChange?(
+    objectInstance: ObjectInstanceHandle,
+    attributes: AttributeHandleSet,
+    transportationType: TransportationTypeHandle
+  ): void;
+
+  /**
+   * Reports attribute transportation type.
+   *
+   * @param objectInstance - Handle of the object
+   * @param attribute - Handle of the attribute
+   * @param transportationType - The transportation type
+   */
+  reportAttributeTransportationType?(
+    objectInstance: ObjectInstanceHandle,
+    attribute: AttributeHandle,
+    transportationType: TransportationTypeHandle
+  ): void;
+
+  /**
+   * Confirms interaction transportation type change.
+   *
+   * @param interactionClass - Handle of the interaction class
+   * @param transportationType - The new transportation type
+   */
+  confirmInteractionTransportationTypeChange?(
+    interactionClass: InteractionClassHandle,
+    transportationType: TransportationTypeHandle
+  ): void;
+
+  /**
+   * Reports interaction transportation type.
+   *
+   * @param federateHandle - Handle of the federate
+   * @param interactionClass - Handle of the interaction class
+   * @param transportationType - The transportation type
+   */
+  reportInteractionTransportationType?(
+    federateHandle: FederateHandle,
+    interactionClass: InteractionClassHandle,
+    transportationType: TransportationTypeHandle
+  ): void;
+}
+
+/**
+ * Empty/no-op implementation of FederateAmbassador.
+ * Useful as a base class or for testing.
+ */
+export class NullFederateAmbassador implements FederateAmbassador {
+  // All methods are undefined by default
+}
+
+/**
+ * Base class for FederateAmbassador implementations that provides
+ * default no-op implementations for all callbacks.
+ *
+ * Extend this class and override only the callbacks you need.
+ *
+ * @example
+ * ```ts
+ * class MyFederateAmbassador extends BaseFederateAmbassador {
+ *   override discoverObjectInstance(
+ *     objectInstance: ObjectInstanceHandle,
+ *     objectClass: ObjectClassHandle,
+ *     objectInstanceName: string,
+ *     producingFederate: FederateHandle
+ *   ): void {
+ *     console.log(`Discovered: ${objectInstanceName}`);
+ *   }
+ * }
+ * ```
+ */
+export abstract class BaseFederateAmbassador implements FederateAmbassador {
+  connectionLost(_faultDescription: string): void {}
+  reportFederationExecutions(_federations: FederationExecutionInformationSet): void {}
+  reportFederationExecutionMembers(_federationName: string, _members: FederationExecutionMemberInformationSet): void {}
+  reportFederationExecutionDoesNotExist(_federationName: string): void {}
+  federateResigned(_reasonForResignDescription: string): void {}
+  synchronizationPointRegistrationSucceeded(_label: string): void {}
+  synchronizationPointRegistrationFailed(_label: string, _reason: SynchronizationPointFailureReason): void {}
+  announceSynchronizationPoint(_label: string, _userSuppliedTag: UserSuppliedTag): void {}
+  federationSynchronized(_label: string, _failedToSyncSet: FederateHandle[]): void {}
+  initiateFederateSave(_label: string): void {}
+  initiateFederateSaveWithTime(_label: string, _time: LogicalTime): void {}
+  federationSaved(): void {}
+  federationNotSaved(_reason: SaveFailureReason): void {}
+  federationSaveStatusResponse(_saveStatusPairs: FederateHandleSaveStatusPairArray): void {}
+  requestFederationRestoreSucceeded(_label: string): void {}
+  requestFederationRestoreFailed(_label: string): void {}
+  federationRestoreBegun(): void {}
+  initiateFederateRestore(_label: string, _federateName: string, _postRestoreFederateHandle: FederateHandle): void {}
+  federationRestored(): void {}
+  federationNotRestored(_reason: RestoreFailureReason): void {}
+  federationRestoreStatusResponse(_restoreStatuses: FederateRestoreStatusArray): void {}
+  startRegistrationForObjectClass(_objectClass: ObjectClassHandle): void {}
+  stopRegistrationForObjectClass(_objectClass: ObjectClassHandle): void {}
+  turnInteractionsOn(_interactionClass: InteractionClassHandle): void {}
+  turnInteractionsOff(_interactionClass: InteractionClassHandle): void {}
+  objectInstanceNameReservationSucceeded(_objectInstanceName: string): void {}
+  objectInstanceNameReservationFailed(_objectInstanceName: string): void {}
+  multipleObjectInstanceNameReservationSucceeded(_objectInstanceNames: string[]): void {}
+  multipleObjectInstanceNameReservationFailed(_objectInstanceNames: string[]): void {}
+  discoverObjectInstance(_objectInstance: ObjectInstanceHandle, _objectClass: ObjectClassHandle, _objectInstanceName: string, _producingFederate: FederateHandle): void {}
+  removeObjectInstance(_objectInstance: ObjectInstanceHandle, _userSuppliedTag: UserSuppliedTag, _producingFederate: FederateHandle): void {}
+  removeObjectInstanceWithTime(_objectInstance: ObjectInstanceHandle, _userSuppliedTag: UserSuppliedTag, _producingFederate: FederateHandle, _time: LogicalTime, _sentOrderType: OrderType, _receivedOrderType: OrderType, _retractionHandle?: MessageRetractionHandle): void {}
+  reflectAttributeValues(_objectInstance: ObjectInstanceHandle, _attributeValues: AttributeHandleValueMap, _userSuppliedTag: UserSuppliedTag, _transportationType: TransportationTypeHandle, _producingFederate: FederateHandle, _sentRegions?: ConveyedRegionSet): void {}
+  reflectAttributeValuesWithTime(_objectInstance: ObjectInstanceHandle, _attributeValues: AttributeHandleValueMap, _userSuppliedTag: UserSuppliedTag, _transportationType: TransportationTypeHandle, _producingFederate: FederateHandle, _sentRegions: ConveyedRegionSet | undefined, _time: LogicalTime, _sentOrderType: OrderType, _receivedOrderType: OrderType, _retractionHandle?: MessageRetractionHandle): void {}
+  receiveInteraction(_interactionClass: InteractionClassHandle, _parameterValues: ParameterHandleValueMap, _userSuppliedTag: UserSuppliedTag, _transportationType: TransportationTypeHandle, _producingFederate: FederateHandle, _sentRegions?: ConveyedRegionSet): void {}
+  receiveInteractionWithTime(_interactionClass: InteractionClassHandle, _parameterValues: ParameterHandleValueMap, _userSuppliedTag: UserSuppliedTag, _transportationType: TransportationTypeHandle, _producingFederate: FederateHandle, _sentRegions: ConveyedRegionSet | undefined, _time: LogicalTime, _sentOrderType: OrderType, _receivedOrderType: OrderType, _retractionHandle?: MessageRetractionHandle): void {}
+  receiveDirectedInteraction(_interactionClass: InteractionClassHandle, _objectInstance: ObjectInstanceHandle, _parameterValues: ParameterHandleValueMap, _userSuppliedTag: UserSuppliedTag, _transportationType: TransportationTypeHandle, _producingFederate: FederateHandle): void {}
+  receiveDirectedInteractionWithTime(_interactionClass: InteractionClassHandle, _objectInstance: ObjectInstanceHandle, _parameterValues: ParameterHandleValueMap, _userSuppliedTag: UserSuppliedTag, _transportationType: TransportationTypeHandle, _producingFederate: FederateHandle, _time: LogicalTime, _sentOrderType: OrderType, _receivedOrderType: OrderType, _retractionHandle?: MessageRetractionHandle): void {}
+  provideAttributeValueUpdate(_objectInstance: ObjectInstanceHandle, _attributes: AttributeHandleSet, _userSuppliedTag: UserSuppliedTag): void {}
+  turnUpdatesOnForObjectInstance(_objectInstance: ObjectInstanceHandle, _attributes: AttributeHandleSet): void {}
+  turnUpdatesOnForObjectInstanceWithRate(_objectInstance: ObjectInstanceHandle, _attributes: AttributeHandleSet, _updateRateDesignator: string): void {}
+  turnUpdatesOffForObjectInstance(_objectInstance: ObjectInstanceHandle, _attributes: AttributeHandleSet): void {}
+  attributesInScope(_objectInstance: ObjectInstanceHandle, _attributes: AttributeHandleSet): void {}
+  attributesOutOfScope(_objectInstance: ObjectInstanceHandle, _attributes: AttributeHandleSet): void {}
+  requestAttributeOwnershipAssumption(_objectInstance: ObjectInstanceHandle, _attributes: AttributeHandleSet, _userSuppliedTag: UserSuppliedTag): void {}
+  requestDivestitureConfirmation(_objectInstance: ObjectInstanceHandle, _attributes: AttributeHandleSet): void {}
+  attributeOwnershipAcquisitionNotification(_objectInstance: ObjectInstanceHandle, _attributes: AttributeHandleSet, _userSuppliedTag: UserSuppliedTag): void {}
+  attributeOwnershipUnavailable(_objectInstance: ObjectInstanceHandle, _attributes: AttributeHandleSet): void {}
+  requestAttributeOwnershipRelease(_objectInstance: ObjectInstanceHandle, _attributes: AttributeHandleSet, _userSuppliedTag: UserSuppliedTag): void {}
+  confirmAttributeOwnershipAcquisitionCancellation(_objectInstance: ObjectInstanceHandle, _attributes: AttributeHandleSet): void {}
+  informAttributeOwnership(_objectInstance: ObjectInstanceHandle, _attribute: AttributeHandle, _owner: FederateHandle): void {}
+  attributeIsNotOwned(_objectInstance: ObjectInstanceHandle, _attribute: AttributeHandle): void {}
+  attributeIsOwnedByRTI(_objectInstance: ObjectInstanceHandle, _attribute: AttributeHandle): void {}
+  timeRegulationEnabled(_time: LogicalTime): void {}
+  timeConstrainedEnabled(_time: LogicalTime): void {}
+  timeAdvanceGrant(_time: LogicalTime): void {}
+  flushQueueGrant(_time: LogicalTime): void {}
+  requestRetraction(_retractionHandle: MessageRetractionHandle): void {}
+  confirmAttributeTransportationTypeChange(_objectInstance: ObjectInstanceHandle, _attributes: AttributeHandleSet, _transportationType: TransportationTypeHandle): void {}
+  reportAttributeTransportationType(_objectInstance: ObjectInstanceHandle, _attribute: AttributeHandle, _transportationType: TransportationTypeHandle): void {}
+  confirmInteractionTransportationTypeChange(_interactionClass: InteractionClassHandle, _transportationType: TransportationTypeHandle): void {}
+  reportInteractionTransportationType(_federateHandle: FederateHandle, _interactionClass: InteractionClassHandle, _transportationType: TransportationTypeHandle): void {}
+}