hla.rti
Interface FederateAmbassador

All Known Implementing Classes:

FederateAmbassador_Impl

public interface FederateAmbassador

Federate must implement this interface.

Method Summary

void	announceSynchronizationPoint(java.lang.String synchronizationPointLabel, byte[] userSuppliedTag) The Announce Synchronization Point † service shall inform a federate of the existence of a new synchronization point label.
void	attributeIsNotOwned(int theObject, int theAttribute) The Attribute Is Not Owned † service shall be used to indicate that the specified instance attribute is unowned and available for acquisition.
void	attributeOwnedByRTI(int theObject, int theAttribute) The Attribute Owned By RTI † service shall be used to indicate that the specified instance attribute is owned by the RTI and not available for acquisition.
void	attributeOwnershipAcquisitionNotification(int theObject, AttributeHandleSet securedAttributes) The Attribute Ownership Acquisition Notification † service shall notify the federate that it now owns the specified set of instance attributes.
void	attributeOwnershipDivestitureNotification(int theObject, AttributeHandleSet releasedAttributes) The Attribute Ownership Divestiture Notification † service shall notify the federate that it no longer owns the specified set of instance attributes.
void	attributeOwnershipUnavailable(int theObject, AttributeHandleSet theAttributes) The Attribute Ownership Unavailable † service shall inform the federate that the specified instance attributes were not available for ownership acquisition.
void	attributesInScope(int theObject, AttributeHandleSet theAttributes) The Attributes In Scope † service shall notify the federate that the specified attributes for the object instance are in scope for the federate.
void	attributesOutOfScope(int theObject, AttributeHandleSet theAttributes) The Attributes Out Of Scope † service shall notify the federate that the specified attributes of the object instance are out of scope for the federate.
void	confirmAttributeOwnershipAcquisitionCancellation(int theObject, AttributeHandleSet theAttributes) The Confirm Attribute Ownership Acquisition Cancellation † service shall inform the federate that the specified instance attributes are no longer candidates for ownership acquisition.
void	discoverObjectInstance(int theObject, int theObjectClass, java.lang.String objectName) The Discover Object Instance † service shall inform the federate to discover an object instance.
void	federationNotRestored() The Federation Not Restored † service shall inform the federate that the federation restore process is completed unsuccessfully.
void	federationNotSaved() The Federation Not Saved † service shall inform the federate that the federation save process is completed unsuccessfully.
void	federationRestoreBegun() The Federation Restore Begun † service shall inform the federate that a federation restoration is imminent.
void	federationRestored() The Federation Restored † service shall inform the federate that the federation restore process is completed successfully.
void	federationSaved() The Federation Saved † service shall inform the federate that the federation save process is completed successfully.
void	federationSynchronized(java.lang.String synchronizationPointLabel) The Federation Synchronized † service shall inform the federate that all federates in the synchronization set of the specified synchronization point have invoked the Synchronization Point Achieved service for that point.
void	informAttributeOwnership(int theObject, int theAttribute, int theOwner) The Inform Attribute Ownership † service shall be used to provide ownership information for the specified instance attribute.
void	initiateFederateRestore(java.lang.String label, int federateHandle) The Initiate Federate Restore † service shall instruct the federate to return to a previously saved state.
void	initiateFederateSave(java.lang.String label) The Initiate Federate Save † service shall instruct the federate to save state.
void	provideAttributeValueUpdate(int theObject, AttributeHandleSet theAttributes) The Provide Attribute Value Update † service shall request the current values for attributes owned by the federate for a given object instance.
void	receiveInteraction(int interactionClass, ReceivedInteraction theInteraction, byte[] userSuppliedTag) The Receive Interaction † service shall provide the federate with a sent interaction.
void	receiveInteraction(int interactionClass, ReceivedInteraction theInteraction, byte[] userSuppliedTag, LogicalTime theTime, hla.rti.EventRetractionHandle eventRetractionHandle) The Receive Interaction † service shall provide the federate with a sent interaction.
void	reflectAttributeValues(int theObject, ReflectedAttributes theAttributes, byte[] userSuppliedTag) The Reflect Attribute Values † service shall provide the federate with new values for the specified instance attributes.
void	reflectAttributeValues(int theObject, ReflectedAttributes theAttributes, byte[] userSuppliedTag, LogicalTime theTime, hla.rti.EventRetractionHandle retractionHandle) The Reflect Attribute Values † service shall provide the federate with new values for the specified instance attributes.
void	removeObjectInstance(int theObject, byte[] userSuppliedTag) The Remove Object Instance † service shall inform the federate that an object instance has been deleted from the federation execution.
void	removeObjectInstance(int theObject, byte[] userSuppliedTag, LogicalTime theTime, hla.rti.EventRetractionHandle retractionHandle) The Remove Object Instance † service shall inform the federate that an object instance has been deleted from the federation execution.
void	requestAttributeOwnershipAssumption(int theObject, AttributeHandleSet offeredAttributes, byte[] userSuppliedTag) The Request Attribute Ownership Assumption † service shall inform the federate that the specified instance attributes are available for transfer of ownership to the federate.
void	requestAttributeOwnershipRelease(int theObject, AttributeHandleSet candidateAttributes, byte[] userSuppliedTag) The Request Attribute Ownership Release † service shall request that the federate release ownership of the specified instance attributes of the specified object instance.
void	requestFederationRestoreFailed(java.lang.String label, java.lang.String reason) The Request Federation Restore Failed service † shall indicate to the federate the requested federation restoration has completed unsuccessfully.
void	requestFederationRestoreSucceeded(java.lang.String label) The Request Federation Restore Succeeded service † shall indicate to the federate the requested federation restoration has completed successfully.
void	requestRetraction(hla.rti.EventRetractionHandle theHandle) If the RTI receives a legal Retract service invocation for an event that has already been delivered to a federate, the Request Retraction † service shall be invoked on that federate.
void	startRegistrationForObjectClass(int theClass) The Start Registration For Object Class † service shall notify the federate that registration of new object instances of the specified object class is advised because at least one of the class attributes that the federate is publishing at this object class is actively subscribed to at the specified object class or at a super- class of the specified object class by at least one other federate in the federation execution.
void	stopRegistrationForObjectClass(int theClass) The Stop Registration For Object Class † service shall notify the federate that registration of new object instances of the specified object class is not advised because none of the class attributes that the federate is publishing at this object class is actively subscribed to at the specified object class or at a super- class of the specified object class by any other federate in the federation execution.
void	synchronizationPointRegistrationFailed(java.lang.String synchronizationPointLabel) The Synchronization Point Registration Failed † service shall indicate to the federate that the label was already in use or that the registration of this label has otherwise failed.
void	synchronizationPointRegistrationSucceeded(java.lang.String synchronizationPointLabel) The Synchronization Point Registration Failed † service shall indicate to the federate that the label has been successfully registered.
void	timeAdvanceGrant(LogicalTime theTime) Invocation of the Time Advance Grant † service shall indicate that a prior request to advance the federate’s logical time has been honored.
void	timeConstrainedEnabled(LogicalTime theFederateTime) Invocation of the Time Constrained Enabled † service shall indicate that a prior request to become time constrained has been honored.
void	timeRegulationEnabled(LogicalTime theFederateTime) Invocation of the Time Regulation Enabled † service shall indicate that a prior request to enable time regulation has been honored.
void	turnInteractionsOff(int theHandle) The Turn Interactions Off † service shall indicate to the federate that the specified class of interactions is not relevant because it or a super- class is not actively subscribed to by any other federate in the federation execution.
void	turnInteractionsOn(int theHandle) The Turn Interactions On † service shall notify the federate that the specified class of interactions is relevant because it or a super- class is actively subscribed to by at least one other federate in the federation execution.
void	turnUpdatesOffForObjectInstance(int theObject, AttributeHandleSet theAttributes) The Turn Updates Off For Object Instance † service shall indicate to the federate that the values of the specified attributes of the object instance are not required anywhere in the federation execution.
void	turnUpdatesOnForObjectInstance(int theObject, AttributeHandleSet theAttributes) The Turn Updates On For Object Instance † service shall indicate to the federate that the values of the specified attributes of the specified object instance are required somewhere in the federation execution.

