XRTIAmbassador (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
Class XRTIAmbassador

java.lang.Object
  org.npsnet.xrti.XRTIAmbassador

All Implemented Interfaces:: BootstrapInteractionListener, ManagementInteractionListener, RTIambassador, RTIambassadorEx

Direct Known Subclasses:: ExecutiveClientAmbassador, FederationExecutionAmbassador

public class XRTIAmbassador
extends java.lang.Object
implements RTIambassadorEx, BootstrapInteractionListener, ManagementInteractionListener

The principal interface of the run-time infrastructure.

Author:: Andrzej Kapolka, Stanislav Kozina

Field Summary
`protected boolean`	`asynchronousDeliveryEnabled` Whether or not asynchronous delivery mode is enabled.
`protected BootstrapProxyAmbassador`	`bootstrapProxyAmbassador` The bootstrap proxy ambassador.
`protected DescriptorManager`	`descriptorManager` The descriptor manager.
`protected long`	`handleCounter` The handle counter.
`protected static java.lang.String`	`HLA_META_FEDERATION_EXECUTION` The name of the meta-federation execution.
`protected MessageChannel`	`channel` The channel to the XRTI executive.
`protected boolean`	`inTimeAdvancingState` Flag saying that the federate is in time advancing state.
`protected long`	`joinedFederationExecutionHandle` The handle of the federation execution to which the federate is joined.
`protected java.lang.String`	`joinedFederationExecutionName` The name of the federation execution to which the federate is joined (or `null` for none).
`protected LogicalTime`	`logicalTime` Federate's logical time.
`protected LogicalTimeFactory`	`logicalTimeFactory` The logical time factory.
`protected LogicalTimeIntervalFactory`	`logicalTimeIntervalFactory` The logical time interval factory.
`protected LogicalTimeInterval`	`lookahead` Federate's lookahead.
`protected ManagementProxyAmbassador`	`managementProxyAmbassador` The management proxy ambassador.
`protected MetaFederationProxyAmbassador`	`metaFederationProxyAmbassador` The meta-federation proxy ambassador.
`protected ProxyAmbassador`	`proxyAmbassador` The proxy ambassador.
`protected ReflectionProxyAmbassador`	`reflectionProxyAmbassador` The reflection proxy ambassador.
`protected LogicalTime`	`requestedLogicalTime` Federate's requested logical time.
`protected boolean`	`timeConstrainedEnabled` Whether or not time constrained mode is enabled.
`protected boolean`	`timeRegulationEnabled` Whether or not time regulating mode is enabled.

Constructor Summary
`XRTIAmbassador()` Constructor.

Method Summary
`void`	`associateRegionsForUpdates(ObjectInstanceHandle theObject, AttributeSetRegionSetPairList attributesAndRegions)` Associates object attributes with regions for updates.
`void`	`attributeOwnershipAcquisition(ObjectInstanceHandle theObject, AttributeHandleSet desiredAttributes, byte[] userSuppliedTag)` Acquires ownership of a set of attributes.
`void`	`attributeOwnershipAcquisitionIfAvailable(ObjectInstanceHandle theObject, AttributeHandleSet desiredAttributes)` Acquires ownership of a set of attributes if they are available.
`AttributeHandleSet`	`attributeOwnershipDivestitureIfWanted(ObjectInstanceHandle theObject, AttributeHandleSet theAttributes)` Divests ownership of a set of attributes if wanted.
`void`	`cancelAttributeOwnershipAcquisition(ObjectInstanceHandle theObject, AttributeHandleSet theAttributes)` Cancels the acquisition of ownership of a set of attributes.
`void`	`cancelNegotiatedAttributeOwnershipDivestiture(ObjectInstanceHandle theObject, AttributeHandleSet theAttributes)` Cancels a negotiated divestiture of ownership of a set of attributes.
`void`	`commitRegionModifications(RegionHandleSet regions)` Commits modifications to a set of regions.
`void`	`confirmDivestiture(ObjectInstanceHandle theObject, AttributeHandleSet theAttributes, byte[] userSuppliedTag)` Confirms divestiture of ownership of a set of attributes.
`protected void`	`createDescriptorManagerAndProxyAmbassadors()` Creates and initializes the descriptor manager and proxy ambassadors.
`void`	`createFederationExecution(java.lang.String federationExecutionName, java.net.URL fdd)` Creates a new federation execution.
`protected void`	`createMessageThreads()` Creates and starts the threads that read incoming messages from the channel.
`RegionHandle`	`createRegion(DimensionHandleSet dimensions)` Creates a new region with the specified dimensions.
`protected void`	`debug(java.lang.String message)` Prints the specified message to the error stream if debug mode is enabled.
`protected LogicalTime`	`decodeLogicalTime(byte[] theTime)` Decodes and returns the logical time stored in the specified buffer.
`void`	`deleteObjectInstance(ObjectInstanceHandle objectHandle, byte[] userSuppliedTag)` Deletes the specified object instance.
`MessageRetractionReturn`	`deleteObjectInstance(ObjectInstanceHandle objectHandle, byte[] userSuppliedTag, LogicalTime theTime)` Deletes the specified object instance.
`void`	`deleteRegion(RegionHandle theRegion)` Deletes a region.
`void`	`destroyFederationExecution(java.lang.String federationExecutionName)` Destroys a federation execution.
`void`	`disableAsynchronousDelivery()` Disables asynchronous delivery.
`void`	`disableAttributeRelevanceAdvisorySwitch()` Disables the attribute relevance advisory switch.
`void`	`disableAttributeScopeAdvisorySwitch()` Disables the attribute scope advisory switch.
`void`	`disableCallbacks()` Disables callbacks.
`void`	`disableInteractionRelevanceAdvisorySwitch()` Disables the interaction relevance advisory switch.
`void`	`disableObjectClassRelevanceAdvisorySwitch()` Disables the object class relevance advisory switch.
`void`	`disableTimeConstrained()` Disables time-constrained mode.
`void`	`disableTimeRegulation()` Disables time regulation.
`void`	`enableAsynchronousDelivery()` Enables asynchronous delivery.
`void`	`enableAttributeRelevanceAdvisorySwitch()` Enables the attribute relevance advisory switch.
`void`	`enableAttributeScopeAdvisorySwitch()` Enables the attribute scope advisory switch.
`void`	`enableCallbacks()` Enables callbacks.
`void`	`enableInteractionRelevanceAdvisorySwitch()` Enables the interaction relevance advisory switch.
`void`	`enableObjectClassRelevanceAdvisorySwitch()` Enables the object class relevance advisory switch.
`void`	`enableTimeConstrained()` Enables time-constrained mode.
`void`	`enableTimeRegulation(LogicalTimeInterval theLookahead)` Enables time regulation.
`boolean`	`evokeCallback(double seconds)` Performs a callback, notifying the federate of a pending messages through the federate ambassador interface.
`boolean`	`evokeMultipleCallbacks(double minimumTime, double maximumTime)` Performs multiple callbacks over a specified time period, notifying the federate of pending messages through the federate ambassador interface.
`void`	`federateRestoreComplete()` Notifies the run-time infrastructure that the federate's restore operation is complete.
`void`	`federateRestoreNotComplete()` Notifies the run-time infrastructure that the federate's restore operation is not complete.
`void`	`federateSaveBegun()` Notifies the run-time infrastructure that the federate is beginning a save operation.
`void`	`federateSaveComplete()` Notifies the run-time infrastructure that the federate has completed its save operation.
`void`	`federateSaveNotComplete()` Notifies the run-time infrastructure that the federate's save operation is not complete.
`void`	`finalizeRTI()` Finalizes the run-time infrastructure.
`void`	`flushQueueRequest(LogicalTime theTime)` Requests a queue flush.
`AttributeHandle`	`getAttributeHandle(ObjectClassHandle whichClass, java.lang.String theName)` Returns the attribute handle associated with the specified name.
`AttributeHandleFactory`	`getAttributeHandleFactory()` Returns the run-time infrastructure's attribute handle factory.
`AttributeHandleSetFactory`	`getAttributeHandleSetFactory()` Returns the run-time infrastructure's attribute handle set factory.
`AttributeHandleValueMapFactory`	`getAttributeHandleValueMapFactory()` Returns the run-time infrastructure's attribute handle value map factory.
`java.lang.String`	`getAttributeName(ObjectClassHandle whichClass, AttributeHandle theHandle)` Returns the name of the specified attribute.
`AttributeSetRegionSetPairListFactory`	`getAttributeSetRegionSetPairListFactory()` Returns the run-time infrastructure's attribute set region set pair list factory.
`DimensionHandleSet`	`getAvailableDimensionsForClassAttribute(ObjectClassHandle whichClass, AttributeHandle theHandle)` Returns the set of available dimensions for a class attribute.
`DimensionHandleSet`	`getAvailableDimensionsForInteractionClass(InteractionClassHandle theHandle)` Returns the set of available dimensions for an interaction class.
`DimensionHandle`	`getDimensionHandle(java.lang.String theName)` Returns the dimension handle associated with the specified name.
`DimensionHandleFactory`	`getDimensionHandleFactory()` Returns the run-time infrastructure's dimension handle factory.
`DimensionHandleSet`	`getDimensionHandleSet(RegionHandle region)` Returns the dimension handle set corresponding to the specified region.
`DimensionHandleSetFactory`	`getDimensionHandleSetFactory()` Returns the run-time infrastructure's dimension handle set factory.
`java.lang.String`	`getDimensionName(DimensionHandle theHandle)` Returns the name associated with the specified dimension handle.
`long`	`getDimensionUpperBound(DimensionHandle theHandle)` Returns the upper bound of the specified dimension.
`FederateHandleFactory`	`getFederateHandleFactory()` Returns the run-time infrastructure's federate handle factory.
`FederateHandleSetFactory`	`getFederateHandleSetFactory()` Returns the run-time infrastructure's federate handle set factory.
`java.lang.String`	`getHLAversion()` Returns the High Level Architecture specification version to which the run-time infrastructure conforms.
`InteractionClassHandle`	`getInteractionClassHandle(java.lang.String theName)` Returns the interaction handle associated with the specified name.
`InteractionClassHandleFactory`	`getInteractionClassHandleFactory()` Returns the run-time infrastructure's interaction class handle factory.
`java.lang.String`	`getInteractionClassName(InteractionClassHandle theHandle)` Returns the name of the specified interaction class.
`ObjectClassHandle`	`getKnownObjectClassHandle(ObjectInstanceHandle theObject)` Returns the class handle corresponding to the specified object.
`ObjectClassHandle`	`getObjectClassHandle(java.lang.String theName)` Returns the object class handle associated with the specified name.
`ObjectClassHandleFactory`	`getObjectClassHandleFactory()` Returns the run-time infrastructure's object class handle factory.
`java.lang.String`	`getObjectClassName(ObjectClassHandle theHandle)` Returns the name of the specified object class.
`ObjectInstanceHandle`	`getObjectInstanceHandle(java.lang.String theName)` Returns the object instance handle associated with the specified name.
`ObjectInstanceHandleFactory`	`getObjectInstanceHandleFactory()` Returns the run-time infrastructure's object instance handle factory.
`java.lang.String`	`getObjectInstanceName(ObjectInstanceHandle theHandle)` Returns the name of the specified object instance.
`java.lang.String`	`getOrderName(OrderType theType)` Returns the name corresponding to the specified order type.
`OrderType`	`getOrderType(java.lang.String theName)` Returns the order type corresponding to the specified name.
`ParameterHandle`	`getParameterHandle(InteractionClassHandle whichClass, java.lang.String theName)` Returns the parameter handle associated with the specified name.
`ParameterHandleFactory`	`getParameterHandleFactory()` Returns the run-time infrastructure's parameter handle factory.
`ParameterHandleValueMapFactory`	`getParameterHandleValueMapFactory()` Returns the run-time infrastructure's parameter handle value map factory.
`java.lang.String`	`getParameterName(InteractionClassHandle whichClass, ParameterHandle theHandle)` Returns the name of the specified parameter.
`RangeBounds`	`getRangeBounds(RegionHandle region, DimensionHandle dimension)` Returns the range bounds on the specified region and dimension.
`RegionHandleSetFactory`	`getRegionHandleSetFactory()` Returns the run-time infrastructure's region handle set factory.
`java.lang.String`	`getTransportationName(TransportationType theType)` Returns the name corresponding to the specified transportation type.
`TransportationType`	`getTransportationType(java.lang.String theName)` Returns the transportation type corresponding to the specified name.
`void`	`changeAttributeOrderType(ObjectInstanceHandle theObject, AttributeHandleSet theAttributes, OrderType theType)` Changes the order type of a set of attributes.
`void`	`changeAttributeTransportationType(ObjectInstanceHandle theObject, AttributeHandleSet theAttributes, TransportationType theType)` Changes the transportation type associated with a set of attributes.
`void`	`changeInteractionOrderType(InteractionClassHandle theClass, OrderType theType)` Changes the order type of a class of interactions.
`void`	`changeInteractionTransportationType(InteractionClassHandle theClass, TransportationType theType)` Changes the transporation type associated with an interaction class.
`java.util.Properties`	`initializeRTI(java.util.Properties properties)` Initializes the run-time infrastructure.
`boolean`	`isAttributeOwnedByFederate(ObjectInstanceHandle theObject, AttributeHandle theAttribute)` Checks whether a specified attribute is owned by the federate.
`protected boolean`	`isZeroLookaheadRestricted()` Returns true if federate is subject of zero lookahead restriction, false otherwise.
`FederateHandle`	`joinFederationExecution(java.lang.String federateType, java.lang.String federationExecutionName, FederateAmbassador federateReference, MobileFederateServices serviceReferences)` Joins a federation execution.
`void`	`localDeleteObjectInstance(ObjectInstanceHandle objectHandle)` Deletes the specified object instance locally.
`void`	`mergeFDD(java.net.URL fdd)` Merges the object model contained in the specified federation description document with the current federation object model.
`void`	`modifyLookahead(LogicalTimeInterval theLookahead)` Modifies the lookahead interval.
`void`	`negotiatedAttributeOwnershipDivestiture(ObjectInstanceHandle theObject, AttributeHandleSet theAttributes, byte[] userSuppliedTag)` Performs a negotiated divestiture of ownership of a set of attributes.
`void`	`nextMessageRequest(LogicalTime theTime)` Requests the next message.
`void`	`nextMessageRequestAvailable(LogicalTime theTime)` Requests the next message if available.
`long`	`normalizeFederateHandle(FederateHandle federateHandle)` Normalizes a federate handle, returning it in its equivalent normalized form.
`long`	`normalizeServiceGroup(ServiceGroup group)` Normalizes a service group, returning it in its equivalent normalized form.
`protected void`	`proxyAmbassador_receiveInteraction(InteractionClassHandle interactionClass, ParameterHandleValueMap theParameters, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport, LogicalTime theTime, OrderType receivedOrdering)` Calls the receiveInteraction() method of proxyAmbassador object.
`void`	`publishInteractionClass(InteractionClassHandle theInteraction)` Publishes the specified interaction class.
`void`	`publishObjectClassAttributes(ObjectClassHandle theClass, AttributeHandleSet attributeList)` Publishes the specified object class attributes.
`void`	`queryAttributeOwnership(ObjectInstanceHandle theObject, AttributeHandle theAttribute)` Requests information concerning the ownership of an attribute.
`void`	`queryFederationRestoreStatus()` Requests information from the run-time infrastructure concerning the restore status of the federation.
`void`	`queryFederationSaveStatus()` Requests information from the run-time infrastructure concerning the federation's save status.
`TimeQueryReturn`	`queryGALT()` Queries the greatest available logical time.
`TimeQueryReturn`	`queryLITS()` Queries the least incoming time stamp.
`LogicalTime`	`queryLogicalTime()` Queries the current logical time.
`LogicalTimeInterval`	`queryLookahead()` Queries the lookahead interval.
`void`	`receiveHLAannounceSynchronizationPoint(java.lang.String synchronizationPointLabel, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Notifies the federate that a synchronization point has been announced.
`void`	`receiveHLAcontinue(byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Notifies the federate that the executive is done sending callbacks.
`void`	`receiveHLAdeleteObjectInstance(byte[] HLAfederate, byte[] HLAobjectInstance, byte[] HLAtag, byte[] HLAtimeStamp, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Cause an object instance to be deleted from the federation.
`void`	`receiveHLAdisableAsynchronousDelivery(byte[] HLAfederate, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` 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`	`receiveHLAdisableTimeConstrained(byte[] HLAfederate, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Cause the logical time of the joined federate to cease being constrained by the logical times of other joined federates.
`void`	`receiveHLAdisableTimeRegulation(byte[] HLAfederate, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Cause the joined federate to cease regulating the logical time of other joined federates.
`void`	`receiveHLAenableAsynchronousDelivery(byte[] HLAfederate, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Cause the RTI to deliver receive-order messages to the joined federate at any time, even if the joined federate is time-constrained.
`void`	`receiveHLAenableTimeConstrained(byte[] HLAfederate, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Cause the logical time of the joined federate to begin being constrained by the logical times of other joined federates.
`void`	`receiveHLAenableTimeRegulation(byte[] HLAfederate, byte[] HLAlookahead, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Cause the joined federate to begin regulating the logical time of other joined federates.
`void`	`receiveHLAfederateRestoreComplete(byte[] HLAfederate, boolean HLAsuccessIndicator, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Mimic the joined federate's report of completion of a restore.
`void`	`receiveHLAfederateSaveBegun(byte[] HLAfederate, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Mimic the federate's report of starting a save.
`void`	`receiveHLAfederateSaveComplete(byte[] HLAfederate, boolean HLAsuccessIndicator, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Mimic the joined federate's report of completion of a save.
`void`	`receiveHLAfederationSynchronized(java.lang.String synchronizationPointLabel, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Notifies the federate that the federation has been synchronized.
`void`	`receiveHLAflushQueueRequest(byte[] HLAfederate, byte[] HLAtimeStamp, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` 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`	`receiveHLAchangeAttributeOrderType(byte[] HLAfederate, byte[] HLAobjectInstance, byte[][] HLAattributeList, HLAorderType HLAsendOrder, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Change the ordering type used by the joined federate when sending attributes belonging to the object instance.
`void`	`receiveHLAchangeAttributeTransportationType(byte[] HLAfederate, byte[] HLAobjectInstance, byte[][] HLAattributeList, char[] HLAtransportation, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Change the transportation type used by the joined federate when sending attributes belonging to the object instance.
`void`	`receiveHLAchangeInteractionOrderType(byte[] HLAfederate, byte[] HLAinteractionClass, HLAorderType HLAsendOrder, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Change the order type used by the joined federate when sending a class of interaction.
`void`	`receiveHLAchangeInteractionTransportationType(byte[] HLAfederate, byte[] HLAinteractionClass, char[] HLAtransportation, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Change the transportation type used by the joined federate when sending a class of interaction.
`void`	`receiveHLAinteractionFragment(int interactionNumber, int interactionSize, int fragmentOffset, byte[] fragmentContents, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` A piece of a fragmented interaction.
`void`	`receiveHLAlocalDeleteObjectInstance(byte[] HLAfederate, byte[] HLAobjectInstance, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Inform the RTI that it shall treat the specified object instance as if thejoined federate did not know about the object instance.
`void`	`receiveHLAmodifyAttributeState(byte[] HLAfederate, byte[] HLAobjectInstance, byte[] HLAattribute, HLAownership HLAattributeState, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Modify the ownership state of an attribute of an object instance for the specified joined federate.
`void`	`receiveHLAmodifyLookahead(byte[] HLAfederate, byte[] HLAlookahead, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Change the lookahead value used by the joined federate.
`void`	`receiveHLAnextMessageRequest(byte[] HLAfederate, byte[] HLAtimeStamp, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` 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`	`receiveHLAnextMessageRequestAvailable(byte[] HLAfederate, byte[] HLAtimeStamp, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` 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`	`receiveHLApublishInteractionClass(byte[] HLAfederate, byte[] HLAinteractionClass, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Set the joined federate's publication status of an interaction class.
`void`	`receiveHLApublishObjectClassAttributes(byte[] HLAfederate, byte[] HLAobjectClass, byte[][] HLAattributeList, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Set the joined federate's publication status of attributes belonging to an object class.
`void`	`receiveHLAregisterFederationSynchronizationPoint(java.lang.String synchronizationPointLabel, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Federate's request for registering a federation synchronization point.
`void`	`receiveHLAregisterObjectInstance(java.lang.String objectName, long objectInstanceHandle, long objectClassHandle, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Registers a new object instance.
`void`	`receiveHLAreportException(byte[] HLAfederate, java.lang.String HLAservice, java.lang.String HLAexception, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` 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`	`receiveHLAreportHandles(long blockStart, long blockSize, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Reports a block of handles.
`void`	`receiveHLAreportInteractionPublication(byte[] HLAfederate, byte[][] HLAinteractionClassList, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`receiveHLAreportInteractionsReceived(byte[] HLAfederate, char[] HLAtransportation, HLAinteractionCount[] HLAinteractionCounts, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`receiveHLAreportInteractionsSent(byte[] HLAfederate, char[] HLAtransportation, HLAinteractionCount[] HLAinteractionCounts, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`receiveHLAreportInteractionSubscription(byte[] HLAfederate, HLAinteractionSubscription[] HLAinteractionClassList, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`receiveHLAreportMOMexception(byte[] HLAfederate, java.lang.String HLAservice, java.lang.String HLAexception, boolean HLAparameterError, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` 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`	`receiveHLAreportObjectClassPublication(byte[] HLAfederate, int HLAnumberOfClasses, byte[] HLAobjectClass, byte[][] HLAattributeList, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`receiveHLAreportObjectClassSubscription(byte[] HLAfederate, int HLAnumberOfClasses, byte[] HLAobjectClass, boolean HLAactive, byte[][] HLAattributeList, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`receiveHLAreportObjectInstanceInformation(byte[] HLAfederate, byte[] HLAobjectInstance, byte[][] HLAownedInstanceAttributeList, byte[] HLAregisteredClass, byte[] HLAknownClass, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`receiveHLAreportObjectInstancesReflected(byte[] HLAfederate, HLAobjectClassBasedCount[] HLAobjectInstanceCounts, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`receiveHLAreportObjectInstancesThatCanBeDeleted(byte[] HLAfederate, HLAobjectClassBasedCount[] HLAobjectInstanceCounts, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.HLArequest.HLArequestObject InstancesThatCanBeDeleted.
`void`	`receiveHLAreportObjectInstancesUpdated(byte[] HLAfederate, HLAobjectClassBasedCount[] HLAobjectInstanceCounts, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`receiveHLAreportReflectionsReceived(byte[] HLAfederate, char[] HLAtransportation, HLAobjectClassBasedCount[] HLAreflectCounts, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`receiveHLAreportServiceInvocation(byte[] HLAfederate, java.lang.String HLAservice, boolean HLAsuccessIndicator, java.lang.String[] HLAsuppliedArguments, java.lang.String[] HLAreturnedArguments, java.lang.String HLAexception, int HLAserialNumber, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` 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`	`receiveHLAreportSynchronizationPoints(byte[] HLAfederate, java.lang.String[] HLAsynchPoints, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`receiveHLAreportSynchronizationPointStatus(byte[] HLAfederate, java.lang.String HLAsynchPointName, HLAsynchPointFederate[] HLAsynchPointFederates, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`receiveHLAreportUpdatesSent(byte[] HLAfederate, char[] HLAtransportation, HLAobjectClassBasedCount[] HLAupdateCounts, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` The interaction shall be sent by the RTI in response to an interaction of class HLAmanager.HLAfederate.
`void`	`receiveHLArequestAttributeValueUpdate(long objectInstanceHandle, long[] attributeHandleList, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Requests an attribute value update.
`void`	`receiveHLArequestHandles(long blockSize, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Requests a block of handles.
`void`	`receiveHLArequestInteractionsReceived(byte[] HLAfederate, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Request that the RTI send a report interaction that contains the number of interactions that a joined federate has received.
`void`	`receiveHLArequestInteractionsSent(byte[] HLAfederate, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Request that the RTI send a report interaction that contains the number of interactions that a joined federate has generated.
`void`	`receiveHLArequestObjectInstanceInformation(byte[] HLAfederate, byte[] HLAobjectInstance, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Request that the RTI send a report interaction that contains the information that a joined federate maintains on a single object instance.
`void`	`receiveHLArequestObjectInstancesReflected(byte[] HLAfederate, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` 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`	`receiveHLArequestObjectInstancesThatCanBeDeleted(byte[] HLAfederate, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Request that the RTI send a report interaction that contains the object instances that can be deleted at the joined federate.
`void`	`receiveHLArequestObjectInstancesUpdated(byte[] HLAfederate, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Request that the RTI send a report interaction that contains the object instance updating responsibility of a joined federate.
`void`	`receiveHLArequestPublications(byte[] HLAfederate, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Request that the RTI send report interactions that contain the publication data of a joined federate.
`void`	`receiveHLArequestReflectionsReceived(byte[] HLAfederate, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Request that the RTI send a report interaction that contains the number of reflections that a joined federate has received.
`void`	`receiveHLArequestSubscriptions(byte[] HLAfederate, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Request that the RTI send report interactions that contain the subscription data of a joined federate.
`void`	`receiveHLArequestSynchronizationPoints(byte[] HLAfederate, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Request that the RTI send a report interaction that contains a list of all in-progress federation synchronization points.
`void`	`receiveHLArequestSynchronizationPointStatus(byte[] HLAfederate, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` 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`	`receiveHLArequestUpdatesSent(byte[] HLAfederate, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Request that the RTI send a report interaction that contains the number of updates that a joined federate has generated.
`void`	`receiveHLAresignFederationExecution(byte[] HLAfederate, HLAresignAction HLAresignAction, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Cause the joined federate to resign from the federation execution.
`void`	`receiveHLAresultBoolean(boolean result, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Notifies the federate about the result of last invoked service.
`void`	`receiveHLAsetExceptionReporting(byte[] HLAfederate, boolean HLAreportingState, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Specify whether the RTI shall report service invocation exceptions via HLAmanager.HLAfederate.HLAreport.
`void`	`receiveHLAsetServiceReporting(byte[] HLAfederate, boolean HLAreportingState, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Specify whether to report service invocations to0 or from the specified joined federate via HLAmanager.HLAfederate.
`void`	`receiveHLAsetSwitches(HLAswitch HLAautoProvide, HLAswitch HLAconveyRegionDesignatorSets, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Set the values of several HLA switches.
`void`	`receiveHLAsetTiming(byte[] HLAfederate, int HLAreportPeriod, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Adjust the time period between updates of the HLAmanager.HLAfederate object instance for the specified joined federate.
`void`	`receiveHLAsubscribeInteractionClass(byte[] HLAfederate, byte[] HLAinteractionClass, boolean HLAactive, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Set the joined federate's subscription status to an interaction class.
`void`	`receiveHLAsubscribeObjectClassAttributes(byte[] HLAfederate, byte[] HLAobjectClass, byte[][] HLAattributeList, boolean HLAactive, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Set the joined federate's subscription status of attributes belonging to an object class.
`void`	`receiveHLAsynchronizationPointAchieved(byte[] HLAfederate, java.lang.String HLAlabel, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Mimic the federate's report of achieving a synchronization point.
`void`	`receiveHLAsynchronizationPointRegistrationFailed(java.lang.String synchronizationPointLabel, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Notifies the federate that the synchronization point registration operation has failed.
`void`	`receiveHLAsynchronizationPointRegistrationSucceeded(java.lang.String synchronizationPointLabel, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Notifies the federate that the synchronization point registration operation has succeeded.
`void`	`receiveHLAtimeAdvanceGrant(byte[] theTime, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Notifies the federate that a time advance has been granted.
`void`	`receiveHLAtimeAdvanceRequest(byte[] HLAfederate, byte[] HLAtimeStamp, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` 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`	`receiveHLAtimeAdvanceRequestAvailable(byte[] HLAfederate, byte[] HLAtimeStamp, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` 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`	`receiveHLAtimeConstrainedEnabled(byte[] time, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Notifies the federate that time-constrained mode has been enabled.
`void`	`receiveHLAtimeRegulationEnabled(byte[] time, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Notifies the federate that time regulation has been enabled.
`void`	`receiveHLAunconditionalAttributeOwnershipDivestiture(byte[] HLAfederate, byte[] HLAobjectInstance, byte[][] HLAattributeList, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Cause the ownership of attributes of an object instance to be unconditionally divested by the joined federate.
`void`	`receiveHLAunpublishInteractionClass(byte[] HLAfederate, byte[] HLAinteractionClass, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Cause the joined federate no longer to publish an interaction class.
`void`	`receiveHLAunpublishObjectClassAttributes(byte[] HLAfederate, byte[] HLAobjectClass, byte[][] HLAattributeList, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Cause the joined federate no longer to publish attributes of an object class.
`void`	`receiveHLAunsubscribeInteractionClass(byte[] HLAfederate, byte[] HLAinteractionClass, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Cause the joined federate no longer to subscribe to an interaction class.
`void`	`receiveHLAunsubscribeObjectClassAttributes(byte[] HLAfederate, byte[] HLAobjectClass, byte[][] HLAattributeList, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Cause the joined federate no longer to subscribe to attributes of an object class.
`void`	`receiveHLAupdateAttributeValuesBestEffort(long objectInstanceHandle, HLAattributeHandleValuePair[] attributeHandleValuePairList, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Updates a set of attribute values with best-effort transportation and receive ordering.
`void`	`receiveHLAupdateAttributeValuesReliable(long objectInstanceHandle, HLAattributeHandleValuePair[] attributeHandleValuePairList, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport)` Updates a set of attribute values with reliable transportation and receive ordering.
`void`	`registerFederationSynchronizationPoint(java.lang.String pSynchronizationPointLabel, byte[] userSuppliedTag)` Registers a federation synchronization point.
`void`	`registerFederationSynchronizationPoint(java.lang.String pSynchronizationPointLabel, byte[] userSuppliedTag, FederateHandleSet synchronizationSet)` Registers a federation synchronization point.
`ObjectInstanceHandle`	`registerObjectInstance(ObjectClassHandle theClass)` Registers a new instance of the specified object class.
`ObjectInstanceHandle`	`registerObjectInstance(ObjectClassHandle theClass, java.lang.String theObjectName)` Registers a new instance of the specified object class.
`ObjectInstanceHandle`	`registerObjectInstanceWithRegions(ObjectClassHandle theClass, AttributeSetRegionSetPairList attributesAndRegions)` Registers an object instance with associated regions.
`ObjectInstanceHandle`	`registerObjectInstanceWithRegions(ObjectClassHandle theClass, AttributeSetRegionSetPairList attributesAndRegions, java.lang.String theObject)` Registers an object instance with associated regions.
`void`	`requestAttributeValueUpdate(ObjectClassHandle theClass, AttributeHandleSet theAttributes, byte[] userSuppliedTag)` Requests an attribute value update.
`void`	`requestAttributeValueUpdate(ObjectInstanceHandle theObject, AttributeHandleSet theAttributes, byte[] userSuppliedTag)` Requests an attribute value update.
`void`	`requestAttributeValueUpdateWithRegions(ObjectClassHandle theClass, AttributeSetRegionSetPairList attributesAndRegions, byte[] userSuppliedTag)` Requests an attribute value update with associated regions.
`void`	`requestFederationRestore(java.lang.String label)` Requests a federation restore operation.
`void`	`requestFederationSave(java.lang.String label)` Requests that the federation perform a save operation.
`void`	`requestFederationSave(java.lang.String label, LogicalTime theTime)` Requests that the federation perform a save operation.
`void`	`reserveObjectInstanceName(java.lang.String theObjectName)` Reserves the specified object instance name.
`void`	`resignFederationExecution(ResignAction resignAction)` Resigns from the currently joined federation execution.
`void`	`retract(MessageRetractionHandle theHandle)` Retracts a message.
`void`	`sendInteraction(InteractionClassHandle theInteraction, ParameterHandleValueMap theParameters, byte[] userSuppliedTag)` Sends an interaction.
`MessageRetractionReturn`	`sendInteraction(InteractionClassHandle theInteraction, ParameterHandleValueMap theParameters, byte[] userSuppliedTag, LogicalTime theTime)` Sends an interaction.
`protected void`	`sendInteractionBestEffort(InteractionClassHandle theInteraction, ParameterHandleValueMap theParameters, byte[] userSuppliedTag, OrderType sentOrdering, LogicalTime theTime)` Sends an interaction with best-effort transportation.
`protected void`	`sendInteractionReliable(InteractionClassHandle theInteraction, ParameterHandleValueMap theParameters, byte[] userSuppliedTag, OrderType sentOrdering, LogicalTime theTime)` Sends an interaction with reliable transportation.
`void`	`sendInteractionWithRegions(InteractionClassHandle theInteraction, ParameterHandleValueMap theParameters, RegionHandleSet regions, byte[] userSuppliedTag)` Sends an interaction with associated regions.
`MessageRetractionReturn`	`sendInteractionWithRegions(InteractionClassHandle theInteraction, ParameterHandleValueMap theParameters, RegionHandleSet regions, byte[] userSuppliedTag, LogicalTime theTime)` Sends an interaction with associated regions.
`void`	`setRangeBounds(RegionHandle region, DimensionHandle dimension, RangeBounds bounds)` Sets the range bounds on the specified region and dimension.
`void`	`subscribeInteractionClass(InteractionClassHandle theClass)` Subscribes to the specified interaction class.
`void`	`subscribeInteractionClassPassively(InteractionClassHandle theClass)` Passively subscribes to the specified interaction class.
`void`	`subscribeInteractionClassPassivelyWithRegions(InteractionClassHandle theClass, RegionHandleSet regions)` Passively subscribes to a class of interactions with associated regions.
`void`	`subscribeInteractionClassWithRegions(InteractionClassHandle theClass, RegionHandleSet regions)` Subscribes to a class of interactions with associated regions.
`void`	`subscribeObjectClassAttributes(ObjectClassHandle theClass, AttributeHandleSet attributeList)` Subscribes to a set of object class attributes.
`void`	`subscribeObjectClassAttributesPassively(ObjectClassHandle theClass, AttributeHandleSet attributeList)` Passively subscribes to a set of object class attributes.
`void`	`subscribeObjectClassAttributesPassivelyWithRegions(ObjectClassHandle theClass, AttributeSetRegionSetPairList attributesAndRegions)` Passively subscribes to a set of object class attributes with associated regions.
`void`	`subscribeObjectClassAttributesWithRegions(ObjectClassHandle theClass, AttributeSetRegionSetPairList attributesAndRegions)` Subscribes to a set of object class attributes with associated regions.
`void`	`synchronizationPointAchieved(java.lang.String pSynchronizationPointLabel)` Notifies the run-time infrastructure that a synchronization point has been achieved.
`void`	`timeAdvanceRequest(LogicalTime theTime)` Requests a time advance.
`void`	`timeAdvanceRequestAvailable(LogicalTime theTime)` Requests a time advance if available.
`protected void`	`turnZeroLookaheadRestrictionOffIfPossible(LogicalTime theTime)` Turns off the zero lookahead restriction if it is possible.
`protected void`	`turnZeroLookaheadRestrictionOn(LogicalTime theTime)` Turns on the zero lookahead restriction.
`void`	`unassociateRegionsForUpdates(ObjectInstanceHandle theObject, AttributeSetRegionSetPairList attributesAndRegions)` Unassociates object attributes with regions for updates.
`void`	`unconditionalAttributeOwnershipDivestiture(ObjectInstanceHandle theObject, AttributeHandleSet theAttributes)` Unconditionally divests ownership of a set of attributes.
`void`	`unpublishInteractionClass(InteractionClassHandle theInteraction)` Unpublishes the specified interaction class.
`void`	`unpublishObjectClass(ObjectClassHandle theClass)` Unpublishes the specified object class.
`void`	`unpublishObjectClassAttributes(ObjectClassHandle theClass, AttributeHandleSet attributeList)` Unpublishes the specified object class attributes.
`void`	`unsubscribeInteractionClass(InteractionClassHandle theClass)` Unsubscribes from the specified interaction class.
`void`	`unsubscribeInteractionClassWithRegions(InteractionClassHandle theClass, RegionHandleSet regions)` Unsubscribes from a class of interactions with associated regions.
`void`	`unsubscribeObjectClass(ObjectClassHandle theClass)` Unsubscribes from an object class.
`void`	`unsubscribeObjectClassAttributes(ObjectClassHandle theClass, AttributeHandleSet attributeList)` Unsubscribes from a set of object class attributes.
`void`	`unsubscribeObjectClassAttributesWithRegions(ObjectClassHandle theClass, AttributeSetRegionSetPairList attributesAndRegions)` Unsubscribes from a set of object class attributes with associated regions.
`void`	`updateAttributeValues(ObjectInstanceHandle theObject, AttributeHandleValueMap theAttributes, byte[] userSuppliedTag)` Updates the attribute values associated with an object.
`MessageRetractionReturn`	`updateAttributeValues(ObjectInstanceHandle theObject, AttributeHandleValueMap theAttributes, byte[] userSuppliedTag, LogicalTime theTime)` Updates the attribute values associated with an object.
`protected void`	`verifyFederateIsExecutionMember()` Throws an exception if the federate is not a member of an execution.
`protected void`	`verifyFederateIsNotInTimeAdvancingState()` Throws an exception if federate is in a time-advancing state.
`protected void`	`verifyLookaheadIsValid(LogicalTimeInterval theLookahead)` Throws an exception if the specified amount of lookahead is invalid.
`protected void`	`verifyNoRestoreInProgress()` Throws an exception if a restore operation is in progress.
`protected void`	`verifyNoSaveInProgress()` Throws an exception if a save operation is in progress.
`protected void`	`verifyRequestedTimeIsValid(LogicalTime theTime)` Throws an exception if the specified requested logical time is invalid.
`protected void`	`verifyRequestForTimeConstrainedIsNotPending()` Throws an exception if request for time constrained is pending.
`protected void`	`verifyRequestForTimeRegulationIsNotPending()` Throws an exception if request for time regulation is pending.
`protected void`	`verifyTimeStampIsValid(LogicalTime theTime)` Throws an exception if the specified time stamp is invalid.

Methods inherited from class java.lang.Object

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

Field Detail

HLA_META_FEDERATION_EXECUTION

protected static final java.lang.String HLA_META_FEDERATION_EXECUTION

The name of the meta-federation execution.

See Also:: Constant Field Values

logicalTimeFactory

protected LogicalTimeFactory logicalTimeFactory

The logical time factory. Since time management was added into XRTI, this field is protected, not private.

logicalTimeIntervalFactory

protected LogicalTimeIntervalFactory logicalTimeIntervalFactory

The logical time interval factory. Since time management was added into XRTI, this field is protected, not private.

timeRegulationEnabled

protected boolean timeRegulationEnabled

Whether or not time regulating mode is enabled. Since time management was added into XRTI, this field is protected, not private. It is used by ExecutiveClientAmbassador.

timeConstrainedEnabled

protected boolean timeConstrainedEnabled

Whether or not time constrained mode is enabled. Since time management was added into XRTI, this field is protected, not private. It is used by ExecutiveClientAmbassador.

asynchronousDeliveryEnabled

protected boolean asynchronousDeliveryEnabled

Whether or not asynchronous delivery mode is enabled. Since time management was added into XRTI, this field is protected, not private. It is used by ExecutiveClientAmbassador.

channel

protected MessageChannel channel

The channel to the XRTI executive.

proxyAmbassador

protected ProxyAmbassador proxyAmbassador

The proxy ambassador.

bootstrapProxyAmbassador

protected BootstrapProxyAmbassador bootstrapProxyAmbassador

The bootstrap proxy ambassador.

metaFederationProxyAmbassador

protected MetaFederationProxyAmbassador metaFederationProxyAmbassador

The meta-federation proxy ambassador.

reflectionProxyAmbassador

protected ReflectionProxyAmbassador reflectionProxyAmbassador

The reflection proxy ambassador.

managementProxyAmbassador

protected ManagementProxyAmbassador managementProxyAmbassador

The management proxy ambassador.

handleCounter

protected long handleCounter

The handle counter.

joinedFederationExecutionName

protected java.lang.String joinedFederationExecutionName

The name of the federation execution to which the federate is joined (or null for none).

joinedFederationExecutionHandle

protected long joinedFederationExecutionHandle

The handle of the federation execution to which the federate is joined.

descriptorManager

protected DescriptorManager descriptorManager

The descriptor manager.

logicalTime

protected LogicalTime logicalTime

Federate's logical time.

lookahead

protected LogicalTimeInterval lookahead

Federate's lookahead.

requestedLogicalTime

protected LogicalTime requestedLogicalTime

Federate's requested logical time.

inTimeAdvancingState

protected boolean inTimeAdvancingState

Flag saying that the federate is in time advancing state.

Constructor Detail

XRTIAmbassador

public XRTIAmbassador()

Constructor.

Method Detail

debug

protected void debug(java.lang.String message)

Prints the specified message to the error stream if debug mode is enabled.

Parameters:: message - the message to print

verifyFederateIsExecutionMember

protected void verifyFederateIsExecutionMember()
                                        throws FederateNotExecutionMember

Throws an exception if the federate is not a member of an execution.

Throws:: FederateNotExecutionMember - if the federate is not a member of an execution

verifyNoSaveInProgress

protected void verifyNoSaveInProgress()
                               throws SaveInProgress

Throws an exception if a save operation is in progress.

Throws:: SaveInProgress - if a save operation is in progress

verifyNoRestoreInProgress

protected void verifyNoRestoreInProgress()
                                  throws RestoreInProgress

Throws an exception if a restore operation is in progress.

Throws:: RestoreInProgress - if a restore operation is in progress

verifyFederateIsNotInTimeAdvancingState

protected void verifyFederateIsNotInTimeAdvancingState()
                                                throws InTimeAdvancingState

Throws an exception if federate is in a time-advancing state.

Throws:: InTimeAdvancingState - if federate is in a time-advancing state

verifyRequestForTimeRegulationIsNotPending

protected void verifyRequestForTimeRegulationIsNotPending()
                                                   throws RequestForTimeRegulationPending

Throws an exception if request for time regulation is pending.

Throws:: RequestForTimeRegulationPending - if request for time regulation is pending

verifyRequestForTimeConstrainedIsNotPending

protected void verifyRequestForTimeConstrainedIsNotPending()
                                                    throws RequestForTimeConstrainedPending

Throws an exception if request for time constrained is pending.

Throws:: RequestForTimeConstrainedPending - if request for time constrained is pending

verifyTimeStampIsValid

protected void verifyTimeStampIsValid(LogicalTime theTime)
                               throws InvalidLogicalTime

Throws an exception if the specified time stamp is invalid.

Parameters:: theTime - the time stamp
Throws:: InvalidLogicalTime - if the specified time stamp is invalid

verifyRequestedTimeIsValid

protected void verifyRequestedTimeIsValid(LogicalTime theTime)
                                   throws InvalidLogicalTime

Throws an exception if the specified requested logical time is invalid.

Parameters:: theTime - the requested logical time
Throws:: InvalidLogicalTime - if the specified requested logical time is invalid

verifyLookaheadIsValid

protected void verifyLookaheadIsValid(LogicalTimeInterval theLookahead)
                               throws InvalidLookahead

Throws an exception if the specified amount of lookahead is invalid.

Parameters:: theLookahead - the amount of lookahead
Throws:: InvalidLookahead - if the specified amount of lookahead is invalid

getHLAversion

public java.lang.String getHLAversion()

Returns the High Level Architecture specification version to which the run-time infrastructure conforms.

Specified by:: getHLAversion in interface RTIambassador

Returns:: the High Level Architecture specification version to which the run-time infrastructure conforms

getAttributeHandleFactory

public AttributeHandleFactory getAttributeHandleFactory()

Returns the run-time infrastructure's attribute handle factory.

Specified by:: getAttributeHandleFactory in interface RTIambassador

Returns:: the run-time infrastructure's attribute handle factory

getAttributeHandleSetFactory

public AttributeHandleSetFactory getAttributeHandleSetFactory()

Returns the run-time infrastructure's attribute handle set factory.

Specified by:: getAttributeHandleSetFactory in interface RTIambassador

Returns:: the run-time infrastructure's attribute handle set factory

getAttributeHandleValueMapFactory

public AttributeHandleValueMapFactory getAttributeHandleValueMapFactory()

Returns the run-time infrastructure's attribute handle value map factory.

Specified by:: getAttributeHandleValueMapFactory in interface RTIambassador

Returns:: the run-time infrastructure's attribute handle value map factory

getAttributeSetRegionSetPairListFactory

public AttributeSetRegionSetPairListFactory getAttributeSetRegionSetPairListFactory()

Returns the run-time infrastructure's attribute set region set pair list factory.

Specified by:: getAttributeSetRegionSetPairListFactory in interface RTIambassador

Returns:: the run-time infrastructure's attribute set region set pair list factory

getDimensionHandleFactory

public DimensionHandleFactory getDimensionHandleFactory()

Returns the run-time infrastructure's dimension handle factory.

Specified by:: getDimensionHandleFactory in interface RTIambassador

Returns:: the run-time infrastructure's dimension handle factory

getDimensionHandleSetFactory

public DimensionHandleSetFactory getDimensionHandleSetFactory()

Returns the run-time infrastructure's dimension handle set factory.

Specified by:: getDimensionHandleSetFactory in interface RTIambassador

Returns:: the run-time infrastructure's dimension handle set factory

getFederateHandleFactory

public FederateHandleFactory getFederateHandleFactory()

Returns the run-time infrastructure's federate handle factory.

Specified by:: getFederateHandleFactory in interface RTIambassador

Returns:: the run-time infrastructure's federate handle factory

getFederateHandleSetFactory

public FederateHandleSetFactory getFederateHandleSetFactory()

Returns the run-time infrastructure's federate handle set factory.

Specified by:: getFederateHandleSetFactory in interface RTIambassador

Returns:: the run-time infrastructure's federate handle set factory

getInteractionClassHandleFactory

public InteractionClassHandleFactory getInteractionClassHandleFactory()

Returns the run-time infrastructure's interaction class handle factory.

Specified by:: getInteractionClassHandleFactory in interface RTIambassador

Returns:: the run-time infrastructure's interaction class handle factory

getObjectClassHandleFactory

public ObjectClassHandleFactory getObjectClassHandleFactory()

Returns the run-time infrastructure's object class handle factory.

Specified by:: getObjectClassHandleFactory in interface RTIambassador

Returns:: the run-time infrastructure's object class handle factory

getObjectInstanceHandleFactory

public ObjectInstanceHandleFactory getObjectInstanceHandleFactory()

Returns the run-time infrastructure's object instance handle factory.

Specified by:: getObjectInstanceHandleFactory in interface RTIambassador

Returns:: the run-time infrastructure's object instance handle factory

getParameterHandleFactory

public ParameterHandleFactory getParameterHandleFactory()

Returns the run-time infrastructure's parameter handle factory.

Specified by:: getParameterHandleFactory in interface RTIambassador

Returns:: the run-time infrastructure's parameter handle factory

getParameterHandleValueMapFactory

public ParameterHandleValueMapFactory getParameterHandleValueMapFactory()

Returns the run-time infrastructure's parameter handle value map factory.

Specified by:: getParameterHandleValueMapFactory in interface RTIambassador

Returns:: the run-time infrastructure's parameter handle value map factory

getRegionHandleSetFactory

public RegionHandleSetFactory getRegionHandleSetFactory()

Returns the run-time infrastructure's region handle set factory.

Specified by:: getRegionHandleSetFactory in interface RTIambassador

Returns:: the run-time infrastructure's region handle set factory

initializeRTI

public java.util.Properties initializeRTI(java.util.Properties properties)
                                   throws InitializePreviouslyInvoked,
                                          BadInitializationParameter,
                                          RTIinternalError

Initializes the run-time infrastructure.

Specified by:: initializeRTI in interface RTIambassador

Parameters:: properties - the set of initialization parameters
Returns:: the set of return values
Throws:: InitializePreviouslyInvoked - if the run-time infrastructure was already initialized; BadInitializationParameter - if an initialization parameter was invalid; RTIinternalError - if an internal error occurred in the run-time infrastructure

createDescriptorManagerAndProxyAmbassadors

protected void createDescriptorManagerAndProxyAmbassadors()
                                                   throws RTIinternalError

Creates and initializes the descriptor manager and proxy ambassadors.

Throws:: RTIinternalError - if an error occurs

createMessageThreads

protected void createMessageThreads()

Creates and starts the threads that read incoming messages from the channel.

proxyAmbassador_receiveInteraction

protected void proxyAmbassador_receiveInteraction(InteractionClassHandle interactionClass,
                                                  ParameterHandleValueMap theParameters,
                                                  byte[] userSuppliedTag,
                                                  OrderType sentOrdering,
                                                  TransportationType theTransport,
                                                  LogicalTime theTime,
                                                  OrderType receivedOrdering)
                                           throws InteractionClassNotRecognized,
                                                  InteractionParameterNotRecognized,
                                                  InteractionClassNotSubscribed,
                                                  FederateInternalError

Calls the receiveInteraction() method of proxyAmbassador object.

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; theTime - the logical time associated with the interaction; receivedOrdering - the type of ordering with which the interaction was received (not used)
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

finalizeRTI

public void finalizeRTI()
                 throws InitializeNeverInvoked,
                        SomeFederateJoinedToAnExecution,
                        RTIinternalError

Finalizes the run-time infrastructure.

Specified by:: finalizeRTI in interface RTIambassador

Throws:: InitializeNeverInvoked - if the run-time infrastructure was never initialized; SomeFederateJoinedToAnExecution - if a federate is still participating in a federation execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

createFederationExecution

public void createFederationExecution(java.lang.String federationExecutionName,
                                      java.net.URL fdd)
                               throws FederationExecutionAlreadyExists,
                                      CouldNotOpenFDD,
                                      ErrorReadingFDD,
                                      RTIinternalError

Creates a new federation execution.

Specified by:: createFederationExecution in interface RTIambassador

Parameters:: federationExecutionName - the name of the new federation execution; fdd - the location of the federation description document
Throws:: FederationExecutionAlreadyExists - if the execution already exists; CouldNotOpenFDD - if the federation description document could not be opened; ErrorReadingFDD - if an error occurred while reading the federation description document; RTIinternalError - if an internal error occurred in the run-time infrastructure

destroyFederationExecution

public void destroyFederationExecution(java.lang.String federationExecutionName)
                                throws FederatesCurrentlyJoined,
                                       FederationExecutionDoesNotExist,
                                       RTIinternalError

Destroys a federation execution.

Specified by:: destroyFederationExecution in interface RTIambassador

Parameters:: federationExecutionName - the name of the federation execution to destroy
Throws:: FederatesCurrentlyJoined - if federates are still participating in the execution; FederationExecutionDoesNotExist - if the federation execution does not exist; RTIinternalError - if an internal error occurred in the run-time infrastructure

joinFederationExecution

public FederateHandle joinFederationExecution(java.lang.String federateType,
                                              java.lang.String federationExecutionName,
                                              FederateAmbassador federateReference,
                                              MobileFederateServices serviceReferences)
                                       throws FederateAlreadyExecutionMember,
                                              FederationExecutionDoesNotExist,
                                              SaveInProgress,
                                              RestoreInProgress,
                                              RTIinternalError

Joins a federation execution.

Specified by:: joinFederationExecution in interface RTIambassador

Parameters:: federateType - a string describing the federate's role in the federation; federationExecutionName - the name of the federation to join; federateReference - the federate ambassador object; serviceReferences - the federate's mobile services
Throws:: FederateAlreadyExecutionMember - if the federate is already a member of an execution; FederationExecutionDoesNotExist - if the federation execution does not exist; 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

resignFederationExecution

public void resignFederationExecution(ResignAction resignAction)
                               throws OwnershipAcquisitionPending,
                                      FederateOwnsAttributes,
                                      FederateNotExecutionMember,
                                      RTIinternalError

Resigns from the currently joined federation execution.

Specified by:: resignFederationExecution in interface RTIambassador

Parameters:: resignAction - the action to take upon resigning
Throws:: OwnershipAcquisitionPending - if an ownership acquisition operation is pending; FederateOwnsAttributes - if the federate still owns attributes; FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

mergeFDD

public void mergeFDD(java.net.URL fdd)
              throws CouldNotOpenFDD,
                     ErrorReadingFDD,
                     FederateNotExecutionMember,
                     SaveInProgress,
                     RestoreInProgress,
                     RTIinternalError

Merges the object model contained in the specified federation description document with the current federation object model.

Specified by:: mergeFDD in interface RTIambassadorEx

Parameters:: fdd - the location of the federation description document
Throws:: CouldNotOpenFDD - if the federation description document could not be opened; ErrorReadingFDD - if an error occurred while reading the federation description document; RTIinternalError - if an internal error occurred in the run-time infrastructure; FederateNotExecutionMember; SaveInProgress; RestoreInProgress

enableCallbacks

public void enableCallbacks()
                     throws FederateNotExecutionMember,
                            SaveInProgress,
                            RestoreInProgress,
                            RTIinternalError

Enables callbacks.

Specified by:: enableCallbacks in interface RTIambassador

Throws:: 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

disableCallbacks

public void disableCallbacks()
                      throws FederateNotExecutionMember,
                             SaveInProgress,
                             RestoreInProgress,
                             RTIinternalError

Disables callbacks.

Specified by:: disableCallbacks in interface RTIambassador

Throws:: 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

evokeCallback

public boolean evokeCallback(double seconds)
                      throws FederateNotExecutionMember,
                             RTIinternalError

Performs a callback, notifying the federate of a pending messages through the federate ambassador interface.

Specified by:: evokeCallback in interface RTIambassador

Parameters:: seconds - the number of seconds to wait before issuing the callback
Returns:: true if more messages are pending, false otherwise
Throws:: FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

evokeMultipleCallbacks

public boolean evokeMultipleCallbacks(double minimumTime,
                                      double maximumTime)
                               throws FederateNotExecutionMember,
                                      RTIinternalError

Performs multiple callbacks over a specified time period, notifying the federate of pending messages through the federate ambassador interface.

Specified by:: evokeMultipleCallbacks in interface RTIambassador

Parameters:: minimumTime - the number of seconds to wait before issuing the first callback; maximumTime - the maximum time to spend issuing callbacks
Returns:: true if more messages are pending, false otherwise
Throws:: FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

getObjectClassHandle

public ObjectClassHandle getObjectClassHandle(java.lang.String theName)
                                       throws NameNotFound,
                                              FederateNotExecutionMember,
                                              RTIinternalError

Returns the object class handle associated with the specified name.

Specified by:: getObjectClassHandle in interface RTIambassador

Parameters:: theName - the name of the object class
Returns:: the object class handle associated with the specified name
Throws:: NameNotFound - if the name was not found; FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

getObjectClassName

public java.lang.String getObjectClassName(ObjectClassHandle theHandle)
                                    throws InvalidObjectClassHandle,
                                           FederateNotExecutionMember,
                                           RTIinternalError

Returns the name of the specified object class.

Specified by:: getObjectClassName in interface RTIambassador

Parameters:: theHandle - the handle of the object class
Returns:: the name of the specified object class
Throws:: InvalidObjectClassHandle - if the object class handle is invalid; FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

getAttributeHandle

public AttributeHandle getAttributeHandle(ObjectClassHandle whichClass,
                                          java.lang.String theName)
                                   throws InvalidObjectClassHandle,
                                          NameNotFound,
                                          FederateNotExecutionMember,
                                          RTIinternalError

Returns the attribute handle associated with the specified name.

Specified by:: getAttributeHandle in interface RTIambassador

Parameters:: whichClass - the class with which the attribute is associated; theName - the name of the attribute
Returns:: the attribute handle associated with the specified name
Throws:: InvalidObjectClassHandle - if the object class handle is invalid; NameNotFound - if the name was not found; FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

getAttributeName

public java.lang.String getAttributeName(ObjectClassHandle whichClass,
                                         AttributeHandle theHandle)
                                  throws InvalidObjectClassHandle,
                                         InvalidAttributeHandle,
                                         AttributeNotDefined,
                                         FederateNotExecutionMember,
                                         RTIinternalError

Returns the name of the specified attribute.

Specified by:: getAttributeName in interface RTIambassador

Parameters:: whichClass - the class with which the attribute is associated; theHandle - the handle of the attribute
Returns:: the name of the specified attribute
Throws:: InvalidObjectClassHandle - if the object class handle is invalid; InvalidAttributeHandle - if the attribute handle is invalid; AttributeNotDefined - if the attribute is undefined; FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

getInteractionClassHandle

public InteractionClassHandle getInteractionClassHandle(java.lang.String theName)
                                                 throws NameNotFound,
                                                        FederateNotExecutionMember,
                                                        RTIinternalError

Returns the interaction handle associated with the specified name.

Specified by:: getInteractionClassHandle in interface RTIambassador

Parameters:: theName - the name of the interaction class
Returns:: the interaction class handle associated with the specified name
Throws:: NameNotFound - if the name was not found; FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

getInteractionClassName

public java.lang.String getInteractionClassName(InteractionClassHandle theHandle)
                                         throws InvalidInteractionClassHandle,
                                                FederateNotExecutionMember,
                                                RTIinternalError

Returns the name of the specified interaction class.

Specified by:: getInteractionClassName in interface RTIambassador

Parameters:: theHandle - the handle of the interaction class
Returns:: the name of the specified interaction class
Throws:: InvalidInteractionClassHandle - if the interaction class handle is invalid; FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

getParameterHandle

public ParameterHandle getParameterHandle(InteractionClassHandle whichClass,
                                          java.lang.String theName)
                                   throws InvalidInteractionClassHandle,
                                          NameNotFound,
                                          FederateNotExecutionMember,
                                          RTIinternalError

Returns the parameter handle associated with the specified name.

Specified by:: getParameterHandle in interface RTIambassador

Parameters:: whichClass - the interaction class with which the parameter is associated; theName - the name of the parameter
Returns:: the parameter handle associated with the specified name
Throws:: InvalidInteractionClassHandle - if the interaction class handle is invalid; NameNotFound - if the name was not found; FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

getParameterName

public java.lang.String getParameterName(InteractionClassHandle whichClass,
                                         ParameterHandle theHandle)
                                  throws InvalidInteractionClassHandle,
                                         InvalidParameterHandle,
                                         InteractionParameterNotDefined,
                                         FederateNotExecutionMember,
                                         RTIinternalError

Returns the name of the specified parameter.

Specified by:: getParameterName in interface RTIambassador

Parameters:: whichClass - the interaction class with which the parameter is associated; theHandle - the handle of the parameter
Returns:: the name of the specified parameter
Throws:: InvalidInteractionClassHandle - if the interaction class handle is invalid; InvalidParameterHandle - if the parameter handle is invalid; InteractionParameterNotDefined - if the parameter is undefined; FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

getObjectInstanceHandle

public ObjectInstanceHandle getObjectInstanceHandle(java.lang.String theName)
                                             throws ObjectInstanceNotKnown,
                                                    FederateNotExecutionMember,
                                                    RTIinternalError

Returns the object instance handle associated with the specified name.

Specified by:: getObjectInstanceHandle in interface RTIambassador

Parameters:: theName - the name of the object instance
Returns:: the object instance handle associated with the name
Throws:: ObjectInstanceNotKnown - if the object instance is unknown; FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

getObjectInstanceName

public java.lang.String getObjectInstanceName(ObjectInstanceHandle theHandle)
                                       throws ObjectInstanceNotKnown,
                                              FederateNotExecutionMember,
                                              RTIinternalError

Returns the name of the specified object instance.

Specified by:: getObjectInstanceName in interface RTIambassador

Parameters:: theHandle - the handle of the object instance
Returns:: the name of the specified object instance
Throws:: ObjectInstanceNotKnown - if the object instance is unknown; FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

getDimensionHandle

public DimensionHandle getDimensionHandle(java.lang.String theName)
                                   throws NameNotFound,
                                          FederateNotExecutionMember,
                                          RTIinternalError

Returns the dimension handle associated with the specified name.

Specified by:: getDimensionHandle in interface RTIambassador

Parameters:: theName - the name of the dimension handle
Returns:: the dimension handle associated with the specified name
Throws:: NameNotFound - if the name was not found; FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

getDimensionName

public java.lang.String getDimensionName(DimensionHandle theHandle)
                                  throws InvalidDimensionHandle,
                                         FederateNotExecutionMember,
                                         RTIinternalError

Returns the name associated with the specified dimension handle.

Specified by:: getDimensionName in interface RTIambassador

Parameters:: theHandle - the dimension handle
Returns:: the name associated with the specified dimension handle
Throws:: InvalidDimensionHandle - if the specified dimension handle is invalid; FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

getDimensionUpperBound

public long getDimensionUpperBound(DimensionHandle theHandle)
                            throws InvalidDimensionHandle,
                                   FederateNotExecutionMember,
                                   RTIinternalError

Returns the upper bound of the specified dimension.

Specified by:: getDimensionUpperBound in interface RTIambassador

Parameters:: theHandle - the dimension handle
Returns:: the upper bound of the specified dimension
Throws:: InvalidDimensionHandle - if the specified dimension handle is invalid; FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

getAvailableDimensionsForClassAttribute

public DimensionHandleSet getAvailableDimensionsForClassAttribute(ObjectClassHandle whichClass,
                                                                  AttributeHandle theHandle)
                                                           throws InvalidObjectClassHandle,
                                                                  InvalidAttributeHandle,
                                                                  AttributeNotDefined,
                                                                  FederateNotExecutionMember,
                                                                  RTIinternalError

Returns the set of available dimensions for a class attribute.

Specified by:: getAvailableDimensionsForClassAttribute in interface RTIambassador

Parameters:: whichClass - the object class with which the attribute is associated; theHandle - the attribute handle
Returns:: the set of available dimensions for the attribute
Throws:: InvalidObjectClassHandle - if the object class handle is invalid; InvalidAttributeHandle - if the attribute handle is invalid; AttributeNotDefined - if the attribute is undefined; FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

getKnownObjectClassHandle

public ObjectClassHandle getKnownObjectClassHandle(ObjectInstanceHandle theObject)
                                            throws ObjectInstanceNotKnown,
                                                   FederateNotExecutionMember,
                                                   RTIinternalError

Returns the class handle corresponding to the specified object.

Specified by:: getKnownObjectClassHandle in interface RTIambassador

Parameters:: theObject - the object handle
Returns:: the class handle corresponding to the specified object
Throws:: ObjectInstanceNotKnown - if the object instance is unknown; FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

getAvailableDimensionsForInteractionClass

public DimensionHandleSet getAvailableDimensionsForInteractionClass(InteractionClassHandle theHandle)
                                                             throws InvalidInteractionClassHandle,
                                                                    FederateNotExecutionMember,
                                                                    RTIinternalError

Returns the set of available dimensions for an interaction class.

Specified by:: getAvailableDimensionsForInteractionClass in interface RTIambassador

Parameters:: theHandle - the interaction class handle
Returns:: the set of available dimensions for the interaction class
Throws:: InvalidInteractionClassHandle - if the interaction class handle is invalid; FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

getTransportationType

public TransportationType getTransportationType(java.lang.String theName)
                                         throws InvalidTransportationName,
                                                FederateNotExecutionMember,
                                                RTIinternalError

Returns the transportation type corresponding to the specified name.

Specified by:: getTransportationType in interface RTIambassador

Parameters:: theName - the transportation type name
Returns:: the transportation type corresponding to the specified name
Throws:: InvalidTransportationName - if the transportation name is invalid; FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

getTransportationName

public java.lang.String getTransportationName(TransportationType theType)
                                       throws InvalidTransportationType,
                                              FederateNotExecutionMember,
                                              RTIinternalError

Returns the name corresponding to the specified transportation type.

Specified by:: getTransportationName in interface RTIambassador

Parameters:: theType - the transportation type
Returns:: the name corresponding to the specified transportation type
Throws:: InvalidTransportationType - if the transportation type is invalid; FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

getOrderType

public OrderType getOrderType(java.lang.String theName)
                       throws InvalidOrderName,
                              FederateNotExecutionMember,
                              RTIinternalError

Returns the order type corresponding to the specified name.

Specified by:: getOrderType in interface RTIambassador

Parameters:: theName - the order type name
Returns:: the order type corresponding to the specified name
Throws:: InvalidOrderName - if the order name is invalid; FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

getOrderName

public java.lang.String getOrderName(OrderType theType)
                              throws InvalidOrderType,
                                     FederateNotExecutionMember,
                                     RTIinternalError

Returns the name corresponding to the specified order type.

Specified by:: getOrderName in interface RTIambassador

Parameters:: theType - the order type
Returns:: the name corresponding to the specified order type
Throws:: InvalidOrderType - if the order type is invalid; FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

enableObjectClassRelevanceAdvisorySwitch

public void enableObjectClassRelevanceAdvisorySwitch()
                                              throws FederateNotExecutionMember,
                                                     ObjectClassRelevanceAdvisorySwitchIsOn,
                                                     SaveInProgress,
                                                     RestoreInProgress,
                                                     RTIinternalError

Enables the object class relevance advisory switch.

Specified by:: enableObjectClassRelevanceAdvisorySwitch in interface RTIambassador

Throws:: FederateNotExecutionMember - if the federate is not a member of an execution; ObjectClassRelevanceAdvisorySwitchIsOn - if the switch is already on; 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

disableObjectClassRelevanceAdvisorySwitch

public void disableObjectClassRelevanceAdvisorySwitch()
                                               throws ObjectClassRelevanceAdvisorySwitchIsOff,
                                                      FederateNotExecutionMember,
                                                      SaveInProgress,
                                                      RestoreInProgress,
                                                      RTIinternalError

Disables the object class relevance advisory switch.

Specified by:: disableObjectClassRelevanceAdvisorySwitch in interface RTIambassador

Throws:: FederateNotExecutionMember - if the federate is not a member of an execution; ObjectClassRelevanceAdvisorySwitchIsOff - if the switch is already off; 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

enableAttributeRelevanceAdvisorySwitch

public void enableAttributeRelevanceAdvisorySwitch()
                                            throws AttributeRelevanceAdvisorySwitchIsOn,
                                                   FederateNotExecutionMember,
                                                   SaveInProgress,
                                                   RestoreInProgress,
                                                   RTIinternalError

Enables the attribute relevance advisory switch.

Specified by:: enableAttributeRelevanceAdvisorySwitch in interface RTIambassador

Throws:: AttributeRelevanceAdvisorySwitchIsOn - if the switch is already on; 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

disableAttributeRelevanceAdvisorySwitch

public void disableAttributeRelevanceAdvisorySwitch()
                                             throws AttributeRelevanceAdvisorySwitchIsOff,
                                                    FederateNotExecutionMember,
                                                    SaveInProgress,
                                                    RestoreInProgress,
                                                    RTIinternalError

Disables the attribute relevance advisory switch.

Specified by:: disableAttributeRelevanceAdvisorySwitch in interface RTIambassador

Throws:: AttributeRelevanceAdvisorySwitchIsOff - if the switch is already off; 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

enableAttributeScopeAdvisorySwitch

public void enableAttributeScopeAdvisorySwitch()
                                        throws AttributeScopeAdvisorySwitchIsOn,
                                               FederateNotExecutionMember,
                                               SaveInProgress,
                                               RestoreInProgress,
                                               RTIinternalError

Enables the attribute scope advisory switch.

Specified by:: enableAttributeScopeAdvisorySwitch in interface RTIambassador

Throws:: AttributeScopeAdvisorySwitchIsOn - if the switch is already on; 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

disableAttributeScopeAdvisorySwitch

public void disableAttributeScopeAdvisorySwitch()
                                         throws AttributeScopeAdvisorySwitchIsOff,
                                                FederateNotExecutionMember,
                                                SaveInProgress,
                                                RestoreInProgress,
                                                RTIinternalError

Disables the attribute scope advisory switch.

Specified by:: disableAttributeScopeAdvisorySwitch in interface RTIambassador

Throws:: AttributeScopeAdvisorySwitchIsOff - if the switch is already off; 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

enableInteractionRelevanceAdvisorySwitch

public void enableInteractionRelevanceAdvisorySwitch()
                                              throws InteractionRelevanceAdvisorySwitchIsOn,
                                                     FederateNotExecutionMember,
                                                     SaveInProgress,
                                                     RestoreInProgress,
                                                     RTIinternalError

Enables the interaction relevance advisory switch.

Specified by:: enableInteractionRelevanceAdvisorySwitch in interface RTIambassador

Throws:: InteractionRelevanceAdvisorySwitchIsOn - if the switch is already on; 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

disableInteractionRelevanceAdvisorySwitch

public void disableInteractionRelevanceAdvisorySwitch()
                                               throws InteractionRelevanceAdvisorySwitchIsOff,
                                                      FederateNotExecutionMember,
                                                      SaveInProgress,
                                                      RestoreInProgress,
                                                      RTIinternalError

Disables the interaction relevance advisory switch.

Specified by:: disableInteractionRelevanceAdvisorySwitch in interface RTIambassador

Throws:: InteractionRelevanceAdvisorySwitchIsOff - if the switch is already off; 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

getDimensionHandleSet

public DimensionHandleSet getDimensionHandleSet(RegionHandle region)
                                         throws InvalidRegion,
                                                FederateNotExecutionMember,
                                                SaveInProgress,
                                                RestoreInProgress,
                                                RTIinternalError

Returns the dimension handle set corresponding to the specified region.

Specified by:: getDimensionHandleSet in interface RTIambassador

Parameters:: region - the region handle
Returns:: the dimension handle set corresponding to the specified region
Throws:: InvalidRegion - if the specified region is invalid; 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

getRangeBounds

public RangeBounds getRangeBounds(RegionHandle region,
                                  DimensionHandle dimension)
                           throws InvalidRegion,
                                  RegionDoesNotContainSpecifiedDimension,
                                  FederateNotExecutionMember,
                                  SaveInProgress,
                                  RestoreInProgress,
                                  RTIinternalError

Returns the range bounds on the specified region and dimension.

Specified by:: getRangeBounds in interface RTIambassador

Parameters:: region - the region handle; dimension - the dimension handle
Returns:: the range bounds on the specified region and dimension
Throws:: InvalidRegion - if the specified region is invalid; RegionDoesNotContainSpecifiedDimension - if the region does not contain the dimension; 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

setRangeBounds

public void setRangeBounds(RegionHandle region,
                           DimensionHandle dimension,
                           RangeBounds bounds)
                    throws InvalidRegion,
                           RegionNotCreatedByThisFederate,
                           RegionDoesNotContainSpecifiedDimension,
                           InvalidRangeBound,
                           FederateNotExecutionMember,
                           SaveInProgress,
                           RestoreInProgress,
                           RTIinternalError

Sets the range bounds on the specified region and dimension.

Specified by:: setRangeBounds in interface RTIambassador

Parameters:: region - the region handle; dimension - the dimension handle; bounds - the new set of range bounds
Throws:: InvalidRegion - if the specified region is invalid; RegionNotCreatedByThisFederate - if the specified region was not created by this federate; RegionDoesNotContainSpecifiedDimension - if the region does not contain the dimension; InvalidRangeBound - if one of the range bounds is invalid; 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

normalizeFederateHandle

public long normalizeFederateHandle(FederateHandle federateHandle)
                             throws InvalidFederateHandle,
                                    FederateNotExecutionMember,
                                    RTIinternalError

Normalizes a federate handle, returning it in its equivalent normalized form.

Specified by:: normalizeFederateHandle in interface RTIambassador

Parameters:: federateHandle - the federate handle to normalize
Returns:: the federate handle in its equivalent normalized form
Throws:: InvalidFederateHandle - if the supplied federate handle is invalid; FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

normalizeServiceGroup

public long normalizeServiceGroup(ServiceGroup group)
                           throws FederateNotExecutionMember,
                                  RTIinternalError

Normalizes a service group, returning it in its equivalent normalized form.

Specified by:: normalizeServiceGroup in interface RTIambassador

Parameters:: group - the service group to normalize
Returns:: the service group in its equivalent normalized form
Throws:: FederateNotExecutionMember - if the federate is not a member of an execution; RTIinternalError - if an internal error occurred in the run-time infrastructure

publishObjectClassAttributes

public void publishObjectClassAttributes(ObjectClassHandle theClass,
                                         AttributeHandleSet attributeList)
                                  throws ObjectClassNotDefined,
                                         AttributeNotDefined,
                                         FederateNotExecutionMember,
                                         SaveInProgress,
                                         RestoreInProgress,
                                         RTIinternalError

Publishes the specified object class attributes.

Specified by:: publishObjectClassAttributes in interface RTIambassador

Parameters:: theClass - the object class associated with the attributes to be published; attributeList - the list of attributes to publish
Throws:: ObjectClassNotDefined - if the specified object class is not defined; AttributeNotDefined - if one of the specified attributes 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 occurred in the run-time infrastructure

unpublishObjectClass

public void unpublishObjectClass(ObjectClassHandle theClass)
                          throws ObjectClassNotDefined,
                                 OwnershipAcquisitionPending,
                                 FederateNotExecutionMember,
                                 SaveInProgress,
                                 RestoreInProgress,
                                 RTIinternalError

Unpublishes the specified object class.

Specified by:: unpublishObjectClass in interface RTIambassador

Parameters:: theClass - the object class to unpublish
Throws:: ObjectClassNotDefined - if the specified object class is not defined; OwnershipAcquisitionPending - if an ownership acquisition operation is pending; 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

unpublishObjectClassAttributes

public void unpublishObjectClassAttributes(ObjectClassHandle theClass,
                                           AttributeHandleSet attributeList)
                                    throws ObjectClassNotDefined,
                                           AttributeNotDefined,
                                           OwnershipAcquisitionPending,
                                           FederateNotExecutionMember,
                                           SaveInProgress,
                                           RestoreInProgress,
                                           RTIinternalError

Unpublishes the specified object class attributes.

Specified by:: unpublishObjectClassAttributes in interface RTIambassador

Parameters:: theClass - the object class associated with the attributes to be unpublished; attributeList - the list of attributes to unpublish
Throws:: ObjectClassNotDefined - if the specified object class is not defined; AttributeNotDefined - if one of the specified attributes is not defined; OwnershipAcquisitionPending - if an ownership acquisition operation is pending; 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

publishInteractionClass

public void publishInteractionClass(InteractionClassHandle theInteraction)
                             throws InteractionClassNotDefined,
                                    FederateNotExecutionMember,
                                    SaveInProgress,
                                    RestoreInProgress,
                                    RTIinternalError

Publishes the specified interaction class.

Specified by:: publishInteractionClass in interface RTIambassador

Parameters:: theInteraction - the interaction class to publish
Throws:: InteractionClassNotDefined - if the specified interaction class 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 occurred in the run-time infrastructure

unpublishInteractionClass

public void unpublishInteractionClass(InteractionClassHandle theInteraction)
                               throws InteractionClassNotDefined,
                                      FederateNotExecutionMember,
                                      SaveInProgress,
                                      RestoreInProgress,
                                      RTIinternalError

Unpublishes the specified interaction class.

Specified by:: unpublishInteractionClass in interface RTIambassador

Parameters:: theInteraction - the interaction class to unpublish
Throws:: InteractionClassNotDefined - if the specified interaction class 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 occurred in the run-time infrastructure

subscribeObjectClassAttributes

public void subscribeObjectClassAttributes(ObjectClassHandle theClass,
                                           AttributeHandleSet attributeList)
                                    throws ObjectClassNotDefined,
                                           AttributeNotDefined,
                                           FederateNotExecutionMember,
                                           SaveInProgress,
                                           RestoreInProgress,
                                           RTIinternalError

Subscribes to a set of object class attributes.

Specified by:: subscribeObjectClassAttributes in interface RTIambassador

Parameters:: theClass - the object class associated with the attributes to subscribe to; attributeList - the set of attributes to subscribe to
Throws:: ObjectClassNotDefined - if the specified object class is not defined; AttributeNotDefined - if one of the specified attributes 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 occurred in the run-time infrastructure

subscribeObjectClassAttributesPassively

public void subscribeObjectClassAttributesPassively(ObjectClassHandle theClass,
                                                    AttributeHandleSet attributeList)
                                             throws ObjectClassNotDefined,
                                                    AttributeNotDefined,
                                                    FederateNotExecutionMember,
                                                    SaveInProgress,
                                                    RestoreInProgress,
                                                    RTIinternalError

Passively subscribes to a set of object class attributes.

Specified by:: subscribeObjectClassAttributesPassively in interface RTIambassador

Parameters:: theClass - the object class associated with the attributes to subscribe to; attributeList - the set of attributes to subscribe to
Throws:: ObjectClassNotDefined - if the specified object class is not defined; AttributeNotDefined - if one of the specified attributes 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 occurred in the run-time infrastructure

unsubscribeObjectClass

public void unsubscribeObjectClass(ObjectClassHandle theClass)
                            throws ObjectClassNotDefined,
                                   FederateNotExecutionMember,
                                   SaveInProgress,
                                   RestoreInProgress,
                                   RTIinternalError

Unsubscribes from an object class.

Specified by:: unsubscribeObjectClass in interface RTIambassador

Parameters:: theClass - the object class to unsubscribe from
Throws:: ObjectClassNotDefined - if the specified object class 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 occurred in the run-time infrastructure

unsubscribeObjectClassAttributes

public void unsubscribeObjectClassAttributes(ObjectClassHandle theClass,
                                             AttributeHandleSet attributeList)
                                      throws ObjectClassNotDefined,
                                             AttributeNotDefined,
                                             FederateNotExecutionMember,
                                             SaveInProgress,
                                             RestoreInProgress,
                                             RTIinternalError

Unsubscribes from a set of object class attributes.

Specified by:: unsubscribeObjectClassAttributes in interface RTIambassador

Parameters:: theClass - the object class associated with the attributes to unsubscribe from; attributeList - the set of attributes to unsubscribe from
Throws:: ObjectClassNotDefined - if the specified object class is not defined; AttributeNotDefined - if one of the specified attributes 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 occurred in the run-time infrastructure

subscribeInteractionClass

public void subscribeInteractionClass(InteractionClassHandle theClass)
                               throws InteractionClassNotDefined,
                                      FederateServiceInvocationsAreBeingReportedViaMOM,
                                      FederateNotExecutionMember,
                                      SaveInProgress,
                                      RestoreInProgress,
                                      RTIinternalError

Subscribes to the specified interaction class.

Specified by:: subscribeInteractionClass in interface RTIambassador

Parameters:: theClass - the interaction class to subscribe to
Throws:: InteractionClassNotDefined - if the 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

subscribeInteractionClassPassively

public void subscribeInteractionClassPassively(InteractionClassHandle theClass)
                                        throws InteractionClassNotDefined,
                                               FederateServiceInvocationsAreBeingReportedViaMOM,
                                               FederateNotExecutionMember,
                                               SaveInProgress,
                                               RestoreInProgress,
                                               RTIinternalError

Passively subscribes to the specified interaction class.

Specified by:: subscribeInteractionClassPassively in interface RTIambassador

Parameters:: theClass - the interaction class to subscribe to
Throws:: InteractionClassNotDefined - if the 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

unsubscribeInteractionClass

public void unsubscribeInteractionClass(InteractionClassHandle theClass)
                                 throws InteractionClassNotDefined,
                                        FederateNotExecutionMember,
                                        SaveInProgress,
                                        RestoreInProgress,
                                        RTIinternalError

Unsubscribes from the specified interaction class.

Specified by:: unsubscribeInteractionClass in interface RTIambassador

Parameters:: theClass - the interaction class to unsubscribe from
Throws:: InteractionClassNotDefined - if the interaction class 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 occurred in the run-time infrastructure

reserveObjectInstanceName

public void reserveObjectInstanceName(java.lang.String theObjectName)
                               throws IllegalName,
                                      FederateNotExecutionMember,
                                      SaveInProgress,
                                      RestoreInProgress,
                                      RTIinternalError

Reserves the specified object instance name.

Specified by:: reserveObjectInstanceName in interface RTIambassador

Parameters:: theObjectName - the object name to reserve
Throws:: IllegalName - if the name is invalid; 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

registerObjectInstance

public ObjectInstanceHandle registerObjectInstance(ObjectClassHandle theClass)
                                            throws ObjectClassNotDefined,
                                                   ObjectClassNotPublished,
                                                   FederateNotExecutionMember,
                                                   SaveInProgress,
                                                   RestoreInProgress,
                                                   RTIinternalError

Registers a new instance of the specified object class.

Specified by:: registerObjectInstance in interface RTIambassador

Parameters:: theClass - the class of the object to register
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

registerObjectInstance

public ObjectInstanceHandle registerObjectInstance(ObjectClassHandle theClass,
                                                   java.lang.String theObjectName)
                                            throws ObjectClassNotDefined,
                                                   ObjectClassNotPublished,
                                                   ObjectInstanceNameNotReserved,
                                                   ObjectInstanceNameInUse,
                                                   FederateNotExecutionMember,
                                                   SaveInProgress,
                                                   RestoreInProgress,
                                                   RTIinternalError

Registers a new instance of the specified object class.

Specified by:: registerObjectInstance in interface RTIambassador

Parameters:: theClass - the class of the object to register; theObjectName - the instance name for the new object
Throws:: ObjectClassNotDefined - if the specified object class is not defined; ObjectClassNotPublished - if the specified object class is not published; ObjectInstanceNameNotReserved - if the instance name has not been reserved; 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

updateAttributeValues

public void updateAttributeValues(ObjectInstanceHandle theObject,
                                  AttributeHandleValueMap theAttributes,
                                  byte[] userSuppliedTag)
                           throws ObjectInstanceNotKnown,
                                  AttributeNotDefined,
                                  AttributeNotOwned,
                                  FederateNotExecutionMember,
                                  SaveInProgress,
                                  RestoreInProgress,
                                  RTIinternalError

Updates the attribute values associated with an object.

Specified by:: updateAttributeValues in interface RTIambassador

Parameters:: theObject - the object whose attributes are to be updated; theAttributes - the attributes to update and their corresponding values; userSuppliedTag - a user-supplied tag to associate with the update
Throws:: ObjectInstanceNotKnown - if the object instance is unknown; AttributeNotDefined - if one of the attributes is undefined; AttributeNotOwned - if one of the attributes is not owned; 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

updateAttributeValues

public MessageRetractionReturn updateAttributeValues(ObjectInstanceHandle theObject,
                                                     AttributeHandleValueMap theAttributes,
                                                     byte[] userSuppliedTag,
                                                     LogicalTime theTime)
                                              throws ObjectInstanceNotKnown,
                                                     AttributeNotDefined,
                                                     AttributeNotOwned,
                                                     InvalidLogicalTime,
                                                     FederateNotExecutionMember,
                                                     SaveInProgress,
                                                     RestoreInProgress,
                                                     RTIinternalError

Updates the attribute values associated with an object.

Specified by:: updateAttributeValues in interface RTIambassador

Parameters:: theObject - the object whose attributes are to be updated; theAttributes - the attributes to update and their corresponding values; userSuppliedTag - a user-supplied tag to associate with the update; theTime - the logical time associated with the update
Throws:: ObjectInstanceNotKnown - if the object instance is unknown; AttributeNotDefined - if one of the attributes is undefined; AttributeNotOwned - if one of the attributes is not owned; InvalidLogicalTime - if the supplied logical time is invalid; 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

sendInteractionReliable

protected void sendInteractionReliable(InteractionClassHandle theInteraction,
                                       ParameterHandleValueMap theParameters,
                                       byte[] userSuppliedTag,
                                       OrderType sentOrdering,
                                       LogicalTime theTime)
                                throws InteractionClassNotPublished,
                                       InteractionClassNotDefined,
                                       InteractionParameterNotDefined,
                                       FederateNotExecutionMember,
                                       SaveInProgress,
                                       RestoreInProgress,
                                       RTIinternalError

Sends an interaction with reliable transportation.

Parameters:: theInteraction - the class of interaction to send; theParameters - the parameters of the interaction; userSuppliedTag - a user-supplied tag to associate with the interaction; sentOrdering - the type of ordering with which the interaction was sent; theTime - the logical time associated with the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is undefined; InteractionParameterNotDefined - if one of the parameters is undefined; 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

sendInteractionBestEffort

protected void sendInteractionBestEffort(InteractionClassHandle theInteraction,
                                         ParameterHandleValueMap theParameters,
                                         byte[] userSuppliedTag,
                                         OrderType sentOrdering,
                                         LogicalTime theTime)
                                  throws InteractionClassNotPublished,
                                         InteractionClassNotDefined,
                                         InteractionParameterNotDefined,
                                         FederateNotExecutionMember,
                                         SaveInProgress,
                                         RestoreInProgress,
                                         RTIinternalError

Sends an interaction with best-effort transportation.

Parameters:: theInteraction - the class of interaction to send; theParameters - the parameters of the interaction; userSuppliedTag - a user-supplied tag to associate with the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is undefined; InteractionParameterNotDefined - if one of the parameters is undefined; 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

sendInteraction

public void sendInteraction(InteractionClassHandle theInteraction,
                            ParameterHandleValueMap theParameters,
                            byte[] userSuppliedTag)
                     throws InteractionClassNotPublished,
                            InteractionClassNotDefined,
                            InteractionParameterNotDefined,
                            FederateNotExecutionMember,
                            SaveInProgress,
                            RestoreInProgress,
                            RTIinternalError

Sends an interaction.

Specified by:: sendInteraction in interface RTIambassador

Parameters:: theInteraction - the class of interaction to send; theParameters - the parameters of the interaction; userSuppliedTag - a user-supplied tag to associate with the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is undefined; InteractionParameterNotDefined - if one of the parameters is undefined; 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

sendInteraction

public MessageRetractionReturn sendInteraction(InteractionClassHandle theInteraction,
                                               ParameterHandleValueMap theParameters,
                                               byte[] userSuppliedTag,
                                               LogicalTime theTime)
                                        throws InteractionClassNotPublished,
                                               InteractionClassNotDefined,
                                               InteractionParameterNotDefined,
                                               InvalidLogicalTime,
                                               FederateNotExecutionMember,
                                               SaveInProgress,
                                               RestoreInProgress,
                                               RTIinternalError

Sends an interaction.

Specified by:: sendInteraction in interface RTIambassador

Parameters:: theInteraction - the class of interaction to send; theParameters - the parameters of the interaction; userSuppliedTag - a user-supplied tag to associate with the interaction; theTime - the logical time associated with the interaction
Throws:: InteractionClassNotPublished - if the interaction class is not published; InteractionClassNotDefined - if the interaction class is undefined; InteractionParameterNotDefined - if one of the parameters is undefined; InvalidLogicalTime - if the supplied logical time is invalid; 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

deleteObjectInstance

public void deleteObjectInstance(ObjectInstanceHandle objectHandle,
                                 byte[] userSuppliedTag)
                          throws DeletePrivilegeNotHeld,
                                 ObjectInstanceNotKnown,
                                 FederateNotExecutionMember,
                                 SaveInProgress,
                                 RestoreInProgress,
                                 RTIinternalError

Deletes the specified object instance.

Specified by:: deleteObjectInstance in interface RTIambassador

Parameters:: objectHandle - the object to delete; userSuppliedTag - a user-supplied tag to associate with the operation
Throws:: DeletePrivilegeNotHeld - if the delete privilege is not held; ObjectInstanceNotKnown - if the object instance is unknown; 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

deleteObjectInstance

public MessageRetractionReturn deleteObjectInstance(ObjectInstanceHandle objectHandle,
                                                    byte[] userSuppliedTag,
                                                    LogicalTime theTime)
                                             throws DeletePrivilegeNotHeld,
                                                    ObjectInstanceNotKnown,
                                                    InvalidLogicalTime,
                                                    FederateNotExecutionMember,
                                                    SaveInProgress,
                                                    RestoreInProgress,
                                                    RTIinternalError

Deletes the specified object instance.

Specified by:: deleteObjectInstance in interface RTIambassador

Parameters:: objectHandle - the object to delete; userSuppliedTag - a user-supplied tag to associate with the operation; theTime - the logical time associated with the delete operation
Throws:: DeletePrivilegeNotHeld - if the delete privilege is not held; ObjectInstanceNotKnown - if the object instance is unknown; InvalidLogicalTime - if the supplied logical time is invalid; 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

localDeleteObjectInstance

public void localDeleteObjectInstance(ObjectInstanceHandle objectHandle)
                               throws ObjectInstanceNotKnown,
                                      FederateOwnsAttributes,
                                      OwnershipAcquisitionPending,
                                      FederateNotExecutionMember,
                                      SaveInProgress,
                                      RestoreInProgress,
                                      RTIinternalError

Deletes the specified object instance locally.

Specified by:: localDeleteObjectInstance in interface RTIambassador

Parameters:: objectHandle - the object to delete
Throws:: ObjectInstanceNotKnown - if the object instance is unknown; FederateOwnsAttributes - if the federate owns attributes of the object; OwnershipAcquisitionPending - if an ownership acquisition operation is pending; 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

changeAttributeTransportationType

public void changeAttributeTransportationType(ObjectInstanceHandle theObject,
                                              AttributeHandleSet theAttributes,
                                              TransportationType theType)
                                       throws ObjectInstanceNotKnown,
                                              AttributeNotDefined,
                                              AttributeNotOwned,
                                              FederateNotExecutionMember,
                                              SaveInProgress,
                                              RestoreInProgress,
                                              RTIinternalError

Changes the transportation type associated with a set of attributes.

Specified by:: changeAttributeTransportationType in interface RTIambassador

Parameters:: theObject - the object with which the attributes are associated; theAttributes - the attributes to modify; theType - the new transportation type
Throws:: ObjectInstanceNotKnown - if the object instance is unknown; AttributeNotDefined - if one of the attributes is undefined; AttributeNotOwned - if one of the attributes is not owned; 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

changeInteractionTransportationType

public void changeInteractionTransportationType(InteractionClassHandle theClass,
                                                TransportationType theType)
                                         throws InteractionClassNotDefined,
                                                InteractionClassNotPublished,
                                                FederateNotExecutionMember,
                                                SaveInProgress,
                                                RestoreInProgress,
                                                RTIinternalError

Changes the transporation type associated with an interaction class.

Specified by:: changeInteractionTransportationType in interface RTIambassador

Parameters:: theClass - the interaction class to modify; theType - the new transportation type
Throws:: InteractionClassNotDefined - if the interaction class is undefined; InteractionClassNotPublished - if the interaction class is unpublished; 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

requestAttributeValueUpdate

public void requestAttributeValueUpdate(ObjectInstanceHandle theObject,
                                        AttributeHandleSet theAttributes,
                                        byte[] userSuppliedTag)
                                 throws ObjectInstanceNotKnown,
                                        AttributeNotDefined,
                                        FederateNotExecutionMember,
                                        SaveInProgress,
                                        RestoreInProgress,
                                        RTIinternalError

Requests an attribute value update.

Specified by:: requestAttributeValueUpdate in interface RTIambassador

Parameters:: theObject - the object with which the attributes are associated; theAttributes - the set of attributes to be updated; userSuppliedTag - a user-supplied tag to associated with the request
Throws:: ObjectInstanceNotKnown - if the object instance is unknown; AttributeNotDefined - if one of the attributes is undefined; 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

requestAttributeValueUpdate

public void requestAttributeValueUpdate(ObjectClassHandle theClass,
                                        AttributeHandleSet theAttributes,
                                        byte[] userSuppliedTag)
                                 throws ObjectClassNotDefined,
                                        AttributeNotDefined,
                                        FederateNotExecutionMember,
                                        SaveInProgress,
                                        RestoreInProgress,
                                        RTIinternalError

Requests an attribute value update.

Specified by:: requestAttributeValueUpdate in interface RTIambassador

Parameters:: theClass - the class of objects with which the attributes are associated; theAttributes - the set of attributes to be updated; userSuppliedTag - a user-supplied tag to associated with the request
Throws:: ObjectClassNotDefined - if the specified object class is undefined; AttributeNotDefined - if one of the attributes is undefined; 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

unconditionalAttributeOwnershipDivestiture

public void unconditionalAttributeOwnershipDivestiture(ObjectInstanceHandle theObject,
                                                       AttributeHandleSet theAttributes)
                                                throws ObjectInstanceNotKnown,
                                                       AttributeNotDefined,
                                                       AttributeNotOwned,
                                                       FederateNotExecutionMember,
                                                       SaveInProgress,
                                                       RestoreInProgress,
                                                       RTIinternalError

Unconditionally divests ownership of a set of attributes.

Specified by:: unconditionalAttributeOwnershipDivestiture in interface RTIambassador

Parameters:: theObject - the object with which the attributes are associated; theAttributes - the set of attributes to divest ownership of
Throws:: ObjectInstanceNotKnown - if the object instance is unknown; AttributeNotDefined - if one of the attributes is undefined; AttributeNotOwned - if one of the attributes is not owned; 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

negotiatedAttributeOwnershipDivestiture

public void negotiatedAttributeOwnershipDivestiture(ObjectInstanceHandle theObject,
                                                    AttributeHandleSet theAttributes,
                                                    byte[] userSuppliedTag)
                                             throws ObjectInstanceNotKnown,
                                                    AttributeNotDefined,
                                                    AttributeNotOwned,
                                                    AttributeAlreadyBeingDivested,
                                                    FederateNotExecutionMember,
                                                    SaveInProgress,
                                                    RestoreInProgress,
                                                    RTIinternalError

Performs a negotiated divestiture of ownership of a set of attributes.

Specified by:: negotiatedAttributeOwnershipDivestiture in interface RTIambassador

Parameters:: theObject - the object with which the attributes are associated; theAttributes - the set of attributes to divest ownership of; userSuppliedTag - a user-supplied tag to associate with the action
Throws:: ObjectInstanceNotKnown - if the object instance is unknown; AttributeNotDefined - if one of the attributes is undefined; AttributeNotOwned - if one of the attributes is not owned; AttributeAlreadyBeingDivested - if one of the attributes is already being divested; 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

confirmDivestiture

public void confirmDivestiture(ObjectInstanceHandle theObject,
                               AttributeHandleSet theAttributes,
                               byte[] userSuppliedTag)
                        throws ObjectInstanceNotKnown,
                               AttributeNotDefined,
                               AttributeNotOwned,
                               AttributeDivestitureWasNotRequested,
                               FederateNotExecutionMember,
                               SaveInProgress,
                               RestoreInProgress,
                               RTIinternalError

Confirms divestiture of ownership of a set of attributes.

Specified by:: confirmDivestiture in interface RTIambassador

Parameters:: theObject - the object with which the attributes are associated; theAttributes - the set of attributes to confirm divestiture of ownership of; userSuppliedTag - a user-supplied tag to associate with the action
Throws:: ObjectInstanceNotKnown - if the object instance is unknown; AttributeNotDefined - if one of the attributes is undefined; AttributeNotOwned - if one of the attributes is not owned; AttributeDivestitureWasNotRequested - if attribute divestiture was not requested; 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

attributeOwnershipAcquisition

public void attributeOwnershipAcquisition(ObjectInstanceHandle theObject,
                                          AttributeHandleSet desiredAttributes,
                                          byte[] userSuppliedTag)
                                   throws ObjectInstanceNotKnown,
                                          ObjectClassNotPublished,
                                          AttributeNotDefined,
                                          AttributeNotPublished,
                                          FederateOwnsAttributes,
                                          FederateNotExecutionMember,
                                          SaveInProgress,
                                          RestoreInProgress,
                                          RTIinternalError

Acquires ownership of a set of attributes.

Specified by:: attributeOwnershipAcquisition in interface RTIambassador

Parameters:: theObject - the object with which the attributes are associated; desiredAttributes - the set of attributes to acquire; userSuppliedTag - a user-supplied tag to associate with the action
Throws:: ObjectInstanceNotKnown - if the object instance is unknown; ObjectClassNotPublished - if the object class is not published; AttributeNotDefined - if one of the attributes is undefined; AttributeNotPublished - if one of the attributes is not published; FederateOwnsAttributes - if the federate already owns the attributes; 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

attributeOwnershipAcquisitionIfAvailable

public void attributeOwnershipAcquisitionIfAvailable(ObjectInstanceHandle theObject,
                                                     AttributeHandleSet desiredAttributes)
                                              throws ObjectInstanceNotKnown,
                                                     ObjectClassNotPublished,
                                                     AttributeNotDefined,
                                                     AttributeNotPublished,
                                                     FederateOwnsAttributes,
                                                     AttributeAlreadyBeingAcquired,
                                                     FederateNotExecutionMember,
                                                     SaveInProgress,
                                                     RestoreInProgress,
                                                     RTIinternalError

Acquires ownership of a set of attributes if they are available.

Specified by:: attributeOwnershipAcquisitionIfAvailable in interface RTIambassador

Parameters:: theObject - the object with which the attributes are associated; desiredAttributes - the set of attributes to acquire
Throws:: ObjectInstanceNotKnown - if the object instance is unknown; ObjectClassNotPublished - if the object class is not published; AttributeNotDefined - if one of the attributes is undefined; AttributeNotPublished - if one of the attributes is not published; FederateOwnsAttributes - if the federate already owns the attributes; AttributeAlreadyBeingAcquired - if one of the attributes is already being acquired; 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

attributeOwnershipDivestitureIfWanted

public AttributeHandleSet attributeOwnershipDivestitureIfWanted(ObjectInstanceHandle theObject,
                                                                AttributeHandleSet theAttributes)
                                                         throws ObjectInstanceNotKnown,
                                                                AttributeNotDefined,
                                                                AttributeNotOwned,
                                                                FederateNotExecutionMember,
                                                                SaveInProgress,
                                                                RestoreInProgress,
                                                                RTIinternalError

Divests ownership of a set of attributes if wanted.

Specified by:: attributeOwnershipDivestitureIfWanted in interface RTIambassador

Parameters:: theObject - the object with which the attributes are associated; theAttributes - the set of attributes to divest ownership of
Throws:: ObjectInstanceNotKnown - if the object instance is unknown; AttributeNotDefined - if one of the attributes is undefined; AttributeNotOwned - if one of the attributes is not owned; 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

cancelNegotiatedAttributeOwnershipDivestiture

public void cancelNegotiatedAttributeOwnershipDivestiture(ObjectInstanceHandle theObject,
                                                          AttributeHandleSet theAttributes)
                                                   throws ObjectInstanceNotKnown,
                                                          AttributeNotDefined,
                                                          AttributeNotOwned,
                                                          AttributeDivestitureWasNotRequested,
                                                          FederateNotExecutionMember,
                                                          SaveInProgress,
                                                          RestoreInProgress,
                                                          RTIinternalError

Cancels a negotiated divestiture of ownership of a set of attributes.

Specified by:: cancelNegotiatedAttributeOwnershipDivestiture in interface RTIambassador

Parameters:: theObject - the object with which the attributes are associated; theAttributes - the set of attributes to divest ownership of
Throws:: ObjectInstanceNotKnown - if the object instance is unknown; AttributeNotDefined - if one of the attributes is undefined; AttributeNotOwned - if one of the attributes is not owned; AttributeDivestitureWasNotRequested - if attribute divestiture was not requested; 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

cancelAttributeOwnershipAcquisition

public void cancelAttributeOwnershipAcquisition(ObjectInstanceHandle theObject,
                                                AttributeHandleSet theAttributes)
                                         throws ObjectInstanceNotKnown,
                                                AttributeNotDefined,
                                                AttributeAlreadyOwned,
                                                AttributeAcquisitionWasNotRequested,
                                                FederateNotExecutionMember,
                                                SaveInProgress,
                                                RestoreInProgress,
                                                RTIinternalError

Cancels the acquisition of ownership of a set of attributes.

Specified by:: cancelAttributeOwnershipAcquisition in interface RTIambassador

Parameters:: theObject - the object with which the attributes are associated; theAttributes - the set of attributes to divest ownership of
Throws:: ObjectInstanceNotKnown - if the object instance is unknown; AttributeNotDefined - if one of the attributes is undefined; AttributeAlreadyOwned - if one of the attributes is already owned; AttributeAcquisitionWasNotRequested - if attribute acquisition was not requested; 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

queryAttributeOwnership

public void queryAttributeOwnership(ObjectInstanceHandle theObject,
                                    AttributeHandle theAttribute)
                             throws ObjectInstanceNotKnown,
                                    AttributeNotDefined,
                                    FederateNotExecutionMember,
                                    SaveInProgress,
                                    RestoreInProgress,
                                    RTIinternalError

Requests information concerning the ownership of an attribute.

Specified by:: queryAttributeOwnership in interface RTIambassador

Parameters:: theObject - the object with which the attribute is associated; theAttribute - the attribute of interest
Throws:: ObjectInstanceNotKnown - if the object instance is unknown; AttributeNotDefined - if the attribute is undefined; 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

isAttributeOwnedByFederate

public boolean isAttributeOwnedByFederate(ObjectInstanceHandle theObject,
                                          AttributeHandle theAttribute)
                                   throws ObjectInstanceNotKnown,
                                          AttributeNotDefined,
                                          FederateNotExecutionMember,
                                          SaveInProgress,
                                          RestoreInProgress,
                                          RTIinternalError

Checks whether a specified attribute is owned by the federate.

Specified by:: isAttributeOwnedByFederate in interface RTIambassador

Parameters:: theObject - the object with which the attribute is associated; theAttribute - the attribute of interest
Returns:: true if the federate owns the specified attribute, false otherwise
Throws:: ObjectInstanceNotKnown - if the object instance is unknown; AttributeNotDefined - if the attribute is undefined; 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

enableTimeRegulation

public void enableTimeRegulation(LogicalTimeInterval theLookahead)
                          throws TimeRegulationAlreadyEnabled,
                                 InvalidLookahead,
                                 InTimeAdvancingState,
                                 RequestForTimeRegulationPending,
                                 FederateNotExecutionMember,
                                 SaveInProgress,
                                 RestoreInProgress,
                                 RTIinternalError

Enables time regulation.

Specified by:: enableTimeRegulation in interface RTIambassador

Parameters:: theLookahead - the amount of lookahead to use
Throws:: TimeRegulationAlreadyEnabled - if time regulation is already enabled; InvalidLookahead - if the specified amount of lookahead is invalid; InTimeAdvancingState - if the federation is in a time-advancing state; RequestForTimeRegulationPending - if a request for time regulation is pending; 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

disableTimeRegulation

public void disableTimeRegulation()
                           throws TimeRegulationIsNotEnabled,
                                  FederateNotExecutionMember,
                                  SaveInProgress,
                                  RestoreInProgress,
                                  RTIinternalError

Disables time regulation.

Specified by:: disableTimeRegulation in interface RTIambassador

Throws:: TimeRegulationIsNotEnabled - if time regulation is already disabled; 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

enableTimeConstrained

public void enableTimeConstrained()
                           throws TimeConstrainedAlreadyEnabled,
                                  InTimeAdvancingState,
                                  RequestForTimeConstrainedPending,
                                  FederateNotExecutionMember,
                                  SaveInProgress,
                                  RestoreInProgress,
                                  RTIinternalError

Enables time-constrained mode.

Specified by:: enableTimeConstrained in interface RTIambassador

Throws:: TimeConstrainedAlreadyEnabled - if time-constrained mode is already enabled; InTimeAdvancingState - if the federation is in a time-advancing state; RequestForTimeConstrainedPending - if a request for time-constrained mode is pending; 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

disableTimeConstrained

public void disableTimeConstrained()
                            throws TimeConstrainedIsNotEnabled,
                                   FederateNotExecutionMember,
                                   SaveInProgress,
                                   RestoreInProgress,
                                   RTIinternalError

Disables time-constrained mode.

Specified by:: disableTimeConstrained in interface RTIambassador

Throws:: TimeConstrainedIsNotEnabled - if time-constrained mode is already disabled; 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

timeAdvanceRequest

public void timeAdvanceRequest(LogicalTime theTime)
                        throws InvalidLogicalTime,
                               LogicalTimeAlreadyPassed,
                               InTimeAdvancingState,
                               RequestForTimeRegulationPending,
                               RequestForTimeConstrainedPending,
                               FederateNotExecutionMember,
                               SaveInProgress,
                               RestoreInProgress,
                               RTIinternalError

Requests a time advance.

Specified by:: timeAdvanceRequest in interface RTIambassador

Parameters:: theTime - the new logical time
Throws:: InvalidLogicalTime - if the specified logical time is invalid; LogicalTimeAlreadyPassed - if the specified logical time already passed; InTimeAdvancingState - if the federation is in a time-advancing state; RequestForTimeRegulationPending - if a request for time regulation is pending; RequestForTimeConstrainedPending - if a request for time-constrained mode is pending; 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

timeAdvanceRequestAvailable

public void timeAdvanceRequestAvailable(LogicalTime theTime)
                                 throws InvalidLogicalTime,
                                        LogicalTimeAlreadyPassed,
                                        InTimeAdvancingState,
                                        RequestForTimeRegulationPending,
                                        RequestForTimeConstrainedPending,
                                        FederateNotExecutionMember,
                                        SaveInProgress,
                                        RestoreInProgress,
                                        RTIinternalError

Requests a time advance if available.

Specified by:: timeAdvanceRequestAvailable in interface RTIambassador

Parameters:: theTime - the new logical time
Throws:: InvalidLogicalTime - if the specified logical time is invalid; LogicalTimeAlreadyPassed - if the specified logical time already passed; InTimeAdvancingState - if the federation is in a time-advancing state; RequestForTimeRegulationPending - if a request for time regulation is pending; RequestForTimeConstrainedPending - if a request for time-constrained mode is pending; 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

nextMessageRequest

public void nextMessageRequest(LogicalTime theTime)
                        throws InvalidLogicalTime,
                               LogicalTimeAlreadyPassed,
                               InTimeAdvancingState,
                               RequestForTimeRegulationPending,
                               RequestForTimeConstrainedPending,
                               FederateNotExecutionMember,
                               SaveInProgress,
                               RestoreInProgress,
                               RTIinternalError

Requests the next message.

Specified by:: nextMessageRequest in interface RTIambassador

Parameters:: theTime - the new logical time
Throws:: InvalidLogicalTime - if the specified logical time is invalid; LogicalTimeAlreadyPassed - if the specified logical time already passed; InTimeAdvancingState - if the federation is in a time-advancing state; RequestForTimeRegulationPending - if a request for time regulation is pending; RequestForTimeConstrainedPending - if a request for time-constrained mode is pending; 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

nextMessageRequestAvailable

public void nextMessageRequestAvailable(LogicalTime theTime)
                                 throws InvalidLogicalTime,
                                        LogicalTimeAlreadyPassed,
                                        InTimeAdvancingState,
                                        RequestForTimeRegulationPending,
                                        RequestForTimeConstrainedPending,
                                        FederateNotExecutionMember,
                                        SaveInProgress,
                                        RestoreInProgress,
                                        RTIinternalError

Requests the next message if available.

Specified by:: nextMessageRequestAvailable in interface RTIambassador

Parameters:: theTime - the new logical time
Throws:: InvalidLogicalTime - if the specified logical time is invalid; LogicalTimeAlreadyPassed - if the specified logical time already passed; InTimeAdvancingState - if the federation is in a time-advancing state; RequestForTimeRegulationPending - if a request for time regulation is pending; RequestForTimeConstrainedPending - if a request for time-constrained mode is pending; 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

flushQueueRequest

public void flushQueueRequest(LogicalTime theTime)
                       throws InvalidLogicalTime,
                              LogicalTimeAlreadyPassed,
                              InTimeAdvancingState,
                              RequestForTimeRegulationPending,
                              RequestForTimeConstrainedPending,
                              FederateNotExecutionMember,
                              SaveInProgress,
                              RestoreInProgress,
                              RTIinternalError

Requests a queue flush.

Specified by:: flushQueueRequest in interface RTIambassador

Parameters:: theTime - the logical time
Throws:: InvalidLogicalTime - if the specified logical time is invalid; LogicalTimeAlreadyPassed - if the specified logical time already passed; InTimeAdvancingState - if the federation is in a time-advancing state; RequestForTimeRegulationPending - if a request for time regulation is pending; RequestForTimeConstrainedPending - if a request for time-constrained mode is pending; 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

enableAsynchronousDelivery

public void enableAsynchronousDelivery()
                                throws AsynchronousDeliveryAlreadyEnabled,
                                       FederateNotExecutionMember,
                                       SaveInProgress,
                                       RestoreInProgress,
                                       RTIinternalError

Enables asynchronous delivery.

Specified by:: enableAsynchronousDelivery in interface RTIambassador

Throws:: AsynchronousDeliveryAlreadyEnabled - if asynchronous delivery is already enabled; 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

disableAsynchronousDelivery

public void disableAsynchronousDelivery()
                                 throws AsynchronousDeliveryAlreadyDisabled,
                                        FederateNotExecutionMember,
                                        SaveInProgress,
                                        RestoreInProgress,
                                        RTIinternalError

Disables asynchronous delivery.

Specified by:: disableAsynchronousDelivery in interface RTIambassador

Throws:: AsynchronousDeliveryAlreadyDisabled - if asynchronous delivery is already disabled; 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

queryGALT

public TimeQueryReturn queryGALT()
                          throws FederateNotExecutionMember,
                                 SaveInProgress,
                                 RestoreInProgress,
                                 RTIinternalError

Queries the greatest available logical time.

Specified by:: queryGALT in interface RTIambassador

Returns:: the greatest available logical time
Throws:: 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

queryLogicalTime

public LogicalTime queryLogicalTime()
                             throws FederateNotExecutionMember,
                                    SaveInProgress,
                                    RestoreInProgress,
                                    RTIinternalError

Queries the current logical time.

Specified by:: queryLogicalTime in interface RTIambassador

Returns:: the current logical time
Throws:: 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

queryLITS

public TimeQueryReturn queryLITS()
                          throws FederateNotExecutionMember,
                                 SaveInProgress,
                                 RestoreInProgress,
                                 RTIinternalError

Queries the least incoming time stamp.

Specified by:: queryLITS in interface RTIambassador

Returns:: the least incoming time stamp
Throws:: 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

modifyLookahead

public void modifyLookahead(LogicalTimeInterval theLookahead)
                     throws TimeRegulationIsNotEnabled,
                            InvalidLookahead,
                            InTimeAdvancingState,
                            FederateNotExecutionMember,
                            SaveInProgress,
                            RestoreInProgress,
                            RTIinternalError

Modifies the lookahead interval.

Specified by:: modifyLookahead in interface RTIambassador

Parameters:: theLookahead - the new lookahead interval.
Throws:: TimeRegulationIsNotEnabled - if time regulation is not enabled; InvalidLookahead - if the specified lookahead interval is invalid; InTimeAdvancingState - if the federation is in a time-advancing state; 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

queryLookahead

public LogicalTimeInterval queryLookahead()
                                   throws TimeRegulationIsNotEnabled,
                                          FederateNotExecutionMember,
                                          SaveInProgress,
                                          RestoreInProgress,
                                          RTIinternalError

Queries the lookahead interval.

Specified by:: queryLookahead in interface RTIambassador

Returns:: the lookahead interval
Throws:: TimeRegulationIsNotEnabled - if time regulation is not enabled; 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

retract

public void retract(MessageRetractionHandle theHandle)
             throws InvalidMessageRetractionHandle,
                    TimeRegulationIsNotEnabled,
                    MessageCanNoLongerBeRetracted,
                    FederateNotExecutionMember,
                    SaveInProgress,
                    RestoreInProgress,
                    RTIinternalError

Retracts a message.

Specified by:: retract in interface RTIambassador

Parameters:: theHandle - the handle of the message to retract
Throws:: InvalidMessageRetractionHandle - if the message retraction handle is invalid; TimeRegulationIsNotEnabled - if time regulation is not enabled; MessageCanNoLongerBeRetracted - if the message can no longer be retracted; 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

changeAttributeOrderType

public void changeAttributeOrderType(ObjectInstanceHandle theObject,
                                     AttributeHandleSet theAttributes,
                                     OrderType theType)
                              throws ObjectInstanceNotKnown,
                                     AttributeNotDefined,
                                     AttributeNotOwned,
                                     FederateNotExecutionMember,
                                     SaveInProgress,
                                     RestoreInProgress,
                                     RTIinternalError

Changes the order type of a set of attributes.

Specified by:: changeAttributeOrderType in interface RTIambassador

Parameters:: theObject - the object with which the attributes are associated; theAttributes - the set of attributes to modify; theType - the new order type
Throws:: ObjectInstanceNotKnown - if the specified object instance is unknown; AttributeNotDefined - if one of the attributes is undefined; AttributeNotOwned - if one of the attributes is not owned; 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

changeInteractionOrderType

public void changeInteractionOrderType(InteractionClassHandle theClass,
                                       OrderType theType)
                                throws InteractionClassNotDefined,
                                       InteractionClassNotPublished,
                                       FederateNotExecutionMember,
                                       SaveInProgress,
                                       RestoreInProgress,
                                       RTIinternalError

Changes the order type of a class of interactions.

Specified by:: changeInteractionOrderType in interface RTIambassador

Parameters:: theClass - the class of interactions to modify; theType - the new order type
Throws:: InteractionClassNotDefined - if the interaction class is undefined; InteractionClassNotPublished - if the interaction class is unpublished; 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

createRegion

public RegionHandle createRegion(DimensionHandleSet dimensions)
                          throws InvalidDimensionHandle,
                                 FederateNotExecutionMember,
                                 SaveInProgress,
                                 RestoreInProgress,
                                 RTIinternalError

Creates a new region with the specified dimensions.

Specified by:: createRegion in interface RTIambassador

Parameters:: dimensions - the set of dimensions for the region
Returns:: a handle to the newly created region
Throws:: InvalidDimensionHandle - if one of the dimension handles is invalid; 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

commitRegionModifications

public void commitRegionModifications(RegionHandleSet regions)
                               throws InvalidRegion,
                                      RegionNotCreatedByThisFederate,
                                      FederateNotExecutionMember,
                                      SaveInProgress,
                                      RestoreInProgress,
                                      RTIinternalError

Commits modifications to a set of regions.

Specified by:: commitRegionModifications in interface RTIambassador

Parameters:: regions - the regions to commit
Throws:: InvalidRegion - if one of the specified regions is invalid; RegionNotCreatedByThisFederate - if one of the regions was not created by this federate; 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

deleteRegion

public void deleteRegion(RegionHandle theRegion)
                  throws InvalidRegion,
                         RegionNotCreatedByThisFederate,
                         RegionInUseForUpdateOrSubscription,
                         FederateNotExecutionMember,
                         SaveInProgress,
                         RestoreInProgress,
                         RTIinternalError

Deletes a region.

Specified by:: deleteRegion in interface RTIambassador

Parameters:: theRegion - the region to delete
Throws:: InvalidRegion - if one of the specified regions is invalid; RegionNotCreatedByThisFederate - if one of the regions was not created by this federate; RegionInUseForUpdateOrSubscription - if the region is in use for updates or subscription; 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

registerObjectInstanceWithRegions

public ObjectInstanceHandle registerObjectInstanceWithRegions(ObjectClassHandle theClass,
                                                              AttributeSetRegionSetPairList attributesAndRegions)
                                                       throws ObjectClassNotDefined,
                                                              ObjectClassNotPublished,
                                                              AttributeNotDefined,
                                                              AttributeNotPublished,
                                                              InvalidRegion,
                                                              RegionNotCreatedByThisFederate,
                                                              InvalidRegionContext,
                                                              FederateNotExecutionMember,
                                                              SaveInProgress,
                                                              RestoreInProgress,
                                                              RTIinternalError

Registers an object instance with associated regions.

Specified by:: registerObjectInstanceWithRegions in interface RTIambassador

Parameters:: theClass - the class of the object to register; attributesAndRegions - the list of attributes and associated regions
Throws:: ObjectClassNotDefined - if the object class is not defined; ObjectClassNotPublished - if the object class is not published; AttributeNotDefined - if one of the attributes is not defined; AttributeNotPublished - if one of the attributes is not published; InvalidRegion - if one of the regions is invalid; RegionNotCreatedByThisFederate - if one of the regions was not created by this federate; InvalidRegionContext - if the region context is invalid; 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

registerObjectInstanceWithRegions

public ObjectInstanceHandle registerObjectInstanceWithRegions(ObjectClassHandle theClass,
                                                              AttributeSetRegionSetPairList attributesAndRegions,
                                                              java.lang.String theObject)
                                                       throws ObjectClassNotDefined,
                                                              ObjectClassNotPublished,
                                                              AttributeNotDefined,
                                                              AttributeNotPublished,
                                                              InvalidRegion,
                                                              RegionNotCreatedByThisFederate,
                                                              InvalidRegionContext,
                                                              ObjectInstanceNameNotReserved,
                                                              ObjectInstanceNameInUse,
                                                              FederateNotExecutionMember,
                                                              SaveInProgress,
                                                              RestoreInProgress,
                                                              RTIinternalError

Registers an object instance with associated regions.

Specified by:: registerObjectInstanceWithRegions in interface RTIambassador

Parameters:: theClass - the class of the object to register; attributesAndRegions - the list of attributes and associated regions; theObject - the object name
Throws:: ObjectClassNotDefined - if the object class is not defined; ObjectClassNotPublished - if the object class is not published; AttributeNotDefined - if one of the attributes is not defined; AttributeNotPublished - if one of the attributes is not published; InvalidRegion - if one of the regions is invalid; RegionNotCreatedByThisFederate - if one of the regions was not created by this federate; InvalidRegionContext - if the region context is invalid; ObjectInstanceNameNotReserved - if the object instance name was not reserved; ObjectInstanceNameInUse - if the object instance name is 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

associateRegionsForUpdates

public void associateRegionsForUpdates(ObjectInstanceHandle theObject,
                                       AttributeSetRegionSetPairList attributesAndRegions)
                                throws ObjectInstanceNotKnown,
                                       AttributeNotDefined,
                                       InvalidRegion,
                                       RegionNotCreatedByThisFederate,
                                       InvalidRegionContext,
                                       FederateNotExecutionMember,
                                       SaveInProgress,
                                       RestoreInProgress,
                                       RTIinternalError

Associates object attributes with regions for updates.

Specified by:: associateRegionsForUpdates in interface RTIambassador

Parameters:: theObject - the object with which the attributes are associated; attributesAndRegions - the list of attributes and associated regions
Throws:: ObjectInstanceNotKnown - if the object instance is unknown; AttributeNotDefined - if one of the attributes is not defined; RegionNotCreatedByThisFederate - if one of the regions was not created by this federate; InvalidRegionContext - if the region context is invalid; 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; InvalidRegion

unassociateRegionsForUpdates

public void unassociateRegionsForUpdates(ObjectInstanceHandle theObject,
                                         AttributeSetRegionSetPairList attributesAndRegions)
                                  throws ObjectInstanceNotKnown,
                                         AttributeNotDefined,
                                         InvalidRegion,
                                         RegionNotCreatedByThisFederate,
                                         FederateNotExecutionMember,
                                         SaveInProgress,
                                         RestoreInProgress,
                                         RTIinternalError

Unassociates object attributes with regions for updates.

Specified by:: unassociateRegionsForUpdates in interface RTIambassador

Parameters:: theObject - the object with which the attributes are associated; attributesAndRegions - the list of attributes and associated regions
Throws:: ObjectInstanceNotKnown - if the object instance is unknown; AttributeNotDefined - if one of the attributes is not defined; RegionNotCreatedByThisFederate - if one of the regions was not created by this federate; 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; InvalidRegion

subscribeObjectClassAttributesWithRegions

public void subscribeObjectClassAttributesWithRegions(ObjectClassHandle theClass,
                                                      AttributeSetRegionSetPairList attributesAndRegions)
                                               throws ObjectClassNotDefined,
                                                      AttributeNotDefined,
                                                      InvalidRegion,
                                                      RegionNotCreatedByThisFederate,
                                                      InvalidRegionContext,
                                                      FederateNotExecutionMember,
                                                      SaveInProgress,
                                                      RestoreInProgress,
                                                      RTIinternalError

Subscribes to a set of object class attributes with associated regions.

Specified by:: subscribeObjectClassAttributesWithRegions in interface RTIambassador

Parameters:: theClass - the object class with which the attributes are associated; attributesAndRegions - the list of attributes and associated regions
Throws:: ObjectClassNotDefined - if the object class is not defined; AttributeNotDefined - if one of the attributes is not defined; InvalidRegion - if one of the regions is invalid; RegionNotCreatedByThisFederate - if one of the regions was not created by this federate; InvalidRegionContext - if the region context is invalid; 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

subscribeObjectClassAttributesPassivelyWithRegions

public void subscribeObjectClassAttributesPassivelyWithRegions(ObjectClassHandle theClass,
                                                               AttributeSetRegionSetPairList attributesAndRegions)
                                                        throws ObjectClassNotDefined,
                                                               AttributeNotDefined,
                                                               InvalidRegion,
                                                               RegionNotCreatedByThisFederate,
                                                               InvalidRegionContext,
                                                               FederateNotExecutionMember,
                                                               SaveInProgress,
                                                               RestoreInProgress,
                                                               RTIinternalError

Passively subscribes to a set of object class attributes with associated regions.

Specified by:: subscribeObjectClassAttributesPassivelyWithRegions in interface RTIambassador

Parameters:: theClass - the object class with which the attributes are associated; attributesAndRegions - the list of attributes and associated regions
Throws:: ObjectClassNotDefined - if the object class is not defined; AttributeNotDefined - if one of the attributes is not defined; InvalidRegion - if one of the regions is invalid; RegionNotCreatedByThisFederate - if one of the regions was not created by this federate; InvalidRegionContext - if the region context is invalid; 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

unsubscribeObjectClassAttributesWithRegions

public void unsubscribeObjectClassAttributesWithRegions(ObjectClassHandle theClass,
                                                        AttributeSetRegionSetPairList attributesAndRegions)
                                                 throws ObjectClassNotDefined,
                                                        AttributeNotDefined,
                                                        InvalidRegion,
                                                        RegionNotCreatedByThisFederate,
                                                        FederateNotExecutionMember,
                                                        SaveInProgress,
                                                        RestoreInProgress,
                                                        RTIinternalError

Unsubscribes from a set of object class attributes with associated regions.

Specified by:: unsubscribeObjectClassAttributesWithRegions in interface RTIambassador

Parameters:: theClass - the object class with which the attributes are associated; attributesAndRegions - the list of attributes and associated regions
Throws:: ObjectClassNotDefined - if the object class is not defined; AttributeNotDefined - if one of the attributes is not defined; InvalidRegion - if one of the regions is invalid; RegionNotCreatedByThisFederate - if one of the regions was not created by this federate; 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

subscribeInteractionClassWithRegions

public void subscribeInteractionClassWithRegions(InteractionClassHandle theClass,
                                                 RegionHandleSet regions)
                                          throws InteractionClassNotDefined,
                                                 InvalidRegion,
                                                 RegionNotCreatedByThisFederate,
                                                 InvalidRegionContext,
                                                 FederateServiceInvocationsAreBeingReportedViaMOM,
                                                 FederateNotExecutionMember,
                                                 SaveInProgress,
                                                 RestoreInProgress,
                                                 RTIinternalError

Subscribes to a class of interactions with associated regions.

Specified by:: subscribeInteractionClassWithRegions in interface RTIambassador

Parameters:: theClass - the interaction class to subscribe to; regions - the regions associated with the interaction class
Throws:: InteractionClassNotDefined - if the interaction class is not defined; InvalidRegion - if one of the regions is invalid; RegionNotCreatedByThisFederate - if one of the regions was not created by this federate; InvalidRegionContext - if the region context is invalid; 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

subscribeInteractionClassPassivelyWithRegions

public void subscribeInteractionClassPassivelyWithRegions(InteractionClassHandle theClass,
                                                          RegionHandleSet regions)
                                                   throws InteractionClassNotDefined,
                                                          InvalidRegion,
                                                          RegionNotCreatedByThisFederate,
                                                          InvalidRegionContext,
                                                          FederateServiceInvocationsAreBeingReportedViaMOM,
                                                          FederateNotExecutionMember,
                                                          SaveInProgress,
                                                          RestoreInProgress,
                                                          RTIinternalError

Passively subscribes to a class of interactions with associated regions.

Specified by:: subscribeInteractionClassPassivelyWithRegions in interface RTIambassador

Parameters:: theClass - the interaction class to subscribe to; regions - the regions associated with the interaction class
Throws:: InteractionClassNotDefined - if the interaction class is not defined; InvalidRegion - if one of the regions is invalid; RegionNotCreatedByThisFederate - if one of the regions was not created by this federate; InvalidRegionContext - if the region context is invalid; 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

unsubscribeInteractionClassWithRegions

public void unsubscribeInteractionClassWithRegions(InteractionClassHandle theClass,
                                                   RegionHandleSet regions)
                                            throws InteractionClassNotDefined,
                                                   InvalidRegion,
                                                   RegionNotCreatedByThisFederate,
                                                   FederateNotExecutionMember,
                                                   SaveInProgress,
                                                   RestoreInProgress,
                                                   RTIinternalError

Unsubscribes from a class of interactions with associated regions.

Specified by:: unsubscribeInteractionClassWithRegions in interface RTIambassador

Parameters:: theClass - the interaction class to unsubscribe from; regions - the regions associated with the interaction class
Throws:: InteractionClassNotDefined - if the interaction class is not defined; InvalidRegion - if one of the regions is invalid; RegionNotCreatedByThisFederate - if one of the regions was not created by this federate; 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

sendInteractionWithRegions

public void sendInteractionWithRegions(InteractionClassHandle theInteraction,
                                       ParameterHandleValueMap theParameters,
                                       RegionHandleSet regions,
                                       byte[] userSuppliedTag)
                                throws InteractionClassNotDefined,
                                       InteractionClassNotPublished,
                                       InteractionParameterNotDefined,
                                       InvalidRegion,
                                       RegionNotCreatedByThisFederate,
                                       InvalidRegionContext,
                                       FederateNotExecutionMember,
                                       SaveInProgress,
                                       RestoreInProgress,
                                       RTIinternalError

Sends an interaction with associated regions.

Specified by:: sendInteractionWithRegions in interface RTIambassador

Parameters:: theInteraction - the class of interaction to send; theParameters - the parameters of the interaction; regions - the regions associated with the interaction; userSuppliedTag - a user-supplied tag to associate with the interaction
Throws:: InteractionClassNotDefined - if the interaction class is undefined; InteractionClassNotPublished - if the interaction class is not published; InteractionParameterNotDefined - if one of the interaction parameters was undefined; InvalidRegion - if one of the regions was invalid; RegionNotCreatedByThisFederate - if one of the regions was not created by this federate; InvalidRegionContext - if the region context is invalid; 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

sendInteractionWithRegions

public MessageRetractionReturn sendInteractionWithRegions(InteractionClassHandle theInteraction,
                                                          ParameterHandleValueMap theParameters,
                                                          RegionHandleSet regions,
                                                          byte[] userSuppliedTag,
                                                          LogicalTime theTime)
                                                   throws InteractionClassNotDefined,
                                                          InteractionClassNotPublished,
                                                          InteractionParameterNotDefined,
                                                          InvalidRegion,
                                                          RegionNotCreatedByThisFederate,
                                                          InvalidRegionContext,
                                                          InvalidLogicalTime,
                                                          FederateNotExecutionMember,
                                                          SaveInProgress,
                                                          RestoreInProgress,
                                                          RTIinternalError

Sends an interaction with associated regions.

Specified by:: sendInteractionWithRegions in interface RTIambassador

Parameters:: theInteraction - the class of interaction to send; theParameters - the parameters of the interaction; regions - the regions associated with the interaction; userSuppliedTag - a user-supplied tag to associate with the interaction; theTime - the logical time of the interaction
Throws:: InteractionClassNotDefined - if the interaction class is undefined; InteractionClassNotPublished - if the interaction class is not published; InteractionParameterNotDefined - if one of the interaction parameters was undefined; InvalidRegion - if one of the regions was invalid; RegionNotCreatedByThisFederate - if one of the regions was not created by this federate; InvalidRegionContext - if the region context is invalid; InvalidLogicalTime - if the specified logical time is invalid; 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

requestAttributeValueUpdateWithRegions

public void requestAttributeValueUpdateWithRegions(ObjectClassHandle theClass,
                                                   AttributeSetRegionSetPairList attributesAndRegions,
                                                   byte[] userSuppliedTag)
                                            throws ObjectClassNotDefined,
                                                   AttributeNotDefined,
                                                   InvalidRegion,
                                                   RegionNotCreatedByThisFederate,
                                                   InvalidRegionContext,
                                                   FederateNotExecutionMember,
                                                   SaveInProgress,
                                                   RestoreInProgress,
                                                   RTIinternalError

Requests an attribute value update with associated regions.

Specified by:: requestAttributeValueUpdateWithRegions in interface RTIambassador

Parameters:: theClass - the class with which the attributes are associated; attributesAndRegions - the attributes and their associated regions; userSuppliedTag - a user-supplied tag to associate with the request
Throws:: ObjectClassNotDefined - if the specified object class is undefined; AttributeNotDefined - if one of the specified attributes is undefined; InvalidRegion - if one of the specified regions is invalid; RegionNotCreatedByThisFederate - if one of the regions was not created by this federate; InvalidRegionContext - if the region context is invalid; 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

registerFederationSynchronizationPoint

public void registerFederationSynchronizationPoint(java.lang.String pSynchronizationPointLabel,
                                                   byte[] userSuppliedTag)
                                            throws FederateNotExecutionMember,
                                                   SaveInProgress,
                                                   RestoreInProgress,
                                                   RTIinternalError

Registers a federation synchronization point.

Specified by:: registerFederationSynchronizationPoint in interface RTIambassador

Parameters:: userSuppliedTag - a user-supplied tag to associate with the operation; pSynchronizationPointLabel - the label of the synchronization point
Throws:: 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

registerFederationSynchronizationPoint

public void registerFederationSynchronizationPoint(java.lang.String pSynchronizationPointLabel,
                                                   byte[] userSuppliedTag,
                                                   FederateHandleSet synchronizationSet)
                                            throws FederateNotExecutionMember,
                                                   SaveInProgress,
                                                   RestoreInProgress,
                                                   RTIinternalError

Registers a federation synchronization point.

Specified by:: registerFederationSynchronizationPoint in interface RTIambassador

Parameters:: userSuppliedTag - a user-supplied tag to associate with the operation; synchronizationSet - the set of federates to synchronize; pSynchronizationPointLabel - the label of the synchronization point
Throws:: 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

synchronizationPointAchieved

public void synchronizationPointAchieved(java.lang.String pSynchronizationPointLabel)
                                  throws SynchronizationPointLabelNotAnnounced,
                                         FederateNotExecutionMember,
                                         SaveInProgress,
                                         RestoreInProgress,
                                         RTIinternalError

Notifies the run-time infrastructure that a synchronization point has been achieved.

Specified by:: synchronizationPointAchieved in interface RTIambassador

Parameters:: pSynchronizationPointLabel - the label of the achieved synchronization point
Throws:: SynchronizationPointLabelNotAnnounced - if the specified synchronization point label was not announced; 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

requestFederationSave

public void requestFederationSave(java.lang.String label)
                           throws FederateNotExecutionMember,
                                  SaveInProgress,
                                  RestoreInProgress,
                                  RTIinternalError

Requests that the federation perform a save operation.

Specified by:: requestFederationSave in interface RTIambassador

Parameters:: label - the label for the save point
Throws:: 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

requestFederationSave

public void requestFederationSave(java.lang.String label,
                                  LogicalTime theTime)
                           throws LogicalTimeAlreadyPassed,
                                  InvalidLogicalTime,
                                  FederateUnableToUseTime,
                                  FederateNotExecutionMember,
                                  SaveInProgress,
                                  RestoreInProgress,
                                  RTIinternalError

Requests that the federation perform a save operation.

Specified by:: requestFederationSave in interface RTIambassador

Parameters:: label - the label for the save point; theTime - the time at which to perform the save operation
Throws:: LogicalTimeAlreadyPassed - if the specified time has already passed; InvalidLogicalTime - if the specified time is invalid; FederateUnableToUseTime - if the federate is unable to use time management; 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

federateSaveBegun

public void federateSaveBegun()
                       throws SaveNotInitiated,
                              FederateNotExecutionMember,
                              RestoreInProgress,
                              RTIinternalError

Notifies the run-time infrastructure that the federate is beginning a save operation.

Specified by:: federateSaveBegun in interface RTIambassador

Throws:: FederateNotExecutionMember - if the federate is not a member of an execution; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurred in the run-time infrastructure; SaveNotInitiated

federateSaveComplete

public void federateSaveComplete()
                          throws FederateHasNotBegunSave,
                                 FederateNotExecutionMember,
                                 RestoreInProgress,
                                 RTIinternalError

Notifies the run-time infrastructure that the federate has completed its save operation.

Specified by:: federateSaveComplete in interface RTIambassador

Throws:: FederateNotExecutionMember - if the federate is not a member of an execution; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurred in the run-time infrastructure; FederateHasNotBegunSave

federateSaveNotComplete

public void federateSaveNotComplete()
                             throws FederateHasNotBegunSave,
                                    FederateNotExecutionMember,
                                    RestoreInProgress,
                                    RTIinternalError

Notifies the run-time infrastructure that the federate's save operation is not complete.

Specified by:: federateSaveNotComplete in interface RTIambassador

Throws:: FederateNotExecutionMember - if the federate is not a member of an execution; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurred in the run-time infrastructure; FederateHasNotBegunSave

queryFederationSaveStatus

public void queryFederationSaveStatus()
                               throws FederateNotExecutionMember,
                                      SaveNotInProgress,
                                      RestoreInProgress,
                                      RTIinternalError

Requests information from the run-time infrastructure concerning the federation's save status.

Specified by:: queryFederationSaveStatus in interface RTIambassador

Throws:: FederateNotExecutionMember - if the federate is not a member of an execution; SaveNotInProgress - if a save operation is not in progress; RestoreInProgress - if a restore operation is in progress; RTIinternalError - if an internal error occurred in the run-time infrastructure

requestFederationRestore

public void requestFederationRestore(java.lang.String label)
                              throws FederateNotExecutionMember,
                                     SaveInProgress,
                                     RestoreInProgress,
                                     RTIinternalError

Requests a federation restore operation.

Specified by:: requestFederationRestore in interface RTIambassador

Parameters:: label - the label associated with the stored state to restore
Throws:: 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

federateRestoreComplete

public void federateRestoreComplete()
                             throws RestoreNotRequested,
                                    FederateNotExecutionMember,
                                    SaveInProgress,
                                    RTIinternalError

Notifies the run-time infrastructure that the federate's restore operation is complete.

Specified by:: federateRestoreComplete in interface RTIambassador

Throws:: FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RTIinternalError - if an internal error occurred in the run-time infrastructure; RestoreNotRequested

federateRestoreNotComplete

public void federateRestoreNotComplete()
                                throws RestoreNotRequested,
                                       FederateNotExecutionMember,
                                       SaveInProgress,
                                       RTIinternalError

Notifies the run-time infrastructure that the federate's restore operation is not complete.

Specified by:: federateRestoreNotComplete in interface RTIambassador

Throws:: FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RTIinternalError - if an internal error occurred in the run-time infrastructure; RestoreNotRequested

queryFederationRestoreStatus

public void queryFederationRestoreStatus()
                                  throws FederateNotExecutionMember,
                                         SaveInProgress,
                                         RestoreNotInProgress,
                                         RTIinternalError

Requests information from the run-time infrastructure concerning the restore status of the federation.

Specified by:: queryFederationRestoreStatus in interface RTIambassador

Throws:: FederateNotExecutionMember - if the federate is not a member of an execution; SaveInProgress - if a save operation is in progress; RestoreNotInProgress - if a restore operation is not in progress; RTIinternalError - if an internal error occurred in the run-time infrastructure

receiveHLAinteractionFragment

public void receiveHLAinteractionFragment(int interactionNumber,
                                          int interactionSize,
                                          int fragmentOffset,
                                          byte[] fragmentContents,
                                          byte[] userSuppliedTag,
                                          OrderType sentOrdering,
                                          TransportationType theTransport)
                                   throws InteractionClassNotRecognized,
                                          InteractionParameterNotRecognized,
                                          InteractionClassNotSubscribed,
                                          FederateInternalError

A piece of a fragmented interaction.

Specified by:: receiveHLAinteractionFragment in interface BootstrapInteractionListener

Parameters:: interactionNumber - The sequence number of the fragmented interaction.; interactionSize - The size of the fragmented interaction.; fragmentOffset - The offset of this fragment in the buffer.; fragmentContents - The contents of the fragment.; 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

receiveHLArequestHandles

public void receiveHLArequestHandles(long blockSize,
                                     byte[] userSuppliedTag,
                                     OrderType sentOrdering,
                                     TransportationType theTransport)
                              throws InteractionClassNotRecognized,
                                     InteractionParameterNotRecognized,
                                     InteractionClassNotSubscribed,
                                     FederateInternalError

Requests a block of handles.

Specified by:: receiveHLArequestHandles in interface BootstrapInteractionListener

Parameters:: blockSize - The number of handles desired.; 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

receiveHLAreportHandles

public void receiveHLAreportHandles(long blockStart,
                                    long blockSize,
                                    byte[] userSuppliedTag,
                                    OrderType sentOrdering,
                                    TransportationType theTransport)
                             throws InteractionClassNotRecognized,
                                    InteractionParameterNotRecognized,
                                    InteractionClassNotSubscribed,
                                    FederateInternalError

Reports a block of handles.

Specified by:: receiveHLAreportHandles in interface BootstrapInteractionListener

Parameters:: blockStart - The first handle in the block.; blockSize - The number of handles in the block.; 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

receiveHLAcontinue

public void receiveHLAcontinue(byte[] userSuppliedTag,
                               OrderType sentOrdering,
                               TransportationType theTransport)
                        throws InteractionClassNotRecognized,
                               InteractionParameterNotRecognized,
                               InteractionClassNotSubscribed,
                               FederateInternalError

Notifies the federate that the executive is done sending callbacks.

Specified by:: receiveHLAcontinue in interface BootstrapInteractionListener

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

receiveHLAregisterObjectInstance

public void receiveHLAregisterObjectInstance(java.lang.String objectName,
                                             long objectInstanceHandle,
                                             long objectClassHandle,
                                             byte[] userSuppliedTag,
                                             OrderType sentOrdering,
                                             TransportationType theTransport)
                                      throws InteractionClassNotRecognized,
                                             InteractionParameterNotRecognized,
                                             InteractionClassNotSubscribed,
                                             FederateInternalError

Registers a new object instance.

Specified by:: receiveHLAregisterObjectInstance in interface BootstrapInteractionListener

Parameters:: objectName - The name of the object.; objectInstanceHandle - The object instance handle.; objectClassHandle - The object class handle.; 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

receiveHLArequestAttributeValueUpdate

public void receiveHLArequestAttributeValueUpdate(long objectInstanceHandle,
                                                  long[] attributeHandleList,
                                                  byte[] userSuppliedTag,
                                                  OrderType sentOrdering,
                                                  TransportationType theTransport)
                                           throws InteractionClassNotRecognized,
                                                  InteractionParameterNotRecognized,
                                                  InteractionClassNotSubscribed,
                                                  FederateInternalError

Requests an attribute value update.

Specified by:: receiveHLArequestAttributeValueUpdate in interface BootstrapInteractionListener

Parameters:: objectInstanceHandle - Object instance handle.; attributeHandleList - List of attribute handles.; 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

receiveHLAupdateAttributeValuesBestEffort

public void receiveHLAupdateAttributeValuesBestEffort(long objectInstanceHandle,
                                                      HLAattributeHandleValuePair[] attributeHandleValuePairList,
                                                      byte[] userSuppliedTag,
                                                      OrderType sentOrdering,
                                                      TransportationType theTransport)
                                               throws InteractionClassNotRecognized,
                                                      InteractionParameterNotRecognized,
                                                      InteractionClassNotSubscribed,
                                                      FederateInternalError

Updates a set of attribute values with best-effort transportation and receive ordering.

Specified by:: receiveHLAupdateAttributeValuesBestEffort in interface BootstrapInteractionListener

Parameters:: objectInstanceHandle - Object instance handle.; attributeHandleValuePairList - List of attribute handle/value pairs.; 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

receiveHLAupdateAttributeValuesReliable

public void receiveHLAupdateAttributeValuesReliable(long objectInstanceHandle,
                                                    HLAattributeHandleValuePair[] attributeHandleValuePairList,
                                                    byte[] userSuppliedTag,
                                                    OrderType sentOrdering,
                                                    TransportationType theTransport)
                                             throws InteractionClassNotRecognized,
                                                    InteractionParameterNotRecognized,
                                                    InteractionClassNotSubscribed,
                                                    FederateInternalError

Updates a set of attribute values with reliable transportation and receive ordering.

Specified by:: receiveHLAupdateAttributeValuesReliable in interface BootstrapInteractionListener

Parameters:: objectInstanceHandle - Object instance handle.; attributeHandleValuePairList - List of attribute handle/value pairs.; 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

receiveHLAsetTiming

public void receiveHLAsetTiming(byte[] HLAfederate,
                                int HLAreportPeriod,
                                byte[] userSuppliedTag,
                                OrderType sentOrdering,
                                TransportationType theTransport)
                         throws InteractionClassNotRecognized,
                                InteractionParameterNotRecognized,
                                InteractionClassNotSubscribed,
                                FederateInternalError

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.

Specified by:: receiveHLAsetTiming in interface ManagementInteractionListener

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 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

receiveHLAmodifyAttributeState

public void receiveHLAmodifyAttributeState(byte[] HLAfederate,
                                           byte[] HLAobjectInstance,
                                           byte[] HLAattribute,
                                           HLAownership HLAattributeState,
                                           byte[] userSuppliedTag,
                                           OrderType sentOrdering,
                                           TransportationType theTransport)
                                    throws InteractionClassNotRecognized,
                                           InteractionParameterNotRecognized,
                                           InteractionClassNotSubscribed,
                                           FederateInternalError

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.

Specified by:: receiveHLAmodifyAttributeState in interface ManagementInteractionListener

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 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

receiveHLAsetServiceReporting

public void receiveHLAsetServiceReporting(byte[] HLAfederate,
                                          boolean HLAreportingState,
                                          byte[] userSuppliedTag,
                                          OrderType sentOrdering,
                                          TransportationType theTransport)
                                   throws InteractionClassNotRecognized,
                                          InteractionParameterNotRecognized,
                                          InteractionClassNotSubscribed,
                                          FederateInternalError

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.

Specified by:: receiveHLAsetServiceReporting in interface ManagementInteractionListener

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 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

receiveHLAsetExceptionReporting

public void receiveHLAsetExceptionReporting(byte[] HLAfederate,
                                            boolean HLAreportingState,
                                            byte[] userSuppliedTag,
                                            OrderType sentOrdering,
                                            TransportationType theTransport)
                                     throws InteractionClassNotRecognized,
                                            InteractionParameterNotRecognized,
                                            InteractionClassNotSubscribed,
                                            FederateInternalError

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

Specified by:: receiveHLAsetExceptionReporting in interface ManagementInteractionListener

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 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

receiveHLArequestPublications

public void receiveHLArequestPublications(byte[] HLAfederate,
                                          byte[] userSuppliedTag,
                                          OrderType sentOrdering,
                                          TransportationType theTransport)
                                   throws InteractionClassNotRecognized,
                                          InteractionParameterNotRecognized,
                                          InteractionClassNotSubscribed,
                                          FederateInternalError

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.

Specified by:: receiveHLArequestPublications in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; 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

receiveHLArequestSubscriptions

public void receiveHLArequestSubscriptions(byte[] HLAfederate,
                                           byte[] userSuppliedTag,
                                           OrderType sentOrdering,
                                           TransportationType theTransport)
                                    throws InteractionClassNotRecognized,
                                           InteractionParameterNotRecognized,
                                           InteractionClassNotSubscribed,
                                           FederateInternalError

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.

Specified by:: receiveHLArequestSubscriptions in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; 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

receiveHLArequestObjectInstancesThatCanBeDeleted

public void receiveHLArequestObjectInstancesThatCanBeDeleted(byte[] HLAfederate,
                                                             byte[] userSuppliedTag,
                                                             OrderType sentOrdering,
                                                             TransportationType theTransport)
                                                      throws InteractionClassNotRecognized,
                                                             InteractionParameterNotRecognized,
                                                             InteractionClassNotSubscribed,
                                                             FederateInternalError

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.

Specified by:: receiveHLArequestObjectInstancesThatCanBeDeleted in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; 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

receiveHLArequestObjectInstancesUpdated

public void receiveHLArequestObjectInstancesUpdated(byte[] HLAfederate,
                                                    byte[] userSuppliedTag,
                                                    OrderType sentOrdering,
                                                    TransportationType theTransport)
                                             throws InteractionClassNotRecognized,
                                                    InteractionParameterNotRecognized,
                                                    InteractionClassNotSubscribed,
                                                    FederateInternalError

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.

Specified by:: receiveHLArequestObjectInstancesUpdated in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; 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

receiveHLArequestObjectInstancesReflected

public void receiveHLArequestObjectInstancesReflected(byte[] HLAfederate,
                                                      byte[] userSuppliedTag,
                                                      OrderType sentOrdering,
                                                      TransportationType theTransport)
                                               throws InteractionClassNotRecognized,
                                                      InteractionParameterNotRecognized,
                                                      InteractionClassNotSubscribed,
                                                      FederateInternalError

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.

Specified by:: receiveHLArequestObjectInstancesReflected in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; 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

receiveHLArequestUpdatesSent

public void receiveHLArequestUpdatesSent(byte[] HLAfederate,
                                         byte[] userSuppliedTag,
                                         OrderType sentOrdering,
                                         TransportationType theTransport)
                                  throws InteractionClassNotRecognized,
                                         InteractionParameterNotRecognized,
                                         InteractionClassNotSubscribed,
                                         FederateInternalError

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.

Specified by:: receiveHLArequestUpdatesSent in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; 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

receiveHLArequestInteractionsSent

public void receiveHLArequestInteractionsSent(byte[] HLAfederate,
                                              byte[] userSuppliedTag,
                                              OrderType sentOrdering,
                                              TransportationType theTransport)
                                       throws InteractionClassNotRecognized,
                                              InteractionParameterNotRecognized,
                                              InteractionClassNotSubscribed,
                                              FederateInternalError

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.

Specified by:: receiveHLArequestInteractionsSent in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; 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

receiveHLArequestReflectionsReceived

public void receiveHLArequestReflectionsReceived(byte[] HLAfederate,
                                                 byte[] userSuppliedTag,
                                                 OrderType sentOrdering,
                                                 TransportationType theTransport)
                                          throws InteractionClassNotRecognized,
                                                 InteractionParameterNotRecognized,
                                                 InteractionClassNotSubscribed,
                                                 FederateInternalError

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.

Specified by:: receiveHLArequestReflectionsReceived in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; 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

receiveHLArequestInteractionsReceived

public void receiveHLArequestInteractionsReceived(byte[] HLAfederate,
                                                  byte[] userSuppliedTag,
                                                  OrderType sentOrdering,
                                                  TransportationType theTransport)
                                           throws InteractionClassNotRecognized,
                                                  InteractionParameterNotRecognized,
                                                  InteractionClassNotSubscribed,
                                                  FederateInternalError

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.

Specified by:: receiveHLArequestInteractionsReceived in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; 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

receiveHLArequestObjectInstanceInformation

public void receiveHLArequestObjectInstanceInformation(byte[] HLAfederate,
                                                       byte[] HLAobjectInstance,
                                                       byte[] userSuppliedTag,
                                                       OrderType sentOrdering,
                                                       TransportationType theTransport)
                                                throws InteractionClassNotRecognized,
                                                       InteractionParameterNotRecognized,
                                                       InteractionClassNotSubscribed,
                                                       FederateInternalError

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.

Specified by:: receiveHLArequestObjectInstanceInformation in interface ManagementInteractionListener

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 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

receiveHLArequestSynchronizationPoints

public void receiveHLArequestSynchronizationPoints(byte[] HLAfederate,
                                                   byte[] userSuppliedTag,
                                                   OrderType sentOrdering,
                                                   TransportationType theTransport)
                                            throws InteractionClassNotRecognized,
                                                   InteractionParameterNotRecognized,
                                                   InteractionClassNotSubscribed,
                                                   FederateInternalError

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.

Specified by:: receiveHLArequestSynchronizationPoints in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; 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

receiveHLArequestSynchronizationPointStatus

public void receiveHLArequestSynchronizationPointStatus(byte[] HLAfederate,
                                                        byte[] userSuppliedTag,
                                                        OrderType sentOrdering,
                                                        TransportationType theTransport)
                                                 throws InteractionClassNotRecognized,
                                                        InteractionParameterNotRecognized,
                                                        InteractionClassNotSubscribed,
                                                        FederateInternalError

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.

Specified by:: receiveHLArequestSynchronizationPointStatus in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; 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

receiveHLAreportObjectClassPublication

public void receiveHLAreportObjectClassPublication(byte[] HLAfederate,
                                                   int HLAnumberOfClasses,
                                                   byte[] HLAobjectClass,
                                                   byte[][] HLAattributeList,
                                                   byte[] userSuppliedTag,
                                                   OrderType sentOrdering,
                                                   TransportationType theTransport)
                                            throws InteractionClassNotRecognized,
                                                   InteractionParameterNotRecognized,
                                                   InteractionClassNotSubscribed,
                                                   FederateInternalError

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.

Specified by:: receiveHLAreportObjectClassPublication in interface ManagementInteractionListener

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 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

receiveHLAreportObjectClassSubscription

public void receiveHLAreportObjectClassSubscription(byte[] HLAfederate,
                                                    int HLAnumberOfClasses,
                                                    byte[] HLAobjectClass,
                                                    boolean HLAactive,
                                                    byte[][] HLAattributeList,
                                                    byte[] userSuppliedTag,
                                                    OrderType sentOrdering,
                                                    TransportationType theTransport)
                                             throws InteractionClassNotRecognized,
                                                    InteractionParameterNotRecognized,
                                                    InteractionClassNotSubscribed,
                                                    FederateInternalError

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.

Specified by:: receiveHLAreportObjectClassSubscription in interface ManagementInteractionListener

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 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

receiveHLAreportInteractionPublication

public void receiveHLAreportInteractionPublication(byte[] HLAfederate,
                                                   byte[][] HLAinteractionClassList,
                                                   byte[] userSuppliedTag,
                                                   OrderType sentOrdering,
                                                   TransportationType theTransport)
                                            throws InteractionClassNotRecognized,
                                                   InteractionParameterNotRecognized,
                                                   InteractionClassNotSubscribed,
                                                   FederateInternalError

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.

Specified by:: receiveHLAreportInteractionPublication in interface ManagementInteractionListener

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 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

receiveHLAreportInteractionSubscription

public void receiveHLAreportInteractionSubscription(byte[] HLAfederate,
                                                    HLAinteractionSubscription[] HLAinteractionClassList,
                                                    byte[] userSuppliedTag,
                                                    OrderType sentOrdering,
                                                    TransportationType theTransport)
                                             throws InteractionClassNotRecognized,
                                                    InteractionParameterNotRecognized,
                                                    InteractionClassNotSubscribed,
                                                    FederateInternalError

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.

Specified by:: receiveHLAreportInteractionSubscription in interface ManagementInteractionListener

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 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

receiveHLAreportObjectInstancesThatCanBeDeleted

public void receiveHLAreportObjectInstancesThatCanBeDeleted(byte[] HLAfederate,
                                                            HLAobjectClassBasedCount[] HLAobjectInstanceCounts,
                                                            byte[] userSuppliedTag,
                                                            OrderType sentOrdering,
                                                            TransportationType theTransport)
                                                     throws InteractionClassNotRecognized,
                                                            InteractionParameterNotRecognized,
                                                            InteractionClassNotSubscribed,
                                                            FederateInternalError

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.

Specified by:: receiveHLAreportObjectInstancesThatCanBeDeleted in interface ManagementInteractionListener

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 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

receiveHLAreportObjectInstancesUpdated

public void receiveHLAreportObjectInstancesUpdated(byte[] HLAfederate,
                                                   HLAobjectClassBasedCount[] HLAobjectInstanceCounts,
                                                   byte[] userSuppliedTag,
                                                   OrderType sentOrdering,
                                                   TransportationType theTransport)
                                            throws InteractionClassNotRecognized,
                                                   InteractionParameterNotRecognized,
                                                   InteractionClassNotSubscribed,
                                                   FederateInternalError

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.

Specified by:: receiveHLAreportObjectInstancesUpdated in interface ManagementInteractionListener

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 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

receiveHLAreportObjectInstancesReflected

public void receiveHLAreportObjectInstancesReflected(byte[] HLAfederate,
                                                     HLAobjectClassBasedCount[] HLAobjectInstanceCounts,
                                                     byte[] userSuppliedTag,
                                                     OrderType sentOrdering,
                                                     TransportationType theTransport)
                                              throws InteractionClassNotRecognized,
                                                     InteractionParameterNotRecognized,
                                                     InteractionClassNotSubscribed,
                                                     FederateInternalError

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.

Specified by:: receiveHLAreportObjectInstancesReflected in interface ManagementInteractionListener

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 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

receiveHLAreportUpdatesSent

public void receiveHLAreportUpdatesSent(byte[] HLAfederate,
                                        char[] HLAtransportation,
                                        HLAobjectClassBasedCount[] HLAupdateCounts,
                                        byte[] userSuppliedTag,
                                        OrderType sentOrdering,
                                        TransportationType theTransport)
                                 throws InteractionClassNotRecognized,
                                        InteractionParameterNotRecognized,
                                        InteractionClassNotSubscribed,
                                        FederateInternalError

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.

Specified by:: receiveHLAreportUpdatesSent in interface ManagementInteractionListener

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 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

receiveHLAreportReflectionsReceived

public void receiveHLAreportReflectionsReceived(byte[] HLAfederate,
                                                char[] HLAtransportation,
                                                HLAobjectClassBasedCount[] HLAreflectCounts,
                                                byte[] userSuppliedTag,
                                                OrderType sentOrdering,
                                                TransportationType theTransport)
                                         throws InteractionClassNotRecognized,
                                                InteractionParameterNotRecognized,
                                                InteractionClassNotSubscribed,
                                                FederateInternalError

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.

Specified by:: receiveHLAreportReflectionsReceived in interface ManagementInteractionListener

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 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

receiveHLAreportInteractionsSent

public void receiveHLAreportInteractionsSent(byte[] HLAfederate,
                                             char[] HLAtransportation,
                                             HLAinteractionCount[] HLAinteractionCounts,
                                             byte[] userSuppliedTag,
                                             OrderType sentOrdering,
                                             TransportationType theTransport)
                                      throws InteractionClassNotRecognized,
                                             InteractionParameterNotRecognized,
                                             InteractionClassNotSubscribed,
                                             FederateInternalError

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.

Specified by:: receiveHLAreportInteractionsSent in interface ManagementInteractionListener

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 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

receiveHLAreportInteractionsReceived

public void receiveHLAreportInteractionsReceived(byte[] HLAfederate,
                                                 char[] HLAtransportation,
                                                 HLAinteractionCount[] HLAinteractionCounts,
                                                 byte[] userSuppliedTag,
                                                 OrderType sentOrdering,
                                                 TransportationType theTransport)
                                          throws InteractionClassNotRecognized,
                                                 InteractionParameterNotRecognized,
                                                 InteractionClassNotSubscribed,
                                                 FederateInternalError

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.

Specified by:: receiveHLAreportInteractionsReceived in interface ManagementInteractionListener

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 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

receiveHLAreportObjectInstanceInformation

public void receiveHLAreportObjectInstanceInformation(byte[] HLAfederate,
                                                      byte[] HLAobjectInstance,
                                                      byte[][] HLAownedInstanceAttributeList,
                                                      byte[] HLAregisteredClass,
                                                      byte[] HLAknownClass,
                                                      byte[] userSuppliedTag,
                                                      OrderType sentOrdering,
                                                      TransportationType theTransport)
                                               throws InteractionClassNotRecognized,
                                                      InteractionParameterNotRecognized,
                                                      InteractionClassNotSubscribed,
                                                      FederateInternalError

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.

Specified by:: receiveHLAreportObjectInstanceInformation in interface ManagementInteractionListener

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 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

receiveHLAreportException

public void receiveHLAreportException(byte[] HLAfederate,
                                      java.lang.String HLAservice,
                                      java.lang.String HLAexception,
                                      byte[] userSuppliedTag,
                                      OrderType sentOrdering,
                                      TransportationType theTransport)
                               throws InteractionClassNotRecognized,
                                      InteractionParameterNotRecognized,
                                      InteractionClassNotSubscribed,
                                      FederateInternalError

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.

Specified by:: receiveHLAreportException in interface ManagementInteractionListener

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 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

receiveHLAreportServiceInvocation

public void receiveHLAreportServiceInvocation(byte[] HLAfederate,
                                              java.lang.String HLAservice,
                                              boolean HLAsuccessIndicator,
                                              java.lang.String[] HLAsuppliedArguments,
                                              java.lang.String[] HLAreturnedArguments,
                                              java.lang.String HLAexception,
                                              int HLAserialNumber,
                                              byte[] userSuppliedTag,
                                              OrderType sentOrdering,
                                              TransportationType theTransport)
                                       throws InteractionClassNotRecognized,
                                              InteractionParameterNotRecognized,
                                              InteractionClassNotSubscribed,
                                              FederateInternalError

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.

Specified by:: receiveHLAreportServiceInvocation in interface ManagementInteractionListener

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 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

receiveHLAreportMOMexception

public void receiveHLAreportMOMexception(byte[] HLAfederate,
                                         java.lang.String HLAservice,
                                         java.lang.String HLAexception,
                                         boolean HLAparameterError,
                                         byte[] userSuppliedTag,
                                         OrderType sentOrdering,
                                         TransportationType theTransport)
                                  throws InteractionClassNotRecognized,
                                         InteractionParameterNotRecognized,
                                         InteractionClassNotSubscribed,
                                         FederateInternalError

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.

Specified by:: receiveHLAreportMOMexception in interface ManagementInteractionListener

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 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

receiveHLAreportSynchronizationPoints

public void receiveHLAreportSynchronizationPoints(byte[] HLAfederate,
                                                  java.lang.String[] HLAsynchPoints,
                                                  byte[] userSuppliedTag,
                                                  OrderType sentOrdering,
                                                  TransportationType theTransport)
                                           throws InteractionClassNotRecognized,
                                                  InteractionParameterNotRecognized,
                                                  InteractionClassNotSubscribed,
                                                  FederateInternalError

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.

Specified by:: receiveHLAreportSynchronizationPoints in interface ManagementInteractionListener

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 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

receiveHLAreportSynchronizationPointStatus

public void receiveHLAreportSynchronizationPointStatus(byte[] HLAfederate,
                                                       java.lang.String HLAsynchPointName,
                                                       HLAsynchPointFederate[] HLAsynchPointFederates,
                                                       byte[] userSuppliedTag,
                                                       OrderType sentOrdering,
                                                       TransportationType theTransport)
                                                throws InteractionClassNotRecognized,
                                                       InteractionParameterNotRecognized,
                                                       InteractionClassNotSubscribed,
                                                       FederateInternalError

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.

Specified by:: receiveHLAreportSynchronizationPointStatus in interface ManagementInteractionListener

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 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

receiveHLAresignFederationExecution

public void receiveHLAresignFederationExecution(byte[] HLAfederate,
                                                HLAresignAction HLAresignAction,
                                                byte[] userSuppliedTag,
                                                OrderType sentOrdering,
                                                TransportationType theTransport)
                                         throws InteractionClassNotRecognized,
                                                InteractionParameterNotRecognized,
                                                InteractionClassNotSubscribed,
                                                FederateInternalError

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

Specified by:: receiveHLAresignFederationExecution in interface ManagementInteractionListener

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 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

receiveHLAsynchronizationPointAchieved

public void receiveHLAsynchronizationPointAchieved(byte[] HLAfederate,
                                                   java.lang.String HLAlabel,
                                                   byte[] userSuppliedTag,
                                                   OrderType sentOrdering,
                                                   TransportationType theTransport)
                                            throws InteractionClassNotRecognized,
                                                   InteractionParameterNotRecognized,
                                                   InteractionClassNotSubscribed,
                                                   FederateInternalError

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

Specified by:: receiveHLAsynchronizationPointAchieved in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAlabel - Label associated with the synchronization point.; 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

receiveHLAfederateSaveBegun

public void receiveHLAfederateSaveBegun(byte[] HLAfederate,
                                        byte[] userSuppliedTag,
                                        OrderType sentOrdering,
                                        TransportationType theTransport)
                                 throws InteractionClassNotRecognized,
                                        InteractionParameterNotRecognized,
                                        InteractionClassNotSubscribed,
                                        FederateInternalError

Mimic the federate's report of starting a save.

Specified by:: receiveHLAfederateSaveBegun in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; 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

receiveHLAfederateSaveComplete

public void receiveHLAfederateSaveComplete(byte[] HLAfederate,
                                           boolean HLAsuccessIndicator,
                                           byte[] userSuppliedTag,
                                           OrderType sentOrdering,
                                           TransportationType theTransport)
                                    throws InteractionClassNotRecognized,
                                           InteractionParameterNotRecognized,
                                           InteractionClassNotSubscribed,
                                           FederateInternalError

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.

Specified by:: receiveHLAfederateSaveComplete in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAsuccessIndicator - Whether the save was successful.; 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

receiveHLAfederateRestoreComplete

public void receiveHLAfederateRestoreComplete(byte[] HLAfederate,
                                              boolean HLAsuccessIndicator,
                                              byte[] userSuppliedTag,
                                              OrderType sentOrdering,
                                              TransportationType theTransport)
                                       throws InteractionClassNotRecognized,
                                              InteractionParameterNotRecognized,
                                              InteractionClassNotSubscribed,
                                              FederateInternalError

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.

Specified by:: receiveHLAfederateRestoreComplete in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAsuccessIndicator - Whether the restore was successful.; 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

receiveHLApublishObjectClassAttributes

public void receiveHLApublishObjectClassAttributes(byte[] HLAfederate,
                                                   byte[] HLAobjectClass,
                                                   byte[][] HLAattributeList,
                                                   byte[] userSuppliedTag,
                                                   OrderType sentOrdering,
                                                   TransportationType theTransport)
                                            throws InteractionClassNotRecognized,
                                                   InteractionParameterNotRecognized,
                                                   InteractionClassNotSubscribed,
                                                   FederateInternalError

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

Specified by:: receiveHLApublishObjectClassAttributes in interface ManagementInteractionListener

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 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

receiveHLAunpublishObjectClassAttributes

public void receiveHLAunpublishObjectClassAttributes(byte[] HLAfederate,
                                                     byte[] HLAobjectClass,
                                                     byte[][] HLAattributeList,
                                                     byte[] userSuppliedTag,
                                                     OrderType sentOrdering,
                                                     TransportationType theTransport)
                                              throws InteractionClassNotRecognized,
                                                     InteractionParameterNotRecognized,
                                                     InteractionClassNotSubscribed,
                                                     FederateInternalError

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

Specified by:: receiveHLAunpublishObjectClassAttributes in interface ManagementInteractionListener

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 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

receiveHLApublishInteractionClass

public void receiveHLApublishInteractionClass(byte[] HLAfederate,
                                              byte[] HLAinteractionClass,
                                              byte[] userSuppliedTag,
                                              OrderType sentOrdering,
                                              TransportationType theTransport)
                                       throws InteractionClassNotRecognized,
                                              InteractionParameterNotRecognized,
                                              InteractionClassNotSubscribed,
                                              FederateInternalError

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

Specified by:: receiveHLApublishInteractionClass in interface ManagementInteractionListener

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 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

receiveHLAunpublishInteractionClass

public void receiveHLAunpublishInteractionClass(byte[] HLAfederate,
                                                byte[] HLAinteractionClass,
                                                byte[] userSuppliedTag,
                                                OrderType sentOrdering,
                                                TransportationType theTransport)
                                         throws InteractionClassNotRecognized,
                                                InteractionParameterNotRecognized,
                                                InteractionClassNotSubscribed,
                                                FederateInternalError

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

Specified by:: receiveHLAunpublishInteractionClass in interface ManagementInteractionListener

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 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

receiveHLAsubscribeObjectClassAttributes

public void receiveHLAsubscribeObjectClassAttributes(byte[] HLAfederate,
                                                     byte[] HLAobjectClass,
                                                     byte[][] HLAattributeList,
                                                     boolean HLAactive,
                                                     byte[] userSuppliedTag,
                                                     OrderType sentOrdering,
                                                     TransportationType theTransport)
                                              throws InteractionClassNotRecognized,
                                                     InteractionParameterNotRecognized,
                                                     InteractionClassNotSubscribed,
                                                     FederateInternalError

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

Specified by:: receiveHLAsubscribeObjectClassAttributes in interface ManagementInteractionListener

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 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

receiveHLAunsubscribeObjectClassAttributes

public void receiveHLAunsubscribeObjectClassAttributes(byte[] HLAfederate,
                                                       byte[] HLAobjectClass,
                                                       byte[][] HLAattributeList,
                                                       byte[] userSuppliedTag,
                                                       OrderType sentOrdering,
                                                       TransportationType theTransport)
                                                throws InteractionClassNotRecognized,
                                                       InteractionParameterNotRecognized,
                                                       InteractionClassNotSubscribed,
                                                       FederateInternalError

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

Specified by:: receiveHLAunsubscribeObjectClassAttributes in interface ManagementInteractionListener

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 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

receiveHLAsubscribeInteractionClass

public void receiveHLAsubscribeInteractionClass(byte[] HLAfederate,
                                                byte[] HLAinteractionClass,
                                                boolean HLAactive,
                                                byte[] userSuppliedTag,
                                                OrderType sentOrdering,
                                                TransportationType theTransport)
                                         throws InteractionClassNotRecognized,
                                                InteractionParameterNotRecognized,
                                                InteractionClassNotSubscribed,
                                                FederateInternalError

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

Specified by:: receiveHLAsubscribeInteractionClass in interface ManagementInteractionListener

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 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

receiveHLAunsubscribeInteractionClass

public void receiveHLAunsubscribeInteractionClass(byte[] HLAfederate,
                                                  byte[] HLAinteractionClass,
                                                  byte[] userSuppliedTag,
                                                  OrderType sentOrdering,
                                                  TransportationType theTransport)
                                           throws InteractionClassNotRecognized,
                                                  InteractionParameterNotRecognized,
                                                  InteractionClassNotSubscribed,
                                                  FederateInternalError

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

Specified by:: receiveHLAunsubscribeInteractionClass in interface ManagementInteractionListener

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 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

receiveHLAdeleteObjectInstance

public void receiveHLAdeleteObjectInstance(byte[] HLAfederate,
                                           byte[] HLAobjectInstance,
                                           byte[] HLAtag,
                                           byte[] HLAtimeStamp,
                                           byte[] userSuppliedTag,
                                           OrderType sentOrdering,
                                           TransportationType theTransport)
                                    throws InteractionClassNotRecognized,
                                           InteractionParameterNotRecognized,
                                           InteractionClassNotSubscribed,
                                           FederateInternalError

Cause an object instance to be deleted from the federation.

Specified by:: receiveHLAdeleteObjectInstance in interface ManagementInteractionListener

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 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

receiveHLAlocalDeleteObjectInstance

public void receiveHLAlocalDeleteObjectInstance(byte[] HLAfederate,
                                                byte[] HLAobjectInstance,
                                                byte[] userSuppliedTag,
                                                OrderType sentOrdering,
                                                TransportationType theTransport)
                                         throws InteractionClassNotRecognized,
                                                InteractionParameterNotRecognized,
                                                InteractionClassNotSubscribed,
                                                FederateInternalError

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

Specified by:: receiveHLAlocalDeleteObjectInstance in interface ManagementInteractionListener

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 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

receiveHLAchangeAttributeTransportationType

public void receiveHLAchangeAttributeTransportationType(byte[] HLAfederate,
                                                        byte[] HLAobjectInstance,
                                                        byte[][] HLAattributeList,
                                                        char[] HLAtransportation,
                                                        byte[] userSuppliedTag,
                                                        OrderType sentOrdering,
                                                        TransportationType theTransport)
                                                 throws InteractionClassNotRecognized,
                                                        InteractionParameterNotRecognized,
                                                        InteractionClassNotSubscribed,
                                                        FederateInternalError

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

Specified by:: receiveHLAchangeAttributeTransportationType in interface ManagementInteractionListener

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 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

receiveHLAchangeInteractionTransportationType

public void receiveHLAchangeInteractionTransportationType(byte[] HLAfederate,
                                                          byte[] HLAinteractionClass,
                                                          char[] HLAtransportation,
                                                          byte[] userSuppliedTag,
                                                          OrderType sentOrdering,
                                                          TransportationType theTransport)
                                                   throws InteractionClassNotRecognized,
                                                          InteractionParameterNotRecognized,
                                                          InteractionClassNotSubscribed,
                                                          FederateInternalError

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

Specified by:: receiveHLAchangeInteractionTransportationType in interface ManagementInteractionListener

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 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

receiveHLAunconditionalAttributeOwnershipDivestiture

public void receiveHLAunconditionalAttributeOwnershipDivestiture(byte[] HLAfederate,
                                                                 byte[] HLAobjectInstance,
                                                                 byte[][] HLAattributeList,
                                                                 byte[] userSuppliedTag,
                                                                 OrderType sentOrdering,
                                                                 TransportationType theTransport)
                                                          throws InteractionClassNotRecognized,
                                                                 InteractionParameterNotRecognized,
                                                                 InteractionClassNotSubscribed,
                                                                 FederateInternalError

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

Specified by:: receiveHLAunconditionalAttributeOwnershipDivestiture in interface ManagementInteractionListener

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 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

receiveHLAenableTimeRegulation

public void receiveHLAenableTimeRegulation(byte[] HLAfederate,
                                           byte[] HLAlookahead,
                                           byte[] userSuppliedTag,
                                           OrderType sentOrdering,
                                           TransportationType theTransport)
                                    throws InteractionClassNotRecognized,
                                           InteractionParameterNotRecognized,
                                           InteractionClassNotSubscribed,
                                           FederateInternalError

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

Specified by:: receiveHLAenableTimeRegulation in interface ManagementInteractionListener

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 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

receiveHLAdisableTimeRegulation

public void receiveHLAdisableTimeRegulation(byte[] HLAfederate,
                                            byte[] userSuppliedTag,
                                            OrderType sentOrdering,
                                            TransportationType theTransport)
                                     throws InteractionClassNotRecognized,
                                            InteractionParameterNotRecognized,
                                            InteractionClassNotSubscribed,
                                            FederateInternalError

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

Specified by:: receiveHLAdisableTimeRegulation in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; 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

receiveHLAenableTimeConstrained

public void receiveHLAenableTimeConstrained(byte[] HLAfederate,
                                            byte[] userSuppliedTag,
                                            OrderType sentOrdering,
                                            TransportationType theTransport)
                                     throws InteractionClassNotRecognized,
                                            InteractionParameterNotRecognized,
                                            InteractionClassNotSubscribed,
                                            FederateInternalError

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

Specified by:: receiveHLAenableTimeConstrained in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; 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

receiveHLAdisableTimeConstrained

public void receiveHLAdisableTimeConstrained(byte[] HLAfederate,
                                             byte[] userSuppliedTag,
                                             OrderType sentOrdering,
                                             TransportationType theTransport)
                                      throws InteractionClassNotRecognized,
                                             InteractionParameterNotRecognized,
                                             InteractionClassNotSubscribed,
                                             FederateInternalError

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

Specified by:: receiveHLAdisableTimeConstrained in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; 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

receiveHLAtimeAdvanceRequest

public void receiveHLAtimeAdvanceRequest(byte[] HLAfederate,
                                         byte[] HLAtimeStamp,
                                         byte[] userSuppliedTag,
                                         OrderType sentOrdering,
                                         TransportationType theTransport)
                                  throws InteractionClassNotRecognized,
                                         InteractionParameterNotRecognized,
                                         InteractionClassNotSubscribed,
                                         FederateInternalError

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.

Specified by:: receiveHLAtimeAdvanceRequest in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAtimeStamp - Time stamp requested.; 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

receiveHLAtimeAdvanceRequestAvailable

public void receiveHLAtimeAdvanceRequestAvailable(byte[] HLAfederate,
                                                  byte[] HLAtimeStamp,
                                                  byte[] userSuppliedTag,
                                                  OrderType sentOrdering,
                                                  TransportationType theTransport)
                                           throws InteractionClassNotRecognized,
                                                  InteractionParameterNotRecognized,
                                                  InteractionClassNotSubscribed,
                                                  FederateInternalError

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.

Specified by:: receiveHLAtimeAdvanceRequestAvailable in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAtimeStamp - Time stamp requested.; 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

receiveHLAnextMessageRequest

public void receiveHLAnextMessageRequest(byte[] HLAfederate,
                                         byte[] HLAtimeStamp,
                                         byte[] userSuppliedTag,
                                         OrderType sentOrdering,
                                         TransportationType theTransport)
                                  throws InteractionClassNotRecognized,
                                         InteractionParameterNotRecognized,
                                         InteractionClassNotSubscribed,
                                         FederateInternalError

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.

Specified by:: receiveHLAnextMessageRequest in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAtimeStamp - Time stamp requested.; 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

receiveHLAnextMessageRequestAvailable

public void receiveHLAnextMessageRequestAvailable(byte[] HLAfederate,
                                                  byte[] HLAtimeStamp,
                                                  byte[] userSuppliedTag,
                                                  OrderType sentOrdering,
                                                  TransportationType theTransport)
                                           throws InteractionClassNotRecognized,
                                                  InteractionParameterNotRecognized,
                                                  InteractionClassNotSubscribed,
                                                  FederateInternalError

Specified by:: receiveHLAnextMessageRequestAvailable in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAtimeStamp - Time stamp requested.; 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

receiveHLAflushQueueRequest

public void receiveHLAflushQueueRequest(byte[] HLAfederate,
                                        byte[] HLAtimeStamp,
                                        byte[] userSuppliedTag,
                                        OrderType sentOrdering,
                                        TransportationType theTransport)
                                 throws InteractionClassNotRecognized,
                                        InteractionParameterNotRecognized,
                                        InteractionClassNotSubscribed,
                                        FederateInternalError

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.

Specified by:: receiveHLAflushQueueRequest in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAtimeStamp - Time stamp requested.; 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

receiveHLAenableAsynchronousDelivery

public void receiveHLAenableAsynchronousDelivery(byte[] HLAfederate,
                                                 byte[] userSuppliedTag,
                                                 OrderType sentOrdering,
                                                 TransportationType theTransport)
                                          throws InteractionClassNotRecognized,
                                                 InteractionParameterNotRecognized,
                                                 InteractionClassNotSubscribed,
                                                 FederateInternalError

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

Specified by:: receiveHLAenableAsynchronousDelivery in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; 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

receiveHLAdisableAsynchronousDelivery

public void receiveHLAdisableAsynchronousDelivery(byte[] HLAfederate,
                                                  byte[] userSuppliedTag,
                                                  OrderType sentOrdering,
                                                  TransportationType theTransport)
                                           throws InteractionClassNotRecognized,
                                                  InteractionParameterNotRecognized,
                                                  InteractionClassNotSubscribed,
                                                  FederateInternalError

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.

Specified by:: receiveHLAdisableAsynchronousDelivery in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; 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

receiveHLAmodifyLookahead

public void receiveHLAmodifyLookahead(byte[] HLAfederate,
                                      byte[] HLAlookahead,
                                      byte[] userSuppliedTag,
                                      OrderType sentOrdering,
                                      TransportationType theTransport)
                               throws InteractionClassNotRecognized,
                                      InteractionParameterNotRecognized,
                                      InteractionClassNotSubscribed,
                                      FederateInternalError

Change the lookahead value used by the joined federate.

Specified by:: receiveHLAmodifyLookahead in interface ManagementInteractionListener

Parameters:: HLAfederate - Handle of the joined federate that was provided when joining.; HLAlookahead - New value for lookahead.; 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

receiveHLAchangeAttributeOrderType

public void receiveHLAchangeAttributeOrderType(byte[] HLAfederate,
                                               byte[] HLAobjectInstance,
                                               byte[][] HLAattributeList,
                                               HLAorderType HLAsendOrder,
                                               byte[] userSuppliedTag,
                                               OrderType sentOrdering,
                                               TransportationType theTransport)
                                        throws InteractionClassNotRecognized,
                                               InteractionParameterNotRecognized,
                                               InteractionClassNotSubscribed,
                                               FederateInternalError

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

Specified by:: receiveHLAchangeAttributeOrderType in interface ManagementInteractionListener

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 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

receiveHLAchangeInteractionOrderType

public void receiveHLAchangeInteractionOrderType(byte[] HLAfederate,
                                                 byte[] HLAinteractionClass,
                                                 HLAorderType HLAsendOrder,
                                                 byte[] userSuppliedTag,
                                                 OrderType sentOrdering,
                                                 TransportationType theTransport)
                                          throws InteractionClassNotRecognized,
                                                 InteractionParameterNotRecognized,
                                                 InteractionClassNotSubscribed,
                                                 FederateInternalError

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

Specified by:: receiveHLAchangeInteractionOrderType in interface ManagementInteractionListener

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 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

receiveHLAsetSwitches

public void receiveHLAsetSwitches(HLAswitch HLAautoProvide,
                                  HLAswitch HLAconveyRegionDesignatorSets,
                                  byte[] userSuppliedTag,
                                  OrderType sentOrdering,
                                  TransportationType theTransport)
                           throws InteractionClassNotRecognized,
                                  InteractionParameterNotRecognized,
                                  InteractionClassNotSubscribed,
                                  FederateInternalError

Set the values of several HLA switches.

Specified by:: receiveHLAsetSwitches in interface ManagementInteractionListener

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 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

receiveHLAresultBoolean

public void receiveHLAresultBoolean(boolean result,
                                    byte[] userSuppliedTag,
                                    OrderType sentOrdering,
                                    TransportationType theTransport)
                             throws InteractionClassNotRecognized,
                                    InteractionParameterNotRecognized,
                                    InteractionClassNotSubscribed,
                                    FederateInternalError

Notifies the federate about the result of last invoked service.

Specified by:: receiveHLAresultBoolean in interface BootstrapInteractionListener

Parameters:: result - Result of last invoked service.; 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

decodeLogicalTime

protected LogicalTime decodeLogicalTime(byte[] theTime)
                                 throws CouldNotDecode

Decodes and returns the logical time stored in the specified buffer.

Parameters:: theTime - encoded logical time
Returns:: decoded logical time
Throws:: CouldNotDecode - if the value could not be decoded

receiveHLAtimeRegulationEnabled

public void receiveHLAtimeRegulationEnabled(byte[] time,
                                            byte[] userSuppliedTag,
                                            OrderType sentOrdering,
                                            TransportationType theTransport)
                                     throws InteractionClassNotRecognized,
                                            InteractionParameterNotRecognized,
                                            InteractionClassNotSubscribed,
                                            FederateInternalError

Notifies the federate that time regulation has been enabled.

Specified by:: receiveHLAtimeRegulationEnabled in interface BootstrapInteractionListener

Parameters:: time - the current logical time; 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

receiveHLAtimeConstrainedEnabled

public void receiveHLAtimeConstrainedEnabled(byte[] time,
                                             byte[] userSuppliedTag,
                                             OrderType sentOrdering,
                                             TransportationType theTransport)
                                      throws InteractionClassNotRecognized,
                                             InteractionParameterNotRecognized,
                                             InteractionClassNotSubscribed,
                                             FederateInternalError

Notifies the federate that time-constrained mode has been enabled.

Specified by:: receiveHLAtimeConstrainedEnabled in interface BootstrapInteractionListener

Parameters:: time - the current logical time; 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

receiveHLAtimeAdvanceGrant

public void receiveHLAtimeAdvanceGrant(byte[] theTime,
                                       byte[] userSuppliedTag,
                                       OrderType sentOrdering,
                                       TransportationType theTransport)
                                throws InteractionClassNotRecognized,
                                       InteractionParameterNotRecognized,
                                       InteractionClassNotSubscribed,
                                       FederateInternalError

Notifies the federate that a time advance has been granted.

Specified by:: receiveHLAtimeAdvanceGrant in interface BootstrapInteractionListener

Parameters:: theTime - the new logical time; 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

isZeroLookaheadRestricted

protected boolean isZeroLookaheadRestricted()

Returns true if federate is subject of zero lookahead restriction, false otherwise.

Returns:: true if federate is subject of zero lookahead restriction, false otherwise

turnZeroLookaheadRestrictionOn

protected void turnZeroLookaheadRestrictionOn(LogicalTime theTime)

Turns on the zero lookahead restriction.

Parameters:: theTime - logical time at which zero lookahead restriction should be turned on

turnZeroLookaheadRestrictionOffIfPossible

protected void turnZeroLookaheadRestrictionOffIfPossible(LogicalTime theTime)

Turns off the zero lookahead restriction if it is possible.

Parameters:: theTime - logical time at which zero lookahead restriction should be turned off

receiveHLAregisterFederationSynchronizationPoint

public void receiveHLAregisterFederationSynchronizationPoint(java.lang.String synchronizationPointLabel,
                                                             byte[] userSuppliedTag,
                                                             OrderType sentOrdering,
                                                             TransportationType theTransport)
                                                      throws InteractionClassNotRecognized,
                                                             InteractionParameterNotRecognized,
                                                             InteractionClassNotSubscribed,
                                                             FederateInternalError

Federate's request for registering a federation synchronization point.

Specified by:: receiveHLAregisterFederationSynchronizationPoint in interface BootstrapInteractionListener

Parameters:: synchronizationPointLabel - Label associated with the synchronization point.; 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

receiveHLAsynchronizationPointRegistrationSucceeded

public void receiveHLAsynchronizationPointRegistrationSucceeded(java.lang.String synchronizationPointLabel,
                                                                byte[] userSuppliedTag,
                                                                OrderType sentOrdering,
                                                                TransportationType theTransport)
                                                         throws InteractionClassNotRecognized,
                                                                InteractionParameterNotRecognized,
                                                                InteractionClassNotSubscribed,
                                                                FederateInternalError

Notifies the federate that the synchronization point registration operation has succeeded.

Specified by:: receiveHLAsynchronizationPointRegistrationSucceeded in interface BootstrapInteractionListener

Parameters:: synchronizationPointLabel - Label associated with the synchronization point.; 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

receiveHLAsynchronizationPointRegistrationFailed

public void receiveHLAsynchronizationPointRegistrationFailed(java.lang.String synchronizationPointLabel,
                                                             byte[] userSuppliedTag,
                                                             OrderType sentOrdering,
                                                             TransportationType theTransport)
                                                      throws InteractionClassNotRecognized,
                                                             InteractionParameterNotRecognized,
                                                             InteractionClassNotSubscribed,
                                                             FederateInternalError

Notifies the federate that the synchronization point registration operation has failed.

Specified by:: receiveHLAsynchronizationPointRegistrationFailed in interface BootstrapInteractionListener

Parameters:: synchronizationPointLabel - Label associated with the synchronization point.; 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

receiveHLAannounceSynchronizationPoint

public void receiveHLAannounceSynchronizationPoint(java.lang.String synchronizationPointLabel,
                                                   byte[] userSuppliedTag,
                                                   OrderType sentOrdering,
                                                   TransportationType theTransport)
                                            throws InteractionClassNotRecognized,
                                                   InteractionParameterNotRecognized,
                                                   InteractionClassNotSubscribed,
                                                   FederateInternalError

Notifies the federate that a synchronization point has been announced.

Specified by:: receiveHLAannounceSynchronizationPoint in interface BootstrapInteractionListener

Parameters:: synchronizationPointLabel - Label associated with the synchronization point.; 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

receiveHLAfederationSynchronized

public void receiveHLAfederationSynchronized(java.lang.String synchronizationPointLabel,
                                             byte[] userSuppliedTag,
                                             OrderType sentOrdering,
                                             TransportationType theTransport)
                                      throws InteractionClassNotRecognized,
                                             InteractionParameterNotRecognized,
                                             InteractionClassNotSubscribed,
                                             FederateInternalError

Notifies the federate that the federation has been synchronized.

Specified by:: receiveHLAfederationSynchronized in interface BootstrapInteractionListener

Parameters:: synchronizationPointLabel - Label associated with the synchronization point.; 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

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 Class XRTIAmbassador

HLA_META_FEDERATION_EXECUTION

logicalTimeFactory

logicalTimeIntervalFactory

timeRegulationEnabled

timeConstrainedEnabled

asynchronousDeliveryEnabled

channel

proxyAmbassador

bootstrapProxyAmbassador

metaFederationProxyAmbassador

reflectionProxyAmbassador

managementProxyAmbassador

handleCounter

joinedFederationExecutionName

joinedFederationExecutionHandle

descriptorManager

logicalTime

lookahead

requestedLogicalTime

inTimeAdvancingState

XRTIAmbassador

debug

verifyFederateIsExecutionMember

verifyNoSaveInProgress

verifyNoRestoreInProgress

verifyFederateIsNotInTimeAdvancingState

verifyRequestForTimeRegulationIsNotPending

verifyRequestForTimeConstrainedIsNotPending

verifyTimeStampIsValid

verifyRequestedTimeIsValid

verifyLookaheadIsValid

getHLAversion

getAttributeHandleFactory

getAttributeHandleSetFactory

getAttributeHandleValueMapFactory

getAttributeSetRegionSetPairListFactory

getDimensionHandleFactory

getDimensionHandleSetFactory

getFederateHandleFactory

getFederateHandleSetFactory

getInteractionClassHandleFactory

getObjectClassHandleFactory

getObjectInstanceHandleFactory

getParameterHandleFactory

getParameterHandleValueMapFactory

getRegionHandleSetFactory

initializeRTI

createDescriptorManagerAndProxyAmbassadors

createMessageThreads

proxyAmbassador_receiveInteraction

finalizeRTI

createFederationExecution

destroyFederationExecution

joinFederationExecution

resignFederationExecution

mergeFDD

enableCallbacks

disableCallbacks

evokeCallback

evokeMultipleCallbacks

getObjectClassHandle

getObjectClassName

getAttributeHandle

getAttributeName

getInteractionClassHandle

getInteractionClassName

getParameterHandle

getParameterName

getObjectInstanceHandle

getObjectInstanceName

getDimensionHandle

getDimensionName

getDimensionUpperBound

getAvailableDimensionsForClassAttribute

getKnownObjectClassHandle

getAvailableDimensionsForInteractionClass

getTransportationType

getTransportationName

getOrderType

org.npsnet.xrti
Class XRTIAmbassador