ManagementProxyAmbassador (XRTI API Documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.npsnet.xrti.proxies
Class ManagementProxyAmbassador

java.lang.Object
  org.npsnet.xrti.utilities.ProxyAmbassador
      org.npsnet.xrti.proxies.ManagementProxyAmbassador

All Implemented Interfaces:: FederateAmbassador

public class ManagementProxyAmbassador
extends ProxyAmbassador

Autogenerated proxy ambassador.

Author:: org.npsnet.xrti.utilities.ProxyCompiler

Field Summary

Fields inherited from class org.npsnet.xrti.utilities.ProxyAmbassador

objectInstanceHandleProxyMap, proxyAmbassadorListeners, rtiAmbassador

Constructor Summary
`ManagementProxyAmbassador(RTIambassador pRTIAmbassador)` Constructor.

Method Summary
`void`	`addInteractionListener(ManagementInteractionListener il)` Adds a listener for the interactions processed by this ambassador.
`void`	`discoverObjectInstance(ObjectInstanceHandle theObject, ObjectClassHandle theObjectClass, java.lang.String objectName)` Notifies the federate of the presence of an object instance.
`HLAfederateProxy`	`newHLAfederate()` Registers a new HLAfederate and returns a proxy object that may be used to examine and control its state.
`HLAfederateProxy`	`newHLAfederate(java.lang.String name)` Registers a new HLAfederate with the specified name and returns a proxy object that may be used to examine and control its state.
`HLAfederationProxy`	`newHLAfederation()` Registers a new HLAfederation and returns a proxy object that may be used to examine and control its state.
`HLAfederationProxy`	`newHLAfederation(java.lang.String name)` Registers a new HLAfederation with the specified name and returns a proxy object that may be used to examine and control its state.
`HLAmanagerProxy`	`newHLAmanager()` Registers a new HLAmanager and returns a proxy object that may be used to examine and control its state.
`HLAmanagerProxy`	`newHLAmanager(java.lang.String name)` Registers a new HLAmanager with the specified name and returns a proxy object that may be used to examine and control its state.
`HLAobjectRootProxy`	`newHLAobjectRoot()` Registers a new HLAobjectRoot and returns a proxy object that may be used to examine and control its state.
`HLAobjectRootProxy`	`newHLAobjectRoot(java.lang.String name)` Registers a new HLAobjectRoot with the specified name and returns a proxy object that may be used to examine and control its state.
`void`	`publishAndSubscribeObjectClassAttributes()` Publishes and subscribes all supported object class attributes.
`void`	`receiveInteraction(InteractionClassHandle interactionClass, ParameterHandleValueMap theParameters, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Notifies the federate of a received interaction.
`void`	`removeInteractionListener(ManagementInteractionListener il)` Removes a listener for the interactions processed by this ambassador.
`void`	`sendHLAdeleteObjectInstance(byte[] HLAfederate, byte[] HLAobjectInstance, byte[] HLAtag, byte[] HLAtimeStamp, byte[] userSuppliedTag)` Cause an object instance to be deleted from the federation.
`void`	`sendHLAdisableAsynchronousDelivery(byte[] HLAfederate, byte[] userSuppliedTag)` When the joined federate is time-constrained, cause the RTI to deliver receive-order messages to the joined federate only when its time manager state is Time Advancing.
`void`	`sendHLAdisableTimeConstrained(byte[] HLAfederate, byte[] userSuppliedTag)` Cause the logical time of the joined federate to cease being constrained by the logical times of other joined federates.
`void`	`sendHLAdisableTimeRegulation(byte[] HLAfederate, byte[] userSuppliedTag)` Cause the joined federate to cease regulating the logical time of other joined federates.
`void`	`sendHLAenableAsynchronousDelivery(byte[] HLAfederate, byte[] userSuppliedTag)` Cause the RTI to deliver receive-order messages to the joined federate at any time, even if the joined federate is time-constrained.
`void`	`sendHLAenableTimeConstrained(byte[] HLAfederate, byte[] userSuppliedTag)` Cause the logical time of the joined federate to begin being constrained by the logical times of other joined federates.
`void`	`sendHLAenableTimeRegulation(byte[] HLAfederate, byte[] HLAlookahead, byte[] userSuppliedTag)` Cause the joined federate to begin regulating the logical time of other joined federates.
`void`	`sendHLAfederateRestoreComplete(byte[] HLAfederate, boolean HLAsuccessIndicator, byte[] userSuppliedTag)` Mimic the joined federate's report of completion of a restore.
`void`	`sendHLAfederateSaveBegun(byte[] HLAfederate, byte[] userSuppliedTag)` Mimic the federate's report of starting a save.
`void`	`sendHLAfederateSaveComplete(byte[] HLAfederate, boolean HLAsuccessIndicator, byte[] userSuppliedTag)` Mimic the joined federate's report of completion of a save.
`void`	`sendHLAflushQueueRequest(byte[] HLAfederate, byte[] HLAtimeStamp, byte[] userSuppliedTag)` Request the logical time of the joined federate to be advanced as far as possible, provided that the time stamp is less than or equal to the logical time specified in the request.
`void`	`sendHLAchangeAttributeOrderType(byte[] HLAfederate, byte[] HLAobjectInstance, byte[][] HLAattributeList, HLAorderType HLAsendOrder, byte[] userSuppliedTag)` Change the ordering type used by the joined federate when sending attributes belonging to the object instance.
`void`	`sendHLAchangeAttributeTransportationType(byte[] HLAfederate, byte[] HLAobjectInstance, byte[][] HLAattributeList, char[] HLAtransportation, byte[] userSuppliedTag)` Change the transportation type used by the joined federate when sending attributes belonging to the object instance.
`void`	`sendHLAchangeInteractionOrderType(byte[] HLAfederate, byte[] HLAinteractionClass, HLAorderType HLAsendOrder, byte[] userSuppliedTag)` Change the order type used by the joined federate when sending a class of interaction.
`void`	`sendHLAchangeInteractionTransportationType(byte[] HLAfederate, byte[] HLAinteractionClass, char[] HLAtransportation, byte[] userSuppliedTag)` Change the transportation type used by the joined federate when sending a class of interaction.
`void`	`sendHLAlocalDeleteObjectInstance(byte[] HLAfederate, byte[] HLAobjectInstance, byte[] userSuppliedTag)` Inform the RTI that it shall treat the specified object instance as if thejoined federate did not know about the object instance.
`void`	`sendHLAmodifyAttributeState(byte[] HLAfederate, byte[] HLAobjectInstance, byte[] HLAattribute, HLAownership HLAattributeState, byte[] userSuppliedTag)` Modify the ownership state of an attribute of an object instance for the specified joined federate.
`void`	`sendHLAmodifyLookahead(byte[] HLAfederate, byte[] HLAlookahead, byte[] userSuppliedTag)` Change the lookahead value used by the joined federate.
`void`	`sendHLAnextMessageRequest(byte[] HLAfederate, byte[] HLAtimeStamp, byte[] userSuppliedTag)` Request the logical time of the joined federate to be advanced to the time stamp of the next TSO message that shall be delivered to the joined federate, provided that the message shall have a time stamp no greater than the logical time specified in the request, and release zero or more messages for delivery to the joined federate.
`void`	`sendHLAnextMessageRequestAvailable(byte[] HLAfederate, byte[] HLAtimeStamp, byte[] userSuppliedTag)` Request the logical time of the joined federate to be advanced to the time stamp of the next TSO message that shall be delivered to the joined federate, provided that the message shall have a time stamp no greater than the logical time specified in the request, and release zero or more messages for delivery to the joined federate.
`void`	`sendHLApublishInteractionClass(byte[] HLAfederate, byte[] HLAinteractionClass, byte[] userSuppliedTag)` Set the joined federate's publication status of an interaction class.
`void`	`sendHLApublishObjectClassAttributes(byte[] HLAfederate, byte[] HLAobjectClass, byte[][] HLAattributeList, byte[] userSuppliedTag)` Set the joined federate's publication status of attributes belonging to an object class.
`void`	`sendHLAreportException(byte[] HLAfederate, java.lang.String HLAservice, java.lang.String HLAexception, byte[] userSuppliedTag)` The interaction shall be sent by the RTI when an exception occurs as the result of a service invocation at the indicated joined federate.
`void`	`sendHLAreportInteractionPublication(byte[] HLAfederate, byte[][] HLAinteractionClassList, byte[] userSuppliedTag)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`sendHLAreportInteractionsReceived(byte[] HLAfederate, char[] HLAtransportation, HLAinteractionCount[] HLAinteractionCounts, byte[] userSuppliedTag)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`sendHLAreportInteractionsSent(byte[] HLAfederate, char[] HLAtransportation, HLAinteractionCount[] HLAinteractionCounts, byte[] userSuppliedTag)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`sendHLAreportInteractionSubscription(byte[] HLAfederate, HLAinteractionSubscription[] HLAinteractionClassList, byte[] userSuppliedTag)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`sendHLAreportMOMexception(byte[] HLAfederate, java.lang.String HLAservice, java.lang.String HLAexception, boolean HLAparameterError, byte[] userSuppliedTag)` The interaction shall be sent by the RTI when one the following occurs: - a MOM interaction without all the necessary parameters is sent or - an interaction that imitates a federate's invocation of an RTI service is sent and not all of the service's pre-conditions are met.
`void`	`sendHLAreportObjectClassPublication(byte[] HLAfederate, int HLAnumberOfClasses, byte[] HLAobjectClass, byte[][] HLAattributeList, byte[] userSuppliedTag)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`sendHLAreportObjectClassSubscription(byte[] HLAfederate, int HLAnumberOfClasses, byte[] HLAobjectClass, boolean HLAactive, byte[][] HLAattributeList, byte[] userSuppliedTag)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`sendHLAreportObjectInstanceInformation(byte[] HLAfederate, byte[] HLAobjectInstance, byte[][] HLAownedInstanceAttributeList, byte[] HLAregisteredClass, byte[] HLAknownClass, byte[] userSuppliedTag)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`sendHLAreportObjectInstancesReflected(byte[] HLAfederate, HLAobjectClassBasedCount[] HLAobjectInstanceCounts, byte[] userSuppliedTag)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`sendHLAreportObjectInstancesThatCanBeDeleted(byte[] HLAfederate, HLAobjectClassBasedCount[] HLAobjectInstanceCounts, byte[] userSuppliedTag)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.HLArequest.HLArequestObject InstancesThatCanBeDeleted.
`void`	`sendHLAreportObjectInstancesUpdated(byte[] HLAfederate, HLAobjectClassBasedCount[] HLAobjectInstanceCounts, byte[] userSuppliedTag)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`sendHLAreportReflectionsReceived(byte[] HLAfederate, char[] HLAtransportation, HLAobjectClassBasedCount[] HLAreflectCounts, byte[] userSuppliedTag)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`sendHLAreportServiceInvocation(byte[] HLAfederate, java.lang.String HLAservice, boolean HLAsuccessIndicator, java.lang.String[] HLAsuppliedArguments, java.lang.String[] HLAreturnedArguments, java.lang.String HLAexception, int HLAserialNumber, byte[] userSuppliedTag)` This interaction shall be sent by the RTI whenever an HLA service is invoked, either by the indicated joined federate or by the RTI at the indicated joined federate, and Service Reporting is Enabled for the indicated joined federate.
`void`	`sendHLAreportSynchronizationPoints(byte[] HLAfederate, java.lang.String[] HLAsynchPoints, byte[] userSuppliedTag)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`sendHLAreportSynchronizationPointStatus(byte[] HLAfederate, java.lang.String HLAsynchPointName, HLAsynchPointFederate[] HLAsynchPointFederates, byte[] userSuppliedTag)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`sendHLAreportUpdatesSent(byte[] HLAfederate, char[] HLAtransportation, HLAobjectClassBasedCount[] HLAupdateCounts, byte[] userSuppliedTag)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`sendHLArequestInteractionsReceived(byte[] HLAfederate, byte[] userSuppliedTag)` Request that the RTI send a report interaction that contains the number of interactions that a joined federate has received.
`void`	`sendHLArequestInteractionsSent(byte[] HLAfederate, byte[] userSuppliedTag)` Request that the RTI send a report interaction that contains the number of interactions that a joined federate has generated.
`void`	`sendHLArequestObjectInstanceInformation(byte[] HLAfederate, byte[] HLAobjectInstance, byte[] userSuppliedTag)` Request that the RTI send a report interaction that contains the information that a joined federate maintains on a single object instance.
`void`	`sendHLArequestObjectInstancesReflected(byte[] HLAfederate, byte[] userSuppliedTag)` Request that the RTI send a report interaction that contains the objects instances for which a joined federate has had a Reflect Attribute Values service invocation.
`void`	`sendHLArequestObjectInstancesThatCanBeDeleted(byte[] HLAfederate, byte[] userSuppliedTag)` Request that the RTI send a report interaction that contains the object instances that can be deleted at the joined federate.
`void`	`sendHLArequestObjectInstancesUpdated(byte[] HLAfederate, byte[] userSuppliedTag)` Request that the RTI send a report interaction that contains the object instance updating responsibility of a joined federate.
`void`	`sendHLArequestPublications(byte[] HLAfederate, byte[] userSuppliedTag)` Request that the RTI send report interactions that contain the publication data of a joined federate.
`void`	`sendHLArequestReflectionsReceived(byte[] HLAfederate, byte[] userSuppliedTag)` Request that the RTI send a report interaction that contains the number of reflections that a joined federate has received.
`void`	`sendHLArequestSubscriptions(byte[] HLAfederate, byte[] userSuppliedTag)` Request that the RTI send report interactions that contain the subscription data of a joined federate.
`void`	`sendHLArequestSynchronizationPoints(byte[] HLAfederate, byte[] userSuppliedTag)` Request that the RTI send a report interaction that contains a list of all in-progress federation synchronization points.
`void`	`sendHLArequestSynchronizationPointStatus(byte[] HLAfederate, byte[] userSuppliedTag)` Request that the RTI send a report interaction that contains a list that includes each federate (and its synchronization point status) that is associated with a particular synchronization point.
`void`	`sendHLArequestUpdatesSent(byte[] HLAfederate, byte[] userSuppliedTag)` Request that the RTI send a report interaction that contains the number of updates that a joined federate has generated.
`void`	`sendHLAresignFederationExecution(byte[] HLAfederate, HLAresignAction HLAresignAction, byte[] userSuppliedTag)` Cause the joined federate to resign from the federation execution.
`void`	`sendHLAsetExceptionReporting(byte[] HLAfederate, boolean HLAreportingState, byte[] userSuppliedTag)` Specify whether the RTI shall report service invocation exceptions via HLAmanager.HLAfederate.HLAreport.
`void`	`sendHLAsetServiceReporting(byte[] HLAfederate, boolean HLAreportingState, byte[] userSuppliedTag)` Specify whether to report service invocations to0 or from the specified joined federate via HLAmanager.HLAfederate.
`void`	`sendHLAsetSwitches(HLAswitch HLAautoProvide, HLAswitch HLAconveyRegionDesignatorSets, byte[] userSuppliedTag)` Set the values of several HLA switches.
`void`	`sendHLAsetTiming(byte[] HLAfederate, int HLAreportPeriod, byte[] userSuppliedTag)` Adjust the time period between updates of the HLAmanager.HLAfederate object instance for the specified joined federate.
`void`	`sendHLAsubscribeInteractionClass(byte[] HLAfederate, byte[] HLAinteractionClass, boolean HLAactive, byte[] userSuppliedTag)` Set the joined federate's subscription status to an interaction class.
`void`	`sendHLAsubscribeObjectClassAttributes(byte[] HLAfederate, byte[] HLAobjectClass, byte[][] HLAattributeList, boolean HLAactive, byte[] userSuppliedTag)` Set the joined federate's subscription status of attributes belonging to an object class.
`void`	`sendHLAsynchronizationPointAchieved(byte[] HLAfederate, java.lang.String HLAlabel, byte[] userSuppliedTag)` Mimic the federate's report of achieving a synchronization point.
`void`	`sendHLAtimeAdvanceRequest(byte[] HLAfederate, byte[] HLAtimeStamp, byte[] userSuppliedTag)` Request an advance of the joined federate's logical time on behalf of the joined federate, and release zero or more messages for delivery to the joined federate.
`void`	`sendHLAtimeAdvanceRequestAvailable(byte[] HLAfederate, byte[] HLAtimeStamp, byte[] userSuppliedTag)` Request an advance of the joined federate's logical time, on behalf of the joined federate, and release zero or more messages for delivery to the joined federate.
`void`	`sendHLAunconditionalAttributeOwnershipDivestiture(byte[] HLAfederate, byte[] HLAobjectInstance, byte[][] HLAattributeList, byte[] userSuppliedTag)` Cause the ownership of attributes of an object instance to be unconditionally divested by the joined federate.
`void`	`sendHLAunpublishInteractionClass(byte[] HLAfederate, byte[] HLAinteractionClass, byte[] userSuppliedTag)` Cause the joined federate no longer to publish an interaction class.
`void`	`sendHLAunpublishObjectClassAttributes(byte[] HLAfederate, byte[] HLAobjectClass, byte[][] HLAattributeList, byte[] userSuppliedTag)` Cause the joined federate no longer to publish attributes of an object class.
`void`	`sendHLAunsubscribeInteractionClass(byte[] HLAfederate, byte[] HLAinteractionClass, byte[] userSuppliedTag)` Cause the joined federate no longer to subscribe to an interaction class.
`void`	`sendHLAunsubscribeObjectClassAttributes(byte[] HLAfederate, byte[] HLAobjectClass, byte[][] HLAattributeList, byte[] userSuppliedTag)` Cause the joined federate no longer to subscribe to attributes of an object class.

Methods inherited from class org.npsnet.xrti.utilities.ProxyAmbassador

addProxyAmbassadorListener, announceSynchronizationPoint, attributeIsNotOwned, attributeIsOwnedByRTI, attributeOwnershipAcquisitionNotification, attributeOwnershipUnavailable, attributesInScope, attributesOutOfScope, confirmAttributeOwnershipAcquisitionCancellation, deregisterFederateAmbassador, federationNotRestored, federationNotSaved, federationRestoreBegun, federationRestored, federationRestoreStatusResponse, federationSaved, federationSaveStatusResponse, federationSynchronized, getObjectInstanceProxies, getObjectInstanceProxy, informAttributeOwnership, initiateFederateRestore, initiateFederateSave, initiateFederateSave, objectInstanceNameReservationFailed, objectInstanceNameReservationSucceded, provideAttributeValueUpdate, receiveInteraction, receiveInteraction, receiveInteraction, receiveInteraction, receiveInteraction, reflectAttributeValues, reflectAttributeValues, reflectAttributeValues, reflectAttributeValues, reflectAttributeValues, reflectAttributeValues, registerFederateAmbassador, removeObjectInstance, removeObjectInstance, removeObjectInstance, removeProxyAmbassadorListener, requestAttributeOwnershipAssumption, requestAttributeOwnershipRelease, requestDivestitureConfirmation, requestFederationRestoreFailed, requestFederationRestoreSucceeded, requestRetraction, startRegistrationForObjectClass, stopRegistrationForObjectClass, synchronizationPointRegistrationFailed, synchronizationPointRegistrationSucceeded, timeAdvanceGrant, timeConstrainedEnabled, timeRegulationEnabled, turnInteractionsOff, turnInteractionsOn, turnUpdatesOffForObjectInstance, turnUpdatesOnForObjectInstance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ManagementProxyAmbassador

public ManagementProxyAmbassador(RTIambassador pRTIAmbassador)
                          throws InvalidInteractionClassHandle,
                                 InvalidObjectClassHandle,
                                 NameNotFound,
                                 InteractionClassNotDefined,
                                 FederateServiceInvocationsAreBeingReportedViaMOM,
                                 FederateNotExecutionMember,
                                 SaveInProgress,
                                 RestoreInProgress,
                                 RTIinternalError

Constructor.
Parameters:: pRTIAmbassador - the run-time infrastructure ambassador
Throws:: InvalidInteractionClassHandle - if an interaction class handle was invalid; NameNotFound - if an interaction or parameter name was not found; InteractionClassNotDefined - if an interaction class is not defined; FederateServiceInvocationsAreBeingReportedViaMOM - if federate service invocations are being reported via the management object model; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurred in the run-time infrastructure; InvalidObjectClassHandle

Method Detail

publishAndSubscribeObjectClassAttributes

public void publishAndSubscribeObjectClassAttributes()
                                              throws InvalidObjectClassHandle,
                                                     NameNotFound,
                                                     ObjectClassNotDefined,
                                                     AttributeNotDefined,
                                                     FederateNotExecutionMember,
                                                     SaveInProgress,
                                                     RestoreInProgress,
                                                     RTIinternalError

Publishes and subscribes all supported object class attributes.

Throws:: InvalidObjectClassHandle - if an object class handle is invalid; NameNotFound - if a name is not found; ObjectClassNotDefined - if an object class is undefined; AttributeNotDefined - if an attribute is undefined; FederateNotExecutionMember - if the federate is not an execution member; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

newHLAobjectRoot

public HLAobjectRootProxy newHLAobjectRoot()
                                    throws ObjectClassNotDefined,
                                           ObjectClassNotPublished,
                                           FederateNotExecutionMember,
                                           SaveInProgress,
                                           RestoreInProgress,
                                           RTIinternalError

Registers a new HLAobjectRoot and returns a proxy object that may be used to examine and control its state.

Returns:: the newly created proxy object
Throws:: ObjectClassNotDefined - if the specified object class is not defined; ObjectClassNotPublished - if the specified object class is not published; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurred in the run-time infrastructure

newHLAobjectRoot

public HLAobjectRootProxy newHLAobjectRoot(java.lang.String name)
                                    throws ObjectClassNotDefined,
                                           ObjectClassNotPublished,
                                           IllegalName,
                                           ObjectInstanceNameInUse,
                                           FederateNotExecutionMember,
                                           SaveInProgress,
                                           RestoreInProgress,
                                           RTIinternalError

Registers a new HLAobjectRoot with the specified name and returns a proxy object that may be used to examine and control its state.

Parameters:: name - the name of the new object
Returns:: the newly created proxy object
Throws:: ObjectClassNotDefined - if the specified object class is not defined; ObjectClassNotPublished - if the specified object class is not published; IllegalName - if the instance name has is illegal; ObjectInstanceNameInUse - if the instance name is already in use; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurred in the run-time infrastructure

newHLAmanager

public HLAmanagerProxy newHLAmanager()
                              throws ObjectClassNotDefined,
                                     ObjectClassNotPublished,
                                     FederateNotExecutionMember,
                                     SaveInProgress,
                                     RestoreInProgress,
                                     RTIinternalError

Registers a new HLAmanager and returns a proxy object that may be used to examine and control its state.

Returns:: the newly created proxy object
Throws:: ObjectClassNotDefined - if the specified object class is not defined; ObjectClassNotPublished - if the specified object class is not published; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurred in the run-time infrastructure

newHLAmanager

public HLAmanagerProxy newHLAmanager(java.lang.String name)
                              throws ObjectClassNotDefined,
                                     ObjectClassNotPublished,
                                     IllegalName,
                                     ObjectInstanceNameInUse,
                                     FederateNotExecutionMember,
                                     SaveInProgress,
                                     RestoreInProgress,
                                     RTIinternalError

Registers a new HLAmanager with the specified name and returns a proxy object that may be used to examine and control its state.

Parameters:: name - the name of the new object
Returns:: the newly created proxy object
Throws:: ObjectClassNotDefined - if the specified object class is not defined; ObjectClassNotPublished - if the specified object class is not published; IllegalName - if the instance name has is illegal; ObjectInstanceNameInUse - if the instance name is already in use; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurred in the run-time infrastructure

newHLAfederate

public HLAfederateProxy newHLAfederate()
                                throws ObjectClassNotDefined,
                                       ObjectClassNotPublished,
                                       FederateNotExecutionMember,
                                       SaveInProgress,
                                       RestoreInProgress,
                                       RTIinternalError

Registers a new HLAfederate and returns a proxy object that may be used to examine and control its state.

Returns:: the newly created proxy object
Throws:: ObjectClassNotDefined - if the specified object class is not defined; ObjectClassNotPublished - if the specified object class is not published; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurred in the run-time infrastructure

newHLAfederate

public HLAfederateProxy newHLAfederate(java.lang.String name)
                                throws ObjectClassNotDefined,
                                       ObjectClassNotPublished,
                                       IllegalName,
                                       ObjectInstanceNameInUse,
                                       FederateNotExecutionMember,
                                       SaveInProgress,
                                       RestoreInProgress,
                                       RTIinternalError

Registers a new HLAfederate with the specified name and returns a proxy object that may be used to examine and control its state.

Parameters:: name - the name of the new object
Returns:: the newly created proxy object
Throws:: ObjectClassNotDefined - if the specified object class is not defined; ObjectClassNotPublished - if the specified object class is not published; IllegalName - if the instance name has is illegal; ObjectInstanceNameInUse - if the instance name is already in use; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurred in the run-time infrastructure

newHLAfederation

public HLAfederationProxy newHLAfederation()
                                    throws ObjectClassNotDefined,
                                           ObjectClassNotPublished,
                                           FederateNotExecutionMember,
                                           SaveInProgress,
                                           RestoreInProgress,
                                           RTIinternalError

Registers a new HLAfederation and returns a proxy object that may be used to examine and control its state.

Returns:: the newly created proxy object
Throws:: ObjectClassNotDefined - if the specified object class is not defined; ObjectClassNotPublished - if the specified object class is not published; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurred in the run-time infrastructure

newHLAfederation

public HLAfederationProxy newHLAfederation(java.lang.String name)
                                    throws ObjectClassNotDefined,
                                           ObjectClassNotPublished,
                                           IllegalName,
                                           ObjectInstanceNameInUse,
                                           FederateNotExecutionMember,
                                           SaveInProgress,
                                           RestoreInProgress,
                                           RTIinternalError

Registers a new HLAfederation with the specified name and returns a proxy object that may be used to examine and control its state.

Parameters:: name - the name of the new object
Returns:: the newly created proxy object
Throws:: ObjectClassNotDefined - if the specified object class is not defined; ObjectClassNotPublished - if the specified object class is not published; IllegalName - if the instance name has is illegal; ObjectInstanceNameInUse - if the instance name is already in use; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurred in the run-time infrastructure

addInteractionListener

public void addInteractionListener(ManagementInteractionListener il)

Adds a listener for the interactions processed by this ambassador.

Parameters:: il - the listener object to add

removeInteractionListener

public void removeInteractionListener(ManagementInteractionListener il)

Removes a listener for the interactions processed by this ambassador.

Parameters:: il - the listener object to remove

receiveInteraction

public void receiveInteraction(InteractionClassHandle interactionClass,
                               ParameterHandleValueMap theParameters,
                               byte[] userSuppliedTag,
                               OrderType sentOrdering,
                               TransportationType theTransport)
                        throws InteractionClassNotRecognized,
                               InteractionParameterNotRecognized,
                               InteractionClassNotSubscribed,
                               FederateInternalError

Notifies the federate of a received interaction.

Specified by:: receiveInteraction in interface FederateAmbassador
Overrides:: receiveInteraction in class ProxyAmbassador

Parameters:: interactionClass - the class of the received interaction; theParameters - the map between parameter handles and the values of the identified parameters; userSuppliedTag - a user-supplied tag associated with the interaction; sentOrdering - the type of ordering with which the interaction was sent; theTransport - the type of transport associated with the interaction
Throws:: InteractionClassNotRecognized - if the interaction class was not recognized; InteractionParameterNotRecognized - if a parameter of the interaction was not recognized; InteractionClassNotSubscribed - if the federate had not subscribed to the interaction class; FederateInternalError - if an error occurs in the federate

discoverObjectInstance

public void discoverObjectInstance(ObjectInstanceHandle theObject,
                                   ObjectClassHandle theObjectClass,
                                   java.lang.String objectName)
                            throws CouldNotDiscover,
                                   ObjectClassNotRecognized,
                                   FederateInternalError

Notifies the federate of the presence of an object instance.

Specified by:: discoverObjectInstance in interface FederateAmbassador
Overrides:: discoverObjectInstance in class ProxyAmbassador

Parameters:: theObject - the instance handle of the newly discovered object; theObjectClass - the class handle of the newly discovered object; objectName - the name of the newly discovered object
Throws:: CouldNotDiscover - if the object could not be discovered; ObjectClassNotRecognized - if the object class was not recognized; FederateInternalError - if an error occurs in the federate

sendHLAsetTiming

public void sendHLAsetTiming(byte[] HLAfederate,
                             int HLAreportPeriod,
                             byte[] userSuppliedTag)
                      throws InteractionClassNotPublished,
                             InteractionClassNotDefined,
                             InteractionParameterNotDefined,
                             FederateNotExecutionMember,
                             SaveInProgress,
                             RestoreInProgress,
                             RTIinternalError

Adjust the time period between updates of the HLAmanager.HLAfederate object instance for the specified joined federate. If this interaction is never sent, the RTI shall not perform periodic updates.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAreportPeriod - Number of seconds between updates of instance attribute values of the HLAfederate object instance (A zero value causes periodic updates to cease).; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAmodifyAttributeState

public void sendHLAmodifyAttributeState(byte[] HLAfederate,
                                        byte[] HLAobjectInstance,
                                        byte[] HLAattribute,
                                        HLAownership HLAattributeState,
                                        byte[] userSuppliedTag)
                                 throws InteractionClassNotPublished,
                                        InteractionClassNotDefined,
                                        InteractionParameterNotDefined,
                                        FederateNotExecutionMember,
                                        SaveInProgress,
                                        RestoreInProgress,
                                        RTIinternalError

Modify the ownership state of an attribute of an object instance for the specified joined federate. If the interaction is used to give ownership of the instance attribute to the specified joined federate and another joined federate currently owns the instance attribute, the owning joined federate shall be divested of ownership of the instance attribute before ownership is granted to the specified joined federate. No notification of change of ownership of the instance attribute shall be provided to either joined federate. In order for ownership of the instance attribute to be granted to the specified joined federate, the following conditions shall be true: - the specified joined federate knows about the object instance - the specified joined federate is publishing the corresponding class attribute at the known class of the specified object instance at that joined federate - the specified instance attribute is not owned by the RTI (i.e., it's not a predefined attribute of a MOM object class) If one or more of the above conditions are not met, then the interaction shall have no effect and an error shall be reported via an interaction of class HLAmanager. HLAfederate.HLAreport. HLAreportMOMexception.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAobjectInstance - Handle of the object instance whose attribute state is being changed.; HLAattribute - Handle of the instance attribute whose stateis being changed.; HLAattributeState - New state for the attribute of the object instance.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAsetServiceReporting

public void sendHLAsetServiceReporting(byte[] HLAfederate,
                                       boolean HLAreportingState,
                                       byte[] userSuppliedTag)
                                throws InteractionClassNotPublished,
                                       InteractionClassNotDefined,
                                       InteractionParameterNotDefined,
                                       FederateNotExecutionMember,
                                       SaveInProgress,
                                       RestoreInProgress,
                                       RTIinternalError

Specify whether to report service invocations to0 or from the specified joined federate via HLAmanager.HLAfederate. HLAreport.HLAreportServiceInvocation interactions (enable or disable servicereporting). If the specified joined federate is subscribed to the HLAmanager.HLAfederate.HLAreport. HLAreportServiceInvocation interaction, all attempts to enable service reporting for that joined federate by sending an HLAmanager.HLAfederate.HLAadjust. HLAsetServiceReporting interaction with an HLAreportingState parameter value of HLAtrue shall fail and be reported via the normal MOM interaction failure means.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAreportingState - Whether the RTI should report service invocations (default = HLAfalse).; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAsetExceptionReporting

public void sendHLAsetExceptionReporting(byte[] HLAfederate,
                                         boolean HLAreportingState,
                                         byte[] userSuppliedTag)
                                  throws InteractionClassNotPublished,
                                         InteractionClassNotDefined,
                                         InteractionParameterNotDefined,
                                         FederateNotExecutionMember,
                                         SaveInProgress,
                                         RestoreInProgress,
                                         RTIinternalError

Specify whether the RTI shall report service invocation exceptions via HLAmanager.HLAfederate.HLAreport. HLAreportException interactions.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAreportingState - Whether the RTI should report exceptions (default = HLAfalse).; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLArequestPublications

public void sendHLArequestPublications(byte[] HLAfederate,
                                       byte[] userSuppliedTag)
                                throws InteractionClassNotPublished,
                                       InteractionClassNotDefined,
                                       InteractionParameterNotDefined,
                                       FederateNotExecutionMember,
                                       SaveInProgress,
                                       RestoreInProgress,
                                       RTIinternalError

Request that the RTI send report interactions that contain the publication data of a joined federate. It shall result in one interaction of class HLAmanager. HLAfederate.HLAreport. HLAreportInteractionPublication and one interaction of class HLAmanager.HLAfederate. HLAreport.HLAreportObjectClassPublication for each object class published.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLArequestSubscriptions

public void sendHLArequestSubscriptions(byte[] HLAfederate,
                                        byte[] userSuppliedTag)
                                 throws InteractionClassNotPublished,
                                        InteractionClassNotDefined,
                                        InteractionParameterNotDefined,
                                        FederateNotExecutionMember,
                                        SaveInProgress,
                                        RestoreInProgress,
                                        RTIinternalError

Request that the RTI send report interactions that contain the subscription data of a joined federate. It shall result in one interaction of class HLAmanager. HLAfederate.HLAreport. HLAreportInteractionSubscription and one interaction of class HLAmanager.HLAfederate. HLAreport.HLAreportObjectClassSubscription for each object class published.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLArequestObjectInstancesThatCanBeDeleted

public void sendHLArequestObjectInstancesThatCanBeDeleted(byte[] HLAfederate,
                                                          byte[] userSuppliedTag)
                                                   throws InteractionClassNotPublished,
                                                          InteractionClassNotDefined,
                                                          InteractionParameterNotDefined,
                                                          FederateNotExecutionMember,
                                                          SaveInProgress,
                                                          RestoreInProgress,
                                                          RTIinternalError

Request that the RTI send a report interaction that contains the object instances that can be deleted at the joined federate. It shall result in one interaction of class HLAmanager.HLAfederate.HLAreport. HLAreportObjectInstancesThatCanBeDeleted.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLArequestObjectInstancesUpdated

public void sendHLArequestObjectInstancesUpdated(byte[] HLAfederate,
                                                 byte[] userSuppliedTag)
                                          throws InteractionClassNotPublished,
                                                 InteractionClassNotDefined,
                                                 InteractionParameterNotDefined,
                                                 FederateNotExecutionMember,
                                                 SaveInProgress,
                                                 RestoreInProgress,
                                                 RTIinternalError

Request that the RTI send a report interaction that contains the object instance updating responsibility of a joined federate. It shall result in one interaction of class HLAmanager.HLAfederate.HLAreport. HLAreportObjectInstancesUpdated.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLArequestObjectInstancesReflected

public void sendHLArequestObjectInstancesReflected(byte[] HLAfederate,
                                                   byte[] userSuppliedTag)
                                            throws InteractionClassNotPublished,
                                                   InteractionClassNotDefined,
                                                   InteractionParameterNotDefined,
                                                   FederateNotExecutionMember,
                                                   SaveInProgress,
                                                   RestoreInProgress,
                                                   RTIinternalError

Request that the RTI send a report interaction that contains the objects instances for which a joined federate has had a Reflect Attribute Values service invocation. It shall result in one interaction ofclass HLAmanager.HLAfederate.HLAreport. HLAreportObjectInstancesReflected.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLArequestUpdatesSent

public void sendHLArequestUpdatesSent(byte[] HLAfederate,
                                      byte[] userSuppliedTag)
                               throws InteractionClassNotPublished,
                                      InteractionClassNotDefined,
                                      InteractionParameterNotDefined,
                                      FederateNotExecutionMember,
                                      SaveInProgress,
                                      RestoreInProgress,
                                      RTIinternalError

Request that the RTI send a report interaction that contains the number of updates that a joined federate has generated. It shall result in one interaction of class HLAmanager.HLAfederate.HLAreport. HLAreportUpdatesSent for each transportation type that is used to send updates.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLArequestInteractionsSent

public void sendHLArequestInteractionsSent(byte[] HLAfederate,
                                           byte[] userSuppliedTag)
                                    throws InteractionClassNotPublished,
                                           InteractionClassNotDefined,
                                           InteractionParameterNotDefined,
                                           FederateNotExecutionMember,
                                           SaveInProgress,
                                           RestoreInProgress,
                                           RTIinternalError

Request that the RTI send a report interaction that contains the number of interactions that a joined federate has generated. This count shall include interactions sent with region. It shall result in one interaction of class HLAmanager.HLAfederate.HLAreport. HLAreportInteractionsSent for each transportation type that is used to send interactions.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLArequestReflectionsReceived

public void sendHLArequestReflectionsReceived(byte[] HLAfederate,
                                              byte[] userSuppliedTag)
                                       throws InteractionClassNotPublished,
                                              InteractionClassNotDefined,
                                              InteractionParameterNotDefined,
                                              FederateNotExecutionMember,
                                              SaveInProgress,
                                              RestoreInProgress,
                                              RTIinternalError

Request that the RTI send a report interaction that contains the number of reflections that a joined federate has received. It shall result in one interaction of class HLAmanager.HLAfederate.HLAreport. HLAreportReflectionsReceived for each transportation type used in receiving reflections.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLArequestInteractionsReceived

public void sendHLArequestInteractionsReceived(byte[] HLAfederate,
                                               byte[] userSuppliedTag)
                                        throws InteractionClassNotPublished,
                                               InteractionClassNotDefined,
                                               InteractionParameterNotDefined,
                                               FederateNotExecutionMember,
                                               SaveInProgress,
                                               RestoreInProgress,
                                               RTIinternalError

Request that the RTI send a report interaction that contains the number of interactions that a joined federate has received. It shall result in one interaction of class HLAmanager.HLAfederate.HLAreport. HLAreportInteractionsReceived for each transportation typeused in receiving interactions.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLArequestObjectInstanceInformation

public void sendHLArequestObjectInstanceInformation(byte[] HLAfederate,
                                                    byte[] HLAobjectInstance,
                                                    byte[] userSuppliedTag)
                                             throws InteractionClassNotPublished,
                                                    InteractionClassNotDefined,
                                                    InteractionParameterNotDefined,
                                                    FederateNotExecutionMember,
                                                    SaveInProgress,
                                                    RestoreInProgress,
                                                    RTIinternalError

Request that the RTI send a report interaction that contains the information that a joined federate maintains on a single object instance. It shall result in one interaction of class HLAmanager.HLAfederate.HLAreport.HLAreportObjectInstanceInformation.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAobjectInstance - Handle of the object instance for which information is being requested.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLArequestSynchronizationPoints

public void sendHLArequestSynchronizationPoints(byte[] HLAfederate,
                                                byte[] userSuppliedTag)
                                         throws InteractionClassNotPublished,
                                                InteractionClassNotDefined,
                                                InteractionParameterNotDefined,
                                                FederateNotExecutionMember,
                                                SaveInProgress,
                                                RestoreInProgress,
                                                RTIinternalError

Request that the RTI send a report interaction that contains a list of all in-progress federation synchronization points. It shall result in one interaction class HLAmanager.HLAfederate.HLAreport. HLAreportSynchronizationPoints.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLArequestSynchronizationPointStatus

public void sendHLArequestSynchronizationPointStatus(byte[] HLAfederate,
                                                     byte[] userSuppliedTag)
                                              throws InteractionClassNotPublished,
                                                     InteractionClassNotDefined,
                                                     InteractionParameterNotDefined,
                                                     FederateNotExecutionMember,
                                                     SaveInProgress,
                                                     RestoreInProgress,
                                                     RTIinternalError

Request that the RTI send a report interaction that contains a list that includes each federate (and its synchronization point status) that is associated with a particular synchronization point. It shall result in one interaction of class HLAmanager.HLAfederate.HLAreport. HLAreportSynchronizationPointStatus.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAreportObjectClassPublication

public void sendHLAreportObjectClassPublication(byte[] HLAfederate,
                                                int HLAnumberOfClasses,
                                                byte[] HLAobjectClass,
                                                byte[][] HLAattributeList,
                                                byte[] userSuppliedTag)
                                         throws InteractionClassNotPublished,
                                                InteractionClassNotDefined,
                                                InteractionParameterNotDefined,
                                                FederateNotExecutionMember,
                                                SaveInProgress,
                                                RestoreInProgress,
                                                RTIinternalError

The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate. HLArequest.HLArequestPublications. It shall report the attributes of one object class published by the joined federate. One of these interactions shall be sent for each object class containing attributes that are published by the joined federate.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAnumberOfClasses - The number of object classes for which the joined federate publishes attributes.; HLAobjectClass - The object class whose publication is being reported.; HLAattributeList - List of handles of HLAobjectClass attributes that the joined federate is publishing.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAreportObjectClassSubscription

public void sendHLAreportObjectClassSubscription(byte[] HLAfederate,
                                                 int HLAnumberOfClasses,
                                                 byte[] HLAobjectClass,
                                                 boolean HLAactive,
                                                 byte[][] HLAattributeList,
                                                 byte[] userSuppliedTag)
                                          throws InteractionClassNotPublished,
                                                 InteractionClassNotDefined,
                                                 InteractionParameterNotDefined,
                                                 FederateNotExecutionMember,
                                                 SaveInProgress,
                                                 RestoreInProgress,
                                                 RTIinternalError

The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate. HLArequest.HLArequestSubscriptions. It shall report the attributes of one object class subscribed to by the joined federate. One of these interactions shall be sent for each object class that is subscribed to by the joined federate. This information shall reflect related DDM usage.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAnumberOfClasses - The number of object classes for which the joined federate subscribes to attributes. This information shall reflect related DDM usage.; HLAobjectClass - The object class whose subscription is being reported.; HLAactive - Whether the subscription is active.; HLAattributeList - List of handles of class attributes to which the joined federate is subscribing.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAreportInteractionPublication

public void sendHLAreportInteractionPublication(byte[] HLAfederate,
                                                byte[][] HLAinteractionClassList,
                                                byte[] userSuppliedTag)
                                         throws InteractionClassNotPublished,
                                                InteractionClassNotDefined,
                                                InteractionParameterNotDefined,
                                                FederateNotExecutionMember,
                                                SaveInProgress,
                                                RestoreInProgress,
                                                RTIinternalError

The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate. HLArequest.HLArequestPublications. It shall report the interaction classes published by the joined federate.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAinteractionClassList - List of interaction classes that the joined federate is publishing.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAreportInteractionSubscription

public void sendHLAreportInteractionSubscription(byte[] HLAfederate,
                                                 HLAinteractionSubscription[] HLAinteractionClassList,
                                                 byte[] userSuppliedTag)
                                          throws InteractionClassNotPublished,
                                                 InteractionClassNotDefined,
                                                 InteractionParameterNotDefined,
                                                 FederateNotExecutionMember,
                                                 SaveInProgress,
                                                 RestoreInProgress,
                                                 RTIinternalError

The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate. HLArequest.HLArequestSubscriptions. It shall report the interaction classes subscribed to by the joined federate. This information shall reflect related DDM usage.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAinteractionClassList - List of interaction class/subscription type pairs. Each pair consists of the handle of an interaction class that the joined federate is subscribed to and whether the joined federate is actively subscribing. This information shall reflect related DDM usage.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAreportObjectInstancesThatCanBeDeleted

public void sendHLAreportObjectInstancesThatCanBeDeleted(byte[] HLAfederate,
                                                         HLAobjectClassBasedCount[] HLAobjectInstanceCounts,
                                                         byte[] userSuppliedTag)
                                                  throws InteractionClassNotPublished,
                                                         InteractionClassNotDefined,
                                                         InteractionParameterNotDefined,
                                                         FederateNotExecutionMember,
                                                         SaveInProgress,
                                                         RestoreInProgress,
                                                         RTIinternalError

The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.HLArequest.HLArequestObject InstancesThatCanBeDeleted. It shall report the number of object instances (by registered class of the object instances) whose HLAprivilegeToDeleteObject attribute areowned by the joined federate.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAobjectInstanceCounts - A list of object instance counts. Each object instance count consists of an object class handle and the number of object instances of that class.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAreportObjectInstancesUpdated

public void sendHLAreportObjectInstancesUpdated(byte[] HLAfederate,
                                                HLAobjectClassBasedCount[] HLAobjectInstanceCounts,
                                                byte[] userSuppliedTag)
                                         throws InteractionClassNotPublished,
                                                InteractionClassNotDefined,
                                                InteractionParameterNotDefined,
                                                FederateNotExecutionMember,
                                                SaveInProgress,
                                                RestoreInProgress,
                                                RTIinternalError

The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate. HLArequest.HLArequestObjectInstancessUpdated. It shall report the number of object instances (by registered class of the object instances) for which the joined federate has invoked the Update Attribute Values service.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAobjectInstanceCounts - List of object instance counts. Each object instance count consists of an object class handle and the number of object instances of that class.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAreportObjectInstancesReflected

public void sendHLAreportObjectInstancesReflected(byte[] HLAfederate,
                                                  HLAobjectClassBasedCount[] HLAobjectInstanceCounts,
                                                  byte[] userSuppliedTag)
                                           throws InteractionClassNotPublished,
                                                  InteractionClassNotDefined,
                                                  InteractionParameterNotDefined,
                                                  FederateNotExecutionMember,
                                                  SaveInProgress,
                                                  RestoreInProgress,
                                                  RTIinternalError

The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate. HLArequest.HLArequestObjectInstancessReflected. It shall report the number of object instances (by registered class of the object instances) for which the joined federate has had a Reflect Attribute Values service invocation.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAobjectInstanceCounts - List of object instance counts. Each object instance count consists of an object class handle and the number of object instances of that class.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAreportUpdatesSent

public void sendHLAreportUpdatesSent(byte[] HLAfederate,
                                     char[] HLAtransportation,
                                     HLAobjectClassBasedCount[] HLAupdateCounts,
                                     byte[] userSuppliedTag)
                              throws InteractionClassNotPublished,
                                     InteractionClassNotDefined,
                                     InteractionParameterNotDefined,
                                     FederateNotExecutionMember,
                                     SaveInProgress,
                                     RestoreInProgress,
                                     RTIinternalError

The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate. HLArequest.HLArequestUpdatesSent. It shall report the number of updates sent (by registered class of the object instances of the updates) by the joined federate since the beginning of the federation execution. One interaction of this class shall be sent by the RTI for each transportation type used.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAtransportation - Transportation type used in sending updates.; HLAupdateCounts - List of update counts. Each update count consists of an object class handle and the number of updates sent of that class.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAreportReflectionsReceived

public void sendHLAreportReflectionsReceived(byte[] HLAfederate,
                                             char[] HLAtransportation,
                                             HLAobjectClassBasedCount[] HLAreflectCounts,
                                             byte[] userSuppliedTag)
                                      throws InteractionClassNotPublished,
                                             InteractionClassNotDefined,
                                             InteractionParameterNotDefined,
                                             FederateNotExecutionMember,
                                             SaveInProgress,
                                             RestoreInProgress,
                                             RTIinternalError

The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate. HLArequest.HLArequestReflectionsReceived. It shall report the number of reflections received (by registered class of the object instances of the reflects) by the joined federate since the beginning of the federation execution. One interaction of this class shall be sent by the RTI for each transportation type used.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAtransportation - Transportation type used in receiving reflections.; HLAreflectCounts - List of reflection counts. Each reflection count consists of an object class handle and the number of reflections received of that class.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAreportInteractionsSent

public void sendHLAreportInteractionsSent(byte[] HLAfederate,
                                          char[] HLAtransportation,
                                          HLAinteractionCount[] HLAinteractionCounts,
                                          byte[] userSuppliedTag)
                                   throws InteractionClassNotPublished,
                                          InteractionClassNotDefined,
                                          InteractionParameterNotDefined,
                                          FederateNotExecutionMember,
                                          SaveInProgress,
                                          RestoreInProgress,
                                          RTIinternalError

The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate. HLArequest.HLArequestInteractionsSent. It shall report the number of interactions sent (by sent class of the interactions) by the joined federate since the beginning of the federation execution. This count shall include interactions sent with region. One interaction of this class shall be sent by the RTI for each transportation type used.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAtransportation - Transportation type used in sending interactions.; HLAinteractionCounts - List of interaction counts. Each interaction count consists of an interaction class handle and the number of interactions of that class. This information shall reflect related DDM usage.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAreportInteractionsReceived

public void sendHLAreportInteractionsReceived(byte[] HLAfederate,
                                              char[] HLAtransportation,
                                              HLAinteractionCount[] HLAinteractionCounts,
                                              byte[] userSuppliedTag)
                                       throws InteractionClassNotPublished,
                                              InteractionClassNotDefined,
                                              InteractionParameterNotDefined,
                                              FederateNotExecutionMember,
                                              SaveInProgress,
                                              RestoreInProgress,
                                              RTIinternalError

The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate. HLArequest. HLArequestInteractionsReceived. It shall report the number of interactions received (by sent class of the interactions) by the joined federate since the beginning of the federation execution. One interaction of this class shall be sent by the RTI for each transportation type used.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAtransportation - Transportation type used in receiving interactions.; HLAinteractionCounts - List of interaction counts. Each interaction count consists of an interaction class handle and the number of interactions of that class.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAreportObjectInstanceInformation

public void sendHLAreportObjectInstanceInformation(byte[] HLAfederate,
                                                   byte[] HLAobjectInstance,
                                                   byte[][] HLAownedInstanceAttributeList,
                                                   byte[] HLAregisteredClass,
                                                   byte[] HLAknownClass,
                                                   byte[] userSuppliedTag)
                                            throws InteractionClassNotPublished,
                                                   InteractionClassNotDefined,
                                                   InteractionParameterNotDefined,
                                                   FederateNotExecutionMember,
                                                   SaveInProgress,
                                                   RestoreInProgress,
                                                   RTIinternalError

The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate. HLArequest.HLArequestObjectInstance Information. It shall report on a single object instance and portray the attributes of that object instance that are owned by the joined federate, the registered class of the object instance, and the known class of the object instance at the joined federate.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAobjectInstance - Handle of the object instance for which the interaction was sent.; HLAownedInstanceAttributeList - List of the handles of all instance attributes, of the object instance, owned by the joined federate.; HLAregisteredClass - Handle of the registered class of the object instance.; HLAknownClass - Handle of the known class of the object instance at the joined federate.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAreportException

public void sendHLAreportException(byte[] HLAfederate,
                                   java.lang.String HLAservice,
                                   java.lang.String HLAexception,
                                   byte[] userSuppliedTag)
                            throws InteractionClassNotPublished,
                                   InteractionClassNotDefined,
                                   InteractionParameterNotDefined,
                                   FederateNotExecutionMember,
                                   SaveInProgress,
                                   RestoreInProgress,
                                   RTIinternalError

The interaction shall be sent by the RTI when an exception occurs as the result of a service invocation at the indicated joined federate. This interaction shall be sent only if the last HLAmanager.HLAfederate.HLAadjust. HLAsetExceptionReporting interaction changing the HLAreportingState parameter sets the parameter to HLAtrue, for the indicated joined federate.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAservice - Name of the service that raised the exception.; HLAexception - Textual depiction of the exception.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAreportServiceInvocation

public void sendHLAreportServiceInvocation(byte[] HLAfederate,
                                           java.lang.String HLAservice,
                                           boolean HLAsuccessIndicator,
                                           java.lang.String[] HLAsuppliedArguments,
                                           java.lang.String[] HLAreturnedArguments,
                                           java.lang.String HLAexception,
                                           int HLAserialNumber,
                                           byte[] userSuppliedTag)
                                    throws InteractionClassNotPublished,
                                           InteractionClassNotDefined,
                                           InteractionParameterNotDefined,
                                           FederateNotExecutionMember,
                                           SaveInProgress,
                                           RestoreInProgress,
                                           RTIinternalError

This interaction shall be sent by the RTI whenever an HLA service is invoked, either by the indicated joined federate or by the RTI at the indicated joined federate, and Service Reporting is Enabled for the indicated joined federate. This interaction shall always contain the arguments supplied by the service invoker. If the service invocation was successful, the interaction also shall contain the value returned to the invoker (if the service returns a value); otherwise, the interaction also shall contain an indication of the exception that shall be raised to the invoker.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAservice - Textual name of the service.; HLAsuccessIndicator - Whether the service invocation was successful. Exception values are returned along with HLAfalse value.; HLAsuppliedArguments - Textual depiction of the arguments supplied in the service invocation.; HLAreturnedArguments - Textual depiction of the argument returned by the service invocation (null if the service does not normally return a value or if HLAsuccessIndicator is HLAfalse).; HLAexception - Textual depiction of the exception raised by this service invocation (null if HLAsuccessIndicator is HLAtrue).; HLAserialNumber - This is a per-joined federate serial number that shall start at zero and shall increment by 1 for each HLAmanager.HLAfederate.HLAreport HLAreportServiceInvocation interaction that represents service invocations to or from the respective joined federate.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAreportMOMexception

public void sendHLAreportMOMexception(byte[] HLAfederate,
                                      java.lang.String HLAservice,
                                      java.lang.String HLAexception,
                                      boolean HLAparameterError,
                                      byte[] userSuppliedTag)
                               throws InteractionClassNotPublished,
                                      InteractionClassNotDefined,
                                      InteractionParameterNotDefined,
                                      FederateNotExecutionMember,
                                      SaveInProgress,
                                      RestoreInProgress,
                                      RTIinternalError

The interaction shall be sent by the RTI when one the following occurs: - a MOM interaction without all the necessary parameters is sent or - an interaction that imitates a federate's invocation of an RTI service is sent and not all of the service's pre-conditions are met.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAservice - Name of the service interaction that had a problem or raised the exception.; HLAexception - Textual depiction of the problem or exception.; HLAparameterError - HLAtrue if there was an incorrect number of interaction parameters, HLAfalse otherwise.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAreportSynchronizationPoints

public void sendHLAreportSynchronizationPoints(byte[] HLAfederate,
                                               java.lang.String[] HLAsynchPoints,
                                               byte[] userSuppliedTag)
                                        throws InteractionClassNotPublished,
                                               InteractionClassNotDefined,
                                               InteractionParameterNotDefined,
                                               FederateNotExecutionMember,
                                               SaveInProgress,
                                               RestoreInProgress,
                                               RTIinternalError

The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate. HLArequest.HLArequestSynchronizationPoints. It shall report the list of active synchronization points in the federation execution.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAsynchPoints - List of the in progress federation execution synchronization points.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAreportSynchronizationPointStatus

public void sendHLAreportSynchronizationPointStatus(byte[] HLAfederate,
                                                    java.lang.String HLAsynchPointName,
                                                    HLAsynchPointFederate[] HLAsynchPointFederates,
                                                    byte[] userSuppliedTag)
                                             throws InteractionClassNotPublished,
                                                    InteractionClassNotDefined,
                                                    InteractionParameterNotDefined,
                                                    FederateNotExecutionMember,
                                                    SaveInProgress,
                                                    RestoreInProgress,
                                                    RTIinternalError

The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate. HLArequest.HLArequestSynchronizationPointStatus. It shall report the status of a particular synchronization point. This shall be a list that includes each federate (and its synchronization status) that is associated with a particular synchronization point.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAsynchPointName - Name of a particular synchronization point.; HLAsynchPointFederates - List of each federate (and its synchronization status) associated with the particular synchronization point.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAresignFederationExecution

public void sendHLAresignFederationExecution(byte[] HLAfederate,
                                             HLAresignAction HLAresignAction,
                                             byte[] userSuppliedTag)
                                      throws InteractionClassNotPublished,
                                             InteractionClassNotDefined,
                                             InteractionParameterNotDefined,
                                             FederateNotExecutionMember,
                                             SaveInProgress,
                                             RestoreInProgress,
                                             RTIinternalError

Cause the joined federate to resign from the federation execution. A joined federate shall be able to send this interaction anytime.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAresignAction - Action that the RTI is to take in conjunction with the resignation.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAsynchronizationPointAchieved

public void sendHLAsynchronizationPointAchieved(byte[] HLAfederate,
                                                java.lang.String HLAlabel,
                                                byte[] userSuppliedTag)
                                         throws InteractionClassNotPublished,
                                                InteractionClassNotDefined,
                                                InteractionParameterNotDefined,
                                                FederateNotExecutionMember,
                                                SaveInProgress,
                                                RestoreInProgress,
                                                RTIinternalError

Mimic the federate's report of achieving a synchronization point.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAlabel - Label associated with the synchronization point.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAfederateSaveBegun

public void sendHLAfederateSaveBegun(byte[] HLAfederate,
                                     byte[] userSuppliedTag)
                              throws InteractionClassNotPublished,
                                     InteractionClassNotDefined,
                                     InteractionParameterNotDefined,
                                     FederateNotExecutionMember,
                                     SaveInProgress,
                                     RestoreInProgress,
                                     RTIinternalError

Mimic the federate's report of starting a save.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAfederateSaveComplete

public void sendHLAfederateSaveComplete(byte[] HLAfederate,
                                        boolean HLAsuccessIndicator,
                                        byte[] userSuppliedTag)
                                 throws InteractionClassNotPublished,
                                        InteractionClassNotDefined,
                                        InteractionParameterNotDefined,
                                        FederateNotExecutionMember,
                                        SaveInProgress,
                                        RestoreInProgress,
                                        RTIinternalError

Mimic the joined federate's report of completion of a save. A joined federate shall be able to send this interaction during a federation save.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAsuccessIndicator - Whether the save was successful.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAfederateRestoreComplete

public void sendHLAfederateRestoreComplete(byte[] HLAfederate,
                                           boolean HLAsuccessIndicator,
                                           byte[] userSuppliedTag)
                                    throws InteractionClassNotPublished,
                                           InteractionClassNotDefined,
                                           InteractionParameterNotDefined,
                                           FederateNotExecutionMember,
                                           SaveInProgress,
                                           RestoreInProgress,
                                           RTIinternalError

Mimic the joined federate's report of completion of a restore. A joined federate shall be able to send this interaction during a federation restore.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAsuccessIndicator - Whether the restore was successful.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLApublishObjectClassAttributes

public void sendHLApublishObjectClassAttributes(byte[] HLAfederate,
                                                byte[] HLAobjectClass,
                                                byte[][] HLAattributeList,
                                                byte[] userSuppliedTag)
                                         throws InteractionClassNotPublished,
                                                InteractionClassNotDefined,
                                                InteractionParameterNotDefined,
                                                FederateNotExecutionMember,
                                                SaveInProgress,
                                                RestoreInProgress,
                                                RTIinternalError

Set the joined federate's publication status of attributes belonging to an object class.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAobjectClass - Object class for which the joined federate's publication shall change.; HLAattributeList - List of handles of attributes of HLAobjectClass, which the federate shall now publish.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAunpublishObjectClassAttributes

public void sendHLAunpublishObjectClassAttributes(byte[] HLAfederate,
                                                  byte[] HLAobjectClass,
                                                  byte[][] HLAattributeList,
                                                  byte[] userSuppliedTag)
                                           throws InteractionClassNotPublished,
                                                  InteractionClassNotDefined,
                                                  InteractionParameterNotDefined,
                                                  FederateNotExecutionMember,
                                                  SaveInProgress,
                                                  RestoreInProgress,
                                                  RTIinternalError

Cause the joined federate no longer to publish attributes of an object class.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAobjectClass - Object class for which the joined federate's unpublication shall change.; HLAattributeList - List of handles of attributes of HLAobjectClass, which the joined federate shall now unpublish.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLApublishInteractionClass

public void sendHLApublishInteractionClass(byte[] HLAfederate,
                                           byte[] HLAinteractionClass,
                                           byte[] userSuppliedTag)
                                    throws InteractionClassNotPublished,
                                           InteractionClassNotDefined,
                                           InteractionParameterNotDefined,
                                           FederateNotExecutionMember,
                                           SaveInProgress,
                                           RestoreInProgress,
                                           RTIinternalError

Set the joined federate's publication status of an interaction class.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAinteractionClass - Interaction class that the joined federate shall publish.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAunpublishInteractionClass

public void sendHLAunpublishInteractionClass(byte[] HLAfederate,
                                             byte[] HLAinteractionClass,
                                             byte[] userSuppliedTag)
                                      throws InteractionClassNotPublished,
                                             InteractionClassNotDefined,
                                             InteractionParameterNotDefined,
                                             FederateNotExecutionMember,
                                             SaveInProgress,
                                             RestoreInProgress,
                                             RTIinternalError

Cause the joined federate no longer to publish an interaction class.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAinteractionClass - Interaction class that the joined federate shall no longer publish.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAsubscribeObjectClassAttributes

public void sendHLAsubscribeObjectClassAttributes(byte[] HLAfederate,
                                                  byte[] HLAobjectClass,
                                                  byte[][] HLAattributeList,
                                                  boolean HLAactive,
                                                  byte[] userSuppliedTag)
                                           throws InteractionClassNotPublished,
                                                  InteractionClassNotDefined,
                                                  InteractionParameterNotDefined,
                                                  FederateNotExecutionMember,
                                                  SaveInProgress,
                                                  RestoreInProgress,
                                                  RTIinternalError

Set the joined federate's subscription status of attributes belonging to an object class.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAobjectClass - Object class for which the joined federate's subscription shall change.; HLAattributeList - List of handles of attributes of HLAobjectClass to which the joined federate shall now subscribe.; HLAactive - Whether the subscription is active.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAunsubscribeObjectClassAttributes

public void sendHLAunsubscribeObjectClassAttributes(byte[] HLAfederate,
                                                    byte[] HLAobjectClass,
                                                    byte[][] HLAattributeList,
                                                    byte[] userSuppliedTag)
                                             throws InteractionClassNotPublished,
                                                    InteractionClassNotDefined,
                                                    InteractionParameterNotDefined,
                                                    FederateNotExecutionMember,
                                                    SaveInProgress,
                                                    RestoreInProgress,
                                                    RTIinternalError

Cause the joined federate no longer to subscribe to attributes of an object class.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAobjectClass - Object class for which the joined federate's subscription shall change.; HLAattributeList - List of handles of attributes of HLAobjectClass to which the joined federate shall now unsubscribe.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAsubscribeInteractionClass

public void sendHLAsubscribeInteractionClass(byte[] HLAfederate,
                                             byte[] HLAinteractionClass,
                                             boolean HLAactive,
                                             byte[] userSuppliedTag)
                                      throws InteractionClassNotPublished,
                                             InteractionClassNotDefined,
                                             InteractionParameterNotDefined,
                                             FederateNotExecutionMember,
                                             SaveInProgress,
                                             RestoreInProgress,
                                             RTIinternalError

Set the joined federate's subscription status to an interaction class.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAinteractionClass - Interaction class to which the federate shall subscribe.; HLAactive - Whether the subscription is active.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAunsubscribeInteractionClass

public void sendHLAunsubscribeInteractionClass(byte[] HLAfederate,
                                               byte[] HLAinteractionClass,
                                               byte[] userSuppliedTag)
                                        throws InteractionClassNotPublished,
                                               InteractionClassNotDefined,
                                               InteractionParameterNotDefined,
                                               FederateNotExecutionMember,
                                               SaveInProgress,
                                               RestoreInProgress,
                                               RTIinternalError

Cause the joined federate no longer to subscribe to an interaction class.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAinteractionClass - Interaction class to which the joined federate will no longer be subscribed.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAdeleteObjectInstance

public void sendHLAdeleteObjectInstance(byte[] HLAfederate,
                                        byte[] HLAobjectInstance,
                                        byte[] HLAtag,
                                        byte[] HLAtimeStamp,
                                        byte[] userSuppliedTag)
                                 throws InteractionClassNotPublished,
                                        InteractionClassNotDefined,
                                        InteractionParameterNotDefined,
                                        FederateNotExecutionMember,
                                        SaveInProgress,
                                        RestoreInProgress,
                                        RTIinternalError

Cause an object instance to be deleted from the federation.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAobjectInstance - Handle of the object instance that is to be deleted.; HLAtag - Tag associated with the deletion.; HLAtimeStamp - Time stamp of the deletion (optional).; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAlocalDeleteObjectInstance

public void sendHLAlocalDeleteObjectInstance(byte[] HLAfederate,
                                             byte[] HLAobjectInstance,
                                             byte[] userSuppliedTag)
                                      throws InteractionClassNotPublished,
                                             InteractionClassNotDefined,
                                             InteractionParameterNotDefined,
                                             FederateNotExecutionMember,
                                             SaveInProgress,
                                             RestoreInProgress,
                                             RTIinternalError

Inform the RTI that it shall treat the specified object instance as if thejoined federate did not know about the object instance.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAobjectInstance - Handle of the object instance that is to be deleted.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAchangeAttributeTransportationType

public void sendHLAchangeAttributeTransportationType(byte[] HLAfederate,
                                                     byte[] HLAobjectInstance,
                                                     byte[][] HLAattributeList,
                                                     char[] HLAtransportation,
                                                     byte[] userSuppliedTag)
                                              throws InteractionClassNotPublished,
                                                     InteractionClassNotDefined,
                                                     InteractionParameterNotDefined,
                                                     FederateNotExecutionMember,
                                                     SaveInProgress,
                                                     RestoreInProgress,
                                                     RTIinternalError

Change the transportation type used by the joined federate when sending attributes belonging to the object instance.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAobjectInstance - Handle of the object instance whose attribute transportation type is to be changed.; HLAattributeList - List of the handles of instance attributes whose transportation type is to be changed.; HLAtransportation - Transportation type to be used for updating instance attributes in the list.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAchangeInteractionTransportationType

public void sendHLAchangeInteractionTransportationType(byte[] HLAfederate,
                                                       byte[] HLAinteractionClass,
                                                       char[] HLAtransportation,
                                                       byte[] userSuppliedTag)
                                                throws InteractionClassNotPublished,
                                                       InteractionClassNotDefined,
                                                       InteractionParameterNotDefined,
                                                       FederateNotExecutionMember,
                                                       SaveInProgress,
                                                       RestoreInProgress,
                                                       RTIinternalError

Change the transportation type used by the joined federate when sending a class of interaction.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAinteractionClass - Interaction class whose transportation type is changed by this service invocation.; HLAtransportation - Transportation type to be used for sending the interaction class.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAunconditionalAttributeOwnershipDivestiture

public void sendHLAunconditionalAttributeOwnershipDivestiture(byte[] HLAfederate,
                                                              byte[] HLAobjectInstance,
                                                              byte[][] HLAattributeList,
                                                              byte[] userSuppliedTag)
                                                       throws InteractionClassNotPublished,
                                                              InteractionClassNotDefined,
                                                              InteractionParameterNotDefined,
                                                              FederateNotExecutionMember,
                                                              SaveInProgress,
                                                              RestoreInProgress,
                                                              RTIinternalError

Cause the ownership of attributes of an object instance to be unconditionally divested by the joined federate.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAobjectInstance - Handle of the object instance whose attributes' ownership is to be divested.; HLAattributeList - List of handles of instance attributes belonging to HLAobjectInstance whose ownership is to be divested by the joined federate.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAenableTimeRegulation

public void sendHLAenableTimeRegulation(byte[] HLAfederate,
                                        byte[] HLAlookahead,
                                        byte[] userSuppliedTag)
                                 throws InteractionClassNotPublished,
                                        InteractionClassNotDefined,
                                        InteractionParameterNotDefined,
                                        FederateNotExecutionMember,
                                        SaveInProgress,
                                        RestoreInProgress,
                                        RTIinternalError

Cause the joined federate to begin regulating the logical time of other joined federates.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAlookahead - Lookahead to be used by the joined federate while regulating other joined federates.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAdisableTimeRegulation

public void sendHLAdisableTimeRegulation(byte[] HLAfederate,
                                         byte[] userSuppliedTag)
                                  throws InteractionClassNotPublished,
                                         InteractionClassNotDefined,
                                         InteractionParameterNotDefined,
                                         FederateNotExecutionMember,
                                         SaveInProgress,
                                         RestoreInProgress,
                                         RTIinternalError

Cause the joined federate to cease regulating the logical time of other joined federates.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAenableTimeConstrained

public void sendHLAenableTimeConstrained(byte[] HLAfederate,
                                         byte[] userSuppliedTag)
                                  throws InteractionClassNotPublished,
                                         InteractionClassNotDefined,
                                         InteractionParameterNotDefined,
                                         FederateNotExecutionMember,
                                         SaveInProgress,
                                         RestoreInProgress,
                                         RTIinternalError

Cause the logical time of the joined federate to begin being constrained by the logical times of other joined federates.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAdisableTimeConstrained

public void sendHLAdisableTimeConstrained(byte[] HLAfederate,
                                          byte[] userSuppliedTag)
                                   throws InteractionClassNotPublished,
                                          InteractionClassNotDefined,
                                          InteractionParameterNotDefined,
                                          FederateNotExecutionMember,
                                          SaveInProgress,
                                          RestoreInProgress,
                                          RTIinternalError

Cause the logical time of the joined federate to cease being constrained by the logical times of other joined federates.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAtimeAdvanceRequest

public void sendHLAtimeAdvanceRequest(byte[] HLAfederate,
                                      byte[] HLAtimeStamp,
                                      byte[] userSuppliedTag)
                               throws InteractionClassNotPublished,
                                      InteractionClassNotDefined,
                                      InteractionParameterNotDefined,
                                      FederateNotExecutionMember,
                                      SaveInProgress,
                                      RestoreInProgress,
                                      RTIinternalError

Request an advance of the joined federate's logical time on behalf of the joined federate, and release zero or more messages for delivery to the joined federate.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAtimeStamp - Time stamp requested.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAtimeAdvanceRequestAvailable

public void sendHLAtimeAdvanceRequestAvailable(byte[] HLAfederate,
                                               byte[] HLAtimeStamp,
                                               byte[] userSuppliedTag)
                                        throws InteractionClassNotPublished,
                                               InteractionClassNotDefined,
                                               InteractionParameterNotDefined,
                                               FederateNotExecutionMember,
                                               SaveInProgress,
                                               RestoreInProgress,
                                               RTIinternalError

Request an advance of the joined federate's logical time, on behalf of the joined federate, and release zero or more messages for delivery to the joined federate.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAtimeStamp - Time stamp requested.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAnextMessageRequest

public void sendHLAnextMessageRequest(byte[] HLAfederate,
                                      byte[] HLAtimeStamp,
                                      byte[] userSuppliedTag)
                               throws InteractionClassNotPublished,
                                      InteractionClassNotDefined,
                                      InteractionParameterNotDefined,
                                      FederateNotExecutionMember,
                                      SaveInProgress,
                                      RestoreInProgress,
                                      RTIinternalError

Request the logical time of the joined federate to be advanced to the time stamp of the next TSO message that shall be delivered to the joined federate, provided that the message shall have a time stamp no greater than the logical time specified in the request, and release zero or more messages for delivery to the joined federate.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAtimeStamp - Time stamp requested.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAnextMessageRequestAvailable

public void sendHLAnextMessageRequestAvailable(byte[] HLAfederate,
                                               byte[] HLAtimeStamp,
                                               byte[] userSuppliedTag)
                                        throws InteractionClassNotPublished,
                                               InteractionClassNotDefined,
                                               InteractionParameterNotDefined,
                                               FederateNotExecutionMember,
                                               SaveInProgress,
                                               RestoreInProgress,
                                               RTIinternalError

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAtimeStamp - Time stamp requested.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAflushQueueRequest

public void sendHLAflushQueueRequest(byte[] HLAfederate,
                                     byte[] HLAtimeStamp,
                                     byte[] userSuppliedTag)
                              throws InteractionClassNotPublished,
                                     InteractionClassNotDefined,
                                     InteractionParameterNotDefined,
                                     FederateNotExecutionMember,
                                     SaveInProgress,
                                     RestoreInProgress,
                                     RTIinternalError

Request the logical time of the joined federate to be advanced as far as possible, provided that the time stamp is less than or equal to the logical time specified in the request. All TSO and RO messages shall be delivered to the joined federate.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAtimeStamp - Time stamp requested.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAenableAsynchronousDelivery

public void sendHLAenableAsynchronousDelivery(byte[] HLAfederate,
                                              byte[] userSuppliedTag)
                                       throws InteractionClassNotPublished,
                                              InteractionClassNotDefined,
                                              InteractionParameterNotDefined,
                                              FederateNotExecutionMember,
                                              SaveInProgress,
                                              RestoreInProgress,
                                              RTIinternalError

Cause the RTI to deliver receive-order messages to the joined federate at any time, even if the joined federate is time-constrained.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAdisableAsynchronousDelivery

public void sendHLAdisableAsynchronousDelivery(byte[] HLAfederate,
                                               byte[] userSuppliedTag)
                                        throws InteractionClassNotPublished,
                                               InteractionClassNotDefined,
                                               InteractionParameterNotDefined,
                                               FederateNotExecutionMember,
                                               SaveInProgress,
                                               RestoreInProgress,
                                               RTIinternalError

When the joined federate is time-constrained, cause the RTI to deliver receive-order messages to the joined federate only when its time manager state is Time Advancing.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAmodifyLookahead

public void sendHLAmodifyLookahead(byte[] HLAfederate,
                                   byte[] HLAlookahead,
                                   byte[] userSuppliedTag)
                            throws InteractionClassNotPublished,
                                   InteractionClassNotDefined,
                                   InteractionParameterNotDefined,
                                   FederateNotExecutionMember,
                                   SaveInProgress,
                                   RestoreInProgress,
                                   RTIinternalError

Change the lookahead value used by the joined federate.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAlookahead - New value for lookahead.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAchangeAttributeOrderType

public void sendHLAchangeAttributeOrderType(byte[] HLAfederate,
                                            byte[] HLAobjectInstance,
                                            byte[][] HLAattributeList,
                                            HLAorderType HLAsendOrder,
                                            byte[] userSuppliedTag)
                                     throws InteractionClassNotPublished,
                                            InteractionClassNotDefined,
                                            InteractionParameterNotDefined,
                                            FederateNotExecutionMember,
                                            SaveInProgress,
                                            RestoreInProgress,
                                            RTIinternalError

Change the ordering type used by the joined federate when sending attributes belonging to the object instance.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAobjectInstance - Handle of the object instance whose attribute order type is to be changed.; HLAattributeList - List of the handles of instance attributes whose order type is to be changed.; HLAsendOrder - Order type to be used for sending the instance attribute list.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAchangeInteractionOrderType

public void sendHLAchangeInteractionOrderType(byte[] HLAfederate,
                                              byte[] HLAinteractionClass,
                                              HLAorderType HLAsendOrder,
                                              byte[] userSuppliedTag)
                                       throws InteractionClassNotPublished,
                                              InteractionClassNotDefined,
                                              InteractionParameterNotDefined,
                                              FederateNotExecutionMember,
                                              SaveInProgress,
                                              RestoreInProgress,
                                              RTIinternalError

Change the order type used by the joined federate when sending a class of interaction.

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAinteractionClass - Interaction class whose order type is changed by this service invocation.; HLAsendOrder - Order type to be used for sending the interaction class.; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAsetSwitches

public void sendHLAsetSwitches(HLAswitch HLAautoProvide,
                               HLAswitch HLAconveyRegionDesignatorSets,
                               byte[] userSuppliedTag)
                        throws InteractionClassNotPublished,
                               InteractionClassNotDefined,
                               InteractionParameterNotDefined,
                               FederateNotExecutionMember,
                               SaveInProgress,
                               RestoreInProgress,
                               RTIinternalError

Set the values of several HLA switches.

Parameters:: HLAautoProvide - Set the federation-wide Auto Provide Switch to the provided value (this parameter is required only when a change of this switch value is needed).; HLAconveyRegionDesignatorSets - Set the federation-wide Convey Region Designator Sets Switch to the provided value (this parameter is required only when a change of this switch value is needed).; userSuppliedTag - a user-supplied tag to accompany the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is not defined; InteractionParameterNotDefined - if one of the parameters is not defined; FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurs in the run-time infrastructure

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.npsnet.xrti.proxies Class ManagementProxyAmbassador

ManagementProxyAmbassador

publishAndSubscribeObjectClassAttributes

newHLAobjectRoot

newHLAobjectRoot

newHLAmanager

newHLAmanager

newHLAfederate

newHLAfederate

newHLAfederation

newHLAfederation

addInteractionListener

removeInteractionListener

receiveInteraction

discoverObjectInstance

sendHLAsetTiming

sendHLAmodifyAttributeState

sendHLAsetServiceReporting

sendHLAsetExceptionReporting

sendHLArequestPublications

sendHLArequestSubscriptions

sendHLArequestObjectInstancesThatCanBeDeleted

sendHLArequestObjectInstancesUpdated

sendHLArequestObjectInstancesReflected

sendHLArequestUpdatesSent

sendHLArequestInteractionsSent

sendHLArequestReflectionsReceived

sendHLArequestInteractionsReceived

sendHLArequestObjectInstanceInformation

sendHLArequestSynchronizationPoints

sendHLArequestSynchronizationPointStatus

sendHLAreportObjectClassPublication

sendHLAreportObjectClassSubscription

sendHLAreportInteractionPublication

sendHLAreportInteractionSubscription

sendHLAreportObjectInstancesThatCanBeDeleted

sendHLAreportObjectInstancesUpdated

sendHLAreportObjectInstancesReflected

sendHLAreportUpdatesSent

sendHLAreportReflectionsReceived

sendHLAreportInteractionsSent

sendHLAreportInteractionsReceived

sendHLAreportObjectInstanceInformation

sendHLAreportException

sendHLAreportServiceInvocation

sendHLAreportMOMexception

sendHLAreportSynchronizationPoints

sendHLAreportSynchronizationPointStatus

sendHLAresignFederationExecution

sendHLAsynchronizationPointAchieved

sendHLAfederateSaveBegun

sendHLAfederateSaveComplete

sendHLAfederateRestoreComplete

sendHLApublishObjectClassAttributes

sendHLAunpublishObjectClassAttributes

sendHLApublishInteractionClass

sendHLAunpublishInteractionClass

sendHLAsubscribeObjectClassAttributes

sendHLAunsubscribeObjectClassAttributes

sendHLAsubscribeInteractionClass

sendHLAunsubscribeInteractionClass

sendHLAdeleteObjectInstance

sendHLAlocalDeleteObjectInstance

sendHLAchangeAttributeTransportationType

sendHLAchangeInteractionTransportationType

sendHLAunconditionalAttributeOwnershipDivestiture

sendHLAenableTimeRegulation

sendHLAdisableTimeRegulation

sendHLAenableTimeConstrained

sendHLAdisableTimeConstrained

sendHLAtimeAdvanceRequest

sendHLAtimeAdvanceRequestAvailable

sendHLAnextMessageRequest

sendHLAnextMessageRequestAvailable

sendHLAflushQueueRequest

sendHLAenableAsynchronousDelivery

sendHLAdisableAsynchronousDelivery

sendHLAmodifyLookahead

sendHLAchangeAttributeOrderType

sendHLAchangeInteractionOrderType

org.npsnet.xrti.proxies
Class ManagementProxyAmbassador