Method Detail

synchronizationPointRegistrationFailed

public void synchronizationPointRegistrationFailed(java.lang.String synchronizationPointLabel)
                                            throws hla.rti.FederateInternalError

The Synchronization Point Registration Failed † service shall indicate to the federate that the label was already in use or that the registration of this label has otherwise failed. This service shall be invoked in response to a Register Federation Synchronization Point service invocation.

Parameters:

synchronizationPointLabel - Synchronization point label

synchronizationPointRegistrationSucceeded

public void synchronizationPointRegistrationSucceeded(java.lang.String synchronizationPointLabel)
                                               throws hla.rti.FederateInternalError

The Synchronization Point Registration Failed † service shall indicate to the federate that the label has been successfully registered. This service shall be invoked in response to a Register Federation Synchronization Point service invocation.

Parameters:

synchronizationPointLabel - Synchronization point label

announceSynchronizationPoint

public void announceSynchronizationPoint(java.lang.String synchronizationPointLabel,
                                         byte[] userSuppliedTag)
                                  throws hla.rti.FederateInternalError

The Announce Synchronization Point † service shall inform a federate of the existence of a new synchronization point label. When a synchronization point label has been registered with the Register Federation Synchronization Point service, the RTI shall invoke the Announce Synchronization Point † service, at either all the federates in the execution or at the specified set of federates, to inform them of the label existence. The federates informed of the existence of a given synchronization point label via the Announce Synchronization Point † service shall form the synchronization set for that point. If the optional set of federate designators was null or not provided when the synchronization point label was registered, the RTI shall also invoke the Announce Synchronization Point † service at all federates that join the federation execution after the synchronization label was registered but before all federates that were informed of the synchronization label existence have invoked the Synchronization Point Achieved service. These newly joining federates shall also become part of the synchronization set for that point. Federates that resign from the federation execution after the announcement of a synchronization point but before the federation synchronizes at that point shall be removed from the synchronization set. The user- supplied tag supplied by the Announce Synchronization Point † service shall be the tag that was supplied to the corresponding Register Federation Synchronization Point service invocation.

