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

hla.rti
Interface RTIambassador

All Known Subinterfaces:: RTIambassadorEx

All Known Implementing Classes:: XRTIAmbassador

public interface RTIambassador

The principal interface of the run-time infrastructure.

Author:: DMSO

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.
`void`	`createFederationExecution(java.lang.String federationExecutionName, java.net.URL fdd)` Creates a new federation execution.
`RegionHandle`	`createRegion(DimensionHandleSet dimensions)` Creates a new region with the specified dimensions.
`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 theHandle)` 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.
`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`	`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.
`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`	`registerFederationSynchronizationPoint(java.lang.String synchronizationPointLabel, byte[] userSuppliedTag)` Registers a federation synchronization point.
`void`	`registerFederationSynchronizationPoint(java.lang.String synchronizationPointLabel, 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.
`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 synchronizationPointLabel)` 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.
`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.

Method Detail

getHLAversion

public java.lang.String getHLAversion()

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

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.

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

getAttributeHandleSetFactory

public AttributeHandleSetFactory getAttributeHandleSetFactory()

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

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.

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.

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.

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

getDimensionHandleSetFactory

public DimensionHandleSetFactory getDimensionHandleSetFactory()

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

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

getFederateHandleFactory

public FederateHandleFactory getFederateHandleFactory()

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

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

getFederateHandleSetFactory

public FederateHandleSetFactory getFederateHandleSetFactory()

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

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

getInteractionClassHandleFactory

public InteractionClassHandleFactory getInteractionClassHandleFactory()

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

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

getObjectClassHandleFactory

public ObjectClassHandleFactory getObjectClassHandleFactory()

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

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

getObjectInstanceHandleFactory

public ObjectInstanceHandleFactory getObjectInstanceHandleFactory()

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

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

getParameterHandleFactory

public ParameterHandleFactory getParameterHandleFactory()

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

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

getParameterHandleValueMapFactory

public ParameterHandleValueMapFactory getParameterHandleValueMapFactory()

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

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.

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.

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

finalizeRTI

public void finalizeRTI()
                 throws InitializeNeverInvoked,
                        SomeFederateJoinedToAnExecution,
                        RTIinternalError

Finalizes the run-time infrastructure.

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.

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.

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.

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.

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

enableCallbacks

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

Enables callbacks.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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 theHandle)
                              throws InvalidOrderType,
                                     FederateNotExecutionMember,
                                     RTIinternalError

Returns the name corresponding to the specified 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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

sendInteraction

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

Sends an interaction.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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 synchronizationPointLabel,
                                                   byte[] userSuppliedTag)
                                            throws FederateNotExecutionMember,
                                                   SaveInProgress,
                                                   RestoreInProgress,
                                                   RTIinternalError

Registers a federation synchronization point.

Parameters:: synchronizationPointLabel - the label of the synchronization point; userSuppliedTag - a user-supplied tag to associate with the operation
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 synchronizationPointLabel,
                                                   byte[] userSuppliedTag,
                                                   FederateHandleSet synchronizationSet)
                                            throws FederateNotExecutionMember,
                                                   SaveInProgress,
                                                   RestoreInProgress,
                                                   RTIinternalError

Registers a federation synchronization point.

Parameters:: synchronizationPointLabel - the label of the synchronization point; userSuppliedTag - a user-supplied tag to associate with the operation; synchronizationSet - the set of federates to synchronize
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 synchronizationPointLabel)
                                  throws SynchronizationPointLabelNotAnnounced,
                                         FederateNotExecutionMember,
                                         SaveInProgress,
                                         RestoreInProgress,
                                         RTIinternalError

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

Parameters:: synchronizationPointLabel - 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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

hla.rti Interface RTIambassador

getHLAversion

getAttributeHandleFactory

getAttributeHandleSetFactory

getAttributeHandleValueMapFactory

getAttributeSetRegionSetPairListFactory

getDimensionHandleFactory

getDimensionHandleSetFactory

getFederateHandleFactory

getFederateHandleSetFactory

getInteractionClassHandleFactory

getObjectClassHandleFactory

getObjectInstanceHandleFactory

getParameterHandleFactory

getParameterHandleValueMapFactory

getRegionHandleSetFactory

initializeRTI

finalizeRTI

createFederationExecution

destroyFederationExecution

joinFederationExecution

resignFederationExecution

enableCallbacks

disableCallbacks

evokeCallback

evokeMultipleCallbacks

getObjectClassHandle

getObjectClassName

getAttributeHandle

getAttributeName

getInteractionClassHandle

getInteractionClassName

getParameterHandle

getParameterName

getObjectInstanceHandle

getObjectInstanceName

getDimensionHandle

getDimensionName

getDimensionUpperBound

getAvailableDimensionsForClassAttribute

getKnownObjectClassHandle

getAvailableDimensionsForInteractionClass

getTransportationType

getTransportationName

getOrderType

getOrderName

enableObjectClassRelevanceAdvisorySwitch

disableObjectClassRelevanceAdvisorySwitch

enableAttributeRelevanceAdvisorySwitch

disableAttributeRelevanceAdvisorySwitch

enableAttributeScopeAdvisorySwitch

disableAttributeScopeAdvisorySwitch

enableInteractionRelevanceAdvisorySwitch

disableInteractionRelevanceAdvisorySwitch

getDimensionHandleSet

getRangeBounds

setRangeBounds

normalizeFederateHandle

normalizeServiceGroup

publishObjectClassAttributes

unpublishObjectClass

unpublishObjectClassAttributes

publishInteractionClass

unpublishInteractionClass

subscribeObjectClassAttributes

subscribeObjectClassAttributesPassively

unsubscribeObjectClass

unsubscribeObjectClassAttributes

subscribeInteractionClass

subscribeInteractionClassPassively

unsubscribeInteractionClass

reserveObjectInstanceName

registerObjectInstance

registerObjectInstance

updateAttributeValues

updateAttributeValues

sendInteraction

sendInteraction

deleteObjectInstance

deleteObjectInstance

hla.rti
Interface RTIambassador