Parameters:

synchronizationPointLabel - Synchronization point label

userSuppliedTag - User- supplied tag

federationSynchronized

public void federationSynchronized(java.lang.String synchronizationPointLabel)
                            throws hla.rti.FederateInternalError

The Federation Synchronized † service shall inform the federate that all federates in the synchronization set of the specified synchronization point have invoked the Synchronization Point Achieved service for that point. This service shall be invoked at all federates that are in the synchronization set for that point, indicating that the federates in the synchronization set have synchronized at that point. Once the synchronization set for a point synchronizes (the Federation Synchronized † service invoked at all federates in the set), that point shall no longer be registered and the synchronization set for that point shall no longer exist.

Parameters:

synchronizationPointLabel - Synchronization point label

initiateFederateSave

public void initiateFederateSave(java.lang.String label)
                          throws hla.rti.UnableToPerformSave,
                                 hla.rti.FederateInternalError

The Initiate Federate Save † service shall instruct the federate to save state. The federate should save as soon as possible after the invocation of the Initiate Federate Save † service. The label provided to the RTI when the save was requested, via the Request Federation Save service, shall be supplied to the federate. The federate shall use this label, the name of the federation execution, its federate designator, and its federate type, which it supplied when it invoked the Join Federation Execution service, to distinguish the saved state information. If a federate is not time- constrained, it shall expect to receive an Initiate Federate Save † service invocation at any time. If a federate is time constrained, it shall expect to receive an Initiate Federate Save † service invocation only when one of the following services is pending: Time Advance Request, Time Advance Request Available, Next Event Request, Next Event Request Available, or Flush Queue Request. The federate shall stop providing new information to the federation immediately after receiving the Initiate Federate Save † service invocation. The federate may resume providing new information to the federation only after receiving the Federation Saved † service invocation.

Parameters:

label - Federation save label

federationSaved

public void federationSaved()
                     throws hla.rti.FederateInternalError

The Federation Saved † service shall inform the federate that the federation save process is completed successfully.

federationNotSaved

public void federationNotSaved()
                        throws hla.rti.FederateInternalError

The Federation Not Saved † service shall inform the federate that the federation save process is completed unsuccessfully.

requestFederationRestoreSucceeded

public void requestFederationRestoreSucceeded(java.lang.String label)
                                       throws hla.rti.FederateInternalError

The Request Federation Restore Succeeded service † shall indicate to the federate the requested federation restoration has completed successfully. This service shall be invoked in response to a Register Federation Restore service invocation. The RTI restoration state information has been located which corresponds to the indicated label and federation execution name, a census of joined federates matches in number and type the census of federates present when the save was taken, and no other federate is currently attempting to restore the federation.

Parameters:

label - Federation save label

requestFederationRestoreFailed

public void requestFederationRestoreFailed(java.lang.String label,
                                           java.lang.String reason)
                                    throws hla.rti.FederateInternalError

The Request Federation Restore Failed service † shall indicate to the federate the requested federation restoration has completed unsuccessfully. This service shall be invoked in response to a Register Federation Restore service invocation.

Parameters:

label - Federation save label

reason - Reason why the restore failed

federationRestoreBegun

public void federationRestoreBegun()
                            throws hla.rti.FederateInternalError

The Federation Restore Begun † service shall inform the federate that a federation restoration is imminent. The federate shall stop providing new information to the federation immediately after receiving the Federation Restore Begun † service invocation. The federate may resume providing new information to the federation only after receiving the Federation Restored † service invocation.

initiateFederateRestore

public void initiateFederateRestore(java.lang.String label,
                                    int federateHandle)
                             throws hla.rti.SpecifiedSaveLabelDoesNotExist,
                                    hla.rti.CouldNotRestore,
                                    hla.rti.FederateInternalError

The Initiate Federate Restore † service shall instruct the federate to return to a previously saved state. The federate shall select the appropriate restoration state information based on the name of the current federation execution, the supplied federation save label, and the supplied federate designator. As a result of this service invocation, a federate’s designator could change from the value supplied by the Join Federation Execution service.

Parameters:

label - Federation save label

federateHandle - Federate designator

federationRestored

public void federationRestored()
                        throws hla.rti.FederateInternalError

The Federation Restored † service shall inform the federate that the federation restore process is completed successfully.

federationNotRestored

public void federationNotRestored()
                           throws hla.rti.FederateInternalError

The Federation Not Restored † service shall inform the federate that the federation restore process is completed unsuccessfully.

startRegistrationForObjectClass

public void startRegistrationForObjectClass(int theClass)
                                     throws hla.rti.ObjectClassNotPublished,
                                            hla.rti.FederateInternalError

The Start Registration For Object Class † service shall notify the federate that registration of new object instances of the specified object class is advised because at least one of the class attributes that the federate is publishing at this object class is actively subscribed to at the specified object class or at a super- class of the specified object class by at least one other federate in the federation execution. The federate should commence with registration of object instances of the specified class. Generation of the Start Registration For Object Class † service advisory shall be controlled using the Enable/ Disable Class Relevance Advisory Switch services.

Parameters:

theClass - Object class designator

stopRegistrationForObjectClass

public void stopRegistrationForObjectClass(int theClass)
                                    throws hla.rti.ObjectClassNotPublished,
                                           hla.rti.FederateInternalError

The Stop Registration For Object Class † service shall notify the federate that registration of new object instances of the specified object class is not advised because none of the class attributes that the federate is publishing at this object class is actively subscribed to at the specified object class or at a super- class of the specified object class by any other federate in the federation execution. The federate should stop registration of new object instances of the specified class. Generation of the Stop Registration For Object Class † service advisory shall be controlled using the Enable/ Disable Class Relevance Advisory Switch services.

Parameters:

theClass - Object class designator

turnInteractionsOn

public void turnInteractionsOn(int theHandle)
                        throws hla.rti.InteractionClassNotPublished,
                               hla.rti.FederateInternalError

The Turn Interactions On † service shall notify the federate that the specified class of interactions is relevant because it or a super- class is actively subscribed to by at least one other federate in the federation execution. The federate should commence with the federation- agreed- upon scheme for sending interactions of the specified class. Generation of the Turn Interactions On † service advisory shall be controlled using the Enable/ Disable Interaction Relevance Advisory Switch services.

Parameters:

theHandle - Interaction class designator

turnInteractionsOff

public void turnInteractionsOff(int theHandle)
                         throws hla.rti.InteractionClassNotPublished,
                                hla.rti.FederateInternalError

The Turn Interactions Off † service shall indicate to the federate that the specified class of interactions is not relevant because it or a super- class is not actively subscribed to by any other federate in the federation execution. Generation of the Turn Interactions Off † service advisory shall be controlled using the Enable/ Disable Interaction Relevance Advisory Switch services.

Parameters:

theHandle - Interaction class designator

discoverObjectInstance

public void discoverObjectInstance(int theObject,
                                   int theObjectClass,
                                   java.lang.String objectName)
                            throws hla.rti.CouldNotDiscover,
                                   hla.rti.ObjectClassNotKnown,
                                   hla.rti.FederateInternalError

The Discover Object Instance † service shall inform the federate to discover an object instance. An object instance shall be discovered when the instance has been registered by another federate or as the result of a Local Delete Object Instance service invocation. The object instance designator shall be unique to the local federate.

Parameters:

theObject - Object instance designator

theObjectClass - Object class designator

objectName - Object name

reflectAttributeValues

public void reflectAttributeValues(int theObject,
                                   ReflectedAttributes theAttributes,
                                   byte[] userSuppliedTag)
                            throws hla.rti.ObjectNotKnown,
                                   hla.rti.AttributeNotKnown,
                                   hla.rti.FederateOwnsAttributes,
                                   hla.rti.FederateInternalError

The Reflect Attribute Values † service shall provide the federate with new values for the specified instance attributes. This service, coupled with the Update Attribute Values service, shall form the primary data exchange mechanism supported by the RTI. All the instance attribute/ value pairs in an Update Attribute Values service invocation for instance attributes that have identical transportation and message- ordering types shall be in one corresponding Reflect Attribute Values † service invocation. This implies that one Update Attribute Values invocation could result in multiple Reflect Attribute Values † invocations in a subscribing federate.

Parameters:

theObject - Object instance designator

theAttributes - Set of attribute designator and value pairs

userSuppliedTag - User- supplied tag

reflectAttributeValues

public void reflectAttributeValues(int theObject,
                                   ReflectedAttributes theAttributes,
                                   byte[] userSuppliedTag,
                                   LogicalTime theTime,
                                   hla.rti.EventRetractionHandle retractionHandle)
                            throws hla.rti.ObjectNotKnown,
                                   hla.rti.AttributeNotKnown,
                                   hla.rti.FederateOwnsAttributes,
                                   hla.rti.InvalidFederationTime,
                                   hla.rti.FederateInternalError

The Reflect Attribute Values † service shall provide the federate with new values for the specified instance attributes. This service, coupled with the Update Attribute Values service, shall form the primary data exchange mechanism supported by the RTI. All the instance attribute/ value pairs in an Update Attribute Values service invocation for instance attributes that have identical transportation and message- ordering types shall be in one corresponding Reflect Attribute Values † service invocation. This implies that one Update Attribute Values invocation could result in multiple Reflect Attribute Values † invocations in a subscribing federate.

Parameters:

theObject - Object instance designator

theAttributes - Set of attribute designator and value pairs

userSuppliedTag - User- supplied tag

theTime - Federation time

retractionHandle - Event retraction designator

receiveInteraction

public void receiveInteraction(int interactionClass,
                               ReceivedInteraction theInteraction,
                               byte[] userSuppliedTag)
                        throws hla.rti.InteractionClassNotKnown,
                               hla.rti.InteractionParameterNotKnown,
                               hla.rti.FederateInternalError

The Receive Interaction † service shall provide the federate with a sent interaction.

Parameters:

interactionClass - Interaction class designator

theInteraction - Interaction parameters

userSuppliedTag - User- supplied tag

receiveInteraction

public void receiveInteraction(int interactionClass,
                               ReceivedInteraction theInteraction,
                               byte[] userSuppliedTag,
                               LogicalTime theTime,
                               hla.rti.EventRetractionHandle eventRetractionHandle)
                        throws hla.rti.InteractionClassNotKnown,
                               hla.rti.InteractionParameterNotKnown,
                               hla.rti.InvalidFederationTime,
                               hla.rti.FederateInternalError

The Receive Interaction † service shall provide the federate with a sent interaction.

Parameters:

interactionClass - Interaction class designator

theInteraction - Interaction parameters

userSuppliedTag - User- supplied tag

theTime - Federation time

eventRetractionHandle - Event retraction designator

removeObjectInstance

public void removeObjectInstance(int theObject,
                                 byte[] userSuppliedTag)
                          throws hla.rti.ObjectNotKnown,
                                 hla.rti.FederateInternalError

The Remove Object Instance † service shall inform the federate that an object instance has been deleted from the federation execution.

Parameters:

theObject - Object instance designator

userSuppliedTag - User- supplied tag

removeObjectInstance

public void removeObjectInstance(int theObject,
                                 byte[] userSuppliedTag,
                                 LogicalTime theTime,
                                 hla.rti.EventRetractionHandle retractionHandle)
                          throws hla.rti.ObjectNotKnown,
                                 hla.rti.InvalidFederationTime,
                                 hla.rti.FederateInternalError

The Remove Object Instance † service shall inform the federate that an object instance has been deleted from the federation execution.

Parameters:

theObject - Object instance designator

userSuppliedTag - User- supplied tag

theTime - Federation time

retractionHandle - Event retraction designator

attributesInScope

public void attributesInScope(int theObject,
                              AttributeHandleSet theAttributes)
                       throws hla.rti.ObjectNotKnown,
                              hla.rti.AttributeNotKnown,
                              hla.rti.FederateInternalError

The Attributes In Scope † service shall notify the federate that the specified attributes for the object instance are in scope for the federate. Subsequent to this service invocation, the RTI may issue Reflect Attribute Values † service invocations for any of the set of attributes for the object instance. Generation of the Attributes In Scope † service advisory can be controlled using the Enable/ Disable Attribute Scope Advisory Switch services.

Parameters:

theObject - Object instance designator

theAttributes - Set of attribute designators

attributesOutOfScope

public void attributesOutOfScope(int theObject,
                                 AttributeHandleSet theAttributes)
                          throws hla.rti.ObjectNotKnown,
                                 hla.rti.AttributeNotKnown,
                                 hla.rti.FederateInternalError

The Attributes Out Of Scope † service shall notify the federate that the specified attributes of the object instance are out of scope for the federate. The RTI shall guarantee not to issue any subsequent Reflect Attribute Values † service invocations for any of the set of attributes for the object instance. Generation of the Attributes Out Of Scope † service advisory can be controlled using the Enable/ Disable Attribute Scope Advisory Switch services.

Parameters:

theObject - Object instance designator

theAttributes - Set of attribute designators

provideAttributeValueUpdate

public void provideAttributeValueUpdate(int theObject,
                                        AttributeHandleSet theAttributes)
                                 throws hla.rti.ObjectNotKnown,
                                        hla.rti.AttributeNotKnown,
                                        hla.rti.AttributeNotOwned,
                                        hla.rti.FederateInternalError

The Provide Attribute Value Update † service shall request the current values for attributes owned by the federate for a given object instance. The federate shall respond to the Provide Attribute Value Update † service with an invocation of the Update Attribute Values service to provide the requested instance attribute values to the federation.

Parameters:

theObject - Object instance designator

theAttributes - Set of attribute designators

turnUpdatesOnForObjectInstance

public void turnUpdatesOnForObjectInstance(int theObject,
                                           AttributeHandleSet theAttributes)
                                    throws hla.rti.ObjectNotKnown,
                                           hla.rti.AttributeNotOwned,
                                           hla.rti.FederateInternalError

The Turn Updates On For Object Instance † service shall indicate to the federate that the values of the specified attributes of the specified object instance are required somewhere in the federation execution. The federate shall commence with the federation- agreed- upon update scheme for the specified instance attributes. Generation of the Turn Updates On For Object Instance † service advisory can be controlled using the Enable/ Disable Attribute Relevance Advisory Switch services.

Parameters:

theObject - Object instance designator

theAttributes - Set of attribute designators type

turnUpdatesOffForObjectInstance

public void turnUpdatesOffForObjectInstance(int theObject,
                                            AttributeHandleSet theAttributes)
                                     throws hla.rti.ObjectNotKnown,
                                            hla.rti.AttributeNotOwned,
                                            hla.rti.FederateInternalError

The Turn Updates Off For Object Instance † service shall indicate to the federate that the values of the specified attributes of the object instance are not required anywhere in the federation execution. Generation of the Turn Updates Off For Object Instance † service advisory can be controlled using the Enable/ Disable Attribute Relevance Advisory Switch services.

Parameters:

theObject - Object instance designator

theAttributes - Set of attribute designators

requestAttributeOwnershipAssumption

public void requestAttributeOwnershipAssumption(int theObject,
                                                AttributeHandleSet offeredAttributes,
                                                byte[] userSuppliedTag)
                                         throws hla.rti.ObjectNotKnown,
                                                hla.rti.AttributeNotKnown,
                                                hla.rti.AttributeAlreadyOwned,
                                                hla.rti.AttributeNotPublished,
                                                hla.rti.FederateInternalError

The Request Attribute Ownership Assumption † service shall inform the federate that the specified instance attributes are available for transfer of ownership to the federate. The RTI shall supply an object instance designator and set of attribute designators. The federate may return a subset of the supplied attribute designators for which it is willing to assume ownership via the Attribute Ownership Acquisition service or via the Attribute Ownership Acquisition If Available service. In the case that the supplied instance attributes are unowned as a result of a federate invoking the Unconditional Attribute Ownership Divestiture service, the divesting federate shall not be asked to assume ownership.

Parameters:

theObject - Object instance designator

offeredAttributes - Set of attribute designators

userSuppliedTag - User- supplied tag

attributeOwnershipDivestitureNotification

public void attributeOwnershipDivestitureNotification(int theObject,
                                                      AttributeHandleSet releasedAttributes)
                                               throws hla.rti.ObjectNotKnown,
                                                      hla.rti.AttributeNotKnown,
                                                      hla.rti.AttributeNotOwned,
                                                      hla.rti.AttributeDivestitureWasNotRequested,
                                                      hla.rti.FederateInternalError

The Attribute Ownership Divestiture Notification † service shall notify the federate that it no longer owns the specified set of instance attributes. Upon this notification, the federate shall stop updating the specified instance attribute values. The federate may receive multiple notifications for a single invocation of the Negotiated Attribute Ownership Divestiture service since different federates may wish to become the owner of different instance attributes.

Parameters:

theObject - Object instance designator

releasedAttributes - Set of attribute designators

attributeOwnershipAcquisitionNotification

public void attributeOwnershipAcquisitionNotification(int theObject,
                                                      AttributeHandleSet securedAttributes)
                                               throws hla.rti.ObjectNotKnown,
                                                      hla.rti.AttributeNotKnown,
                                                      hla.rti.AttributeAcquisitionWasNotRequested,
                                                      hla.rti.AttributeAlreadyOwned,
                                                      hla.rti.AttributeNotPublished,
                                                      hla.rti.FederateInternalError

The Attribute Ownership Acquisition Notification † service shall notify the federate that it now owns the specified set of instance attributes. The federate may then begin updating those instance attribute values. The federate may receive multiple notifications for a single invocation of the Attribute Ownership Acquisition service since the federate may wish to become the owner of instance attributes owned by different federates.

Parameters:

theObject - Object instance designator

securedAttributes - Set of attribute designators

attributeOwnershipUnavailable

public void attributeOwnershipUnavailable(int theObject,
                                          AttributeHandleSet theAttributes)
                                   throws hla.rti.ObjectNotKnown,
                                          hla.rti.AttributeNotKnown,
                                          hla.rti.AttributeAlreadyOwned,
                                          hla.rti.AttributeAcquisitionWasNotRequested,
                                          hla.rti.FederateInternalError

The Attribute Ownership Unavailable † service shall inform the federate that the specified instance attributes were not available for ownership acquisition.

Parameters:

theObject - Object instance designator

theAttributes - Set of attribute designators

requestAttributeOwnershipRelease

public void requestAttributeOwnershipRelease(int theObject,
                                             AttributeHandleSet candidateAttributes,
                                             byte[] userSuppliedTag)
                                      throws hla.rti.ObjectNotKnown,
                                             hla.rti.AttributeNotKnown,
                                             hla.rti.AttributeNotOwned,
                                             hla.rti.FederateInternalError

The Request Attribute Ownership Release † service shall request that the federate release ownership of the specified instance attributes of the specified object instance. The Request Attribute Ownership Release † service shall provide an object instance designator and set of attribute designators and shall be invoked only as the result of an Attribute Ownership Acquisition service invocation by some other federate. The federate may return the subset of the supplied instance attributes for which it is willing to release ownership via the Attribute Ownership Release Response service, the Unconditional Attribute Ownership Divestiture service, or the Negotiated Attribute Ownership Divestiture service.

Parameters:

theObject - Object instance designator

candidateAttributes - Set of attribute designators

userSuppliedTag - User- supplied tag

confirmAttributeOwnershipAcquisitionCancellation

public void confirmAttributeOwnershipAcquisitionCancellation(int theObject,
                                                             AttributeHandleSet theAttributes)
                                                      throws hla.rti.ObjectNotKnown,
                                                             hla.rti.AttributeNotKnown,
                                                             hla.rti.AttributeAlreadyOwned,
                                                             hla.rti.AttributeAcquisitionWasNotCanceled,
                                                             hla.rti.FederateInternalError

The Confirm Attribute Ownership Acquisition Cancellation † service shall inform the federate that the specified instance attributes are no longer candidates for ownership acquisition.

Parameters:

theObject - Object instance designator

theAttributes - Set of attribute designators

informAttributeOwnership

public void informAttributeOwnership(int theObject,
                                     int theAttribute,
                                     int theOwner)
                              throws hla.rti.ObjectNotKnown,
                                     hla.rti.AttributeNotKnown,
                                     hla.rti.FederateInternalError

The Inform Attribute Ownership † service shall be used to provide ownership information for the specified instance attribute. This service shall be invoked by the RTI in response to a Query Attribute Ownership service invocation by a federate. This service shall provide the federate a designator of the instance attribute owner (if the instance attribute is owned) or an indication that the instance attribute is available for acquisition.

Parameters:

theObject - Object instance designator

theAttribute - Attribute designator

theOwner - Ownership designator

attributeIsNotOwned

public void attributeIsNotOwned(int theObject,
                                int theAttribute)
                         throws hla.rti.ObjectNotKnown,
                                hla.rti.AttributeNotKnown,
                                hla.rti.FederateInternalError

The Attribute Is Not Owned † service shall be used to indicate that the specified instance attribute is unowned and available for acquisition.

Parameters:

theObject - Object instance designator

theAttribute - Attribute designator

attributeOwnedByRTI

public void attributeOwnedByRTI(int theObject,
                                int theAttribute)
                         throws hla.rti.ObjectNotKnown,
                                hla.rti.AttributeNotKnown,
                                hla.rti.FederateInternalError

The Attribute Owned By RTI † service shall be used to indicate that the specified instance attribute is owned by the RTI and not available for acquisition.

Parameters:

theObject - Object instance designator

theAttribute - Attribute designator

timeRegulationEnabled

public void timeRegulationEnabled(LogicalTime theFederateTime)
                           throws hla.rti.InvalidFederationTime,
                                  hla.rti.EnableTimeRegulationWasNotPending,
                                  hla.rti.FederateInternalError

Invocation of the Time Regulation Enabled † service shall indicate that a prior request to enable time regulation has been honored. The value of this service’s argument shall indicate that the logical time of the federate has been set to the specified value.

Parameters:

theFederateTime - Current logical time of the federate

timeConstrainedEnabled

public void timeConstrainedEnabled(LogicalTime theFederateTime)
                            throws hla.rti.InvalidFederationTime,
                                   hla.rti.EnableTimeConstrainedWasNotPending,
                                   hla.rti.FederateInternalError

Invocation of the Time Constrained Enabled † service shall indicate that a prior request to become time constrained has been honored. The value of this service’s argument shall indicate the current logical time of the federate. When a federate changes to be time constrained, TSO messages stored in the RTI’s internal queues that have time stamps greater than or equal to the federate’s logical time shall be delivered in time- stamp order. TSO messages delivered to the federate before it becomes time constrained, possibly including messages with time stamps greater than or equal to the federate’s current logical time, shall be delivered as RO messages. Federates that are time constrained may receive messages only when in the Time Advancing state unless asynchronous message delivery is enabled (by use of the Enable Asynchronous Delivery † service). If asynchronous message delivery is enabled, the time- constrained federate may receive RO messages when not in the Time Advancing state, but TSO messages may still be received only when in the Time Advancing state. If the federate is time regulating, the argument shall equal the federate's current logical time. If the federate is not time regulating, the argument shall be greater than or equal to the federate’s current logical time.

Parameters:

theFederateTime - Value of federation time

timeAdvanceGrant

public void timeAdvanceGrant(LogicalTime theTime)
                      throws hla.rti.InvalidFederationTime,
                             hla.rti.TimeAdvanceWasNotInProgress,
                             hla.rti.FederateInternalError

Invocation of the Time Advance Grant † service shall indicate that a prior request to advance the federate’s logical time has been honored. The argument of this service shall indicate that the logical time for the federate has been advanced to this value. If the grant is issued in response to invocation of Next Event Request or Time Advance Request, the RTI shall guarantee that no additional TSO messages shall be delivered in the future with time stamps less than or equal to this value. If the grant is in response to an invocation of Time Advance Request Available, Next Event Request Available, or Flush Queue Request, the RTI shall guarantee that no additional TSO messages shall be delivered in the future with time stamps less than the value of the grant.

Parameters:

theTime - Value of federation time

requestRetraction

public void requestRetraction(hla.rti.EventRetractionHandle theHandle)
                       throws hla.rti.EventNotKnown,
                              hla.rti.FederateInternalError

If the RTI receives a legal Retract service invocation for an event that has already been delivered to a federate, the Request Retraction † service shall be invoked on that federate. If the event in question has not been delivered to a federate, this service shall not be invoked on that federate; the event shall be removed from the RTI’s event queue and never delivered to the federate.

Parameters:

theHandle - Event retraction designator