org.npsnet.xrti.proxies
Class BootstrapProxyAmbassador

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

All Implemented Interfaces:

FederateAmbassador

public class BootstrapProxyAmbassador

extends ProxyAmbassador

Autogenerated proxy ambassador.

Author:

org.npsnet.xrti.utilities.ProxyCompiler

Field Summary

private ParameterHandle	HLAannounceSynchronizationPoint_synchronizationPointLabelHandle Handle for the synchronizationPointLabel parameter of the HLAannounceSynchronizationPoint interaction.
private InteractionClassHandle	HLAannounceSynchronizationPointHandle Handle for the HLAannounceSynchronizationPoint interaction.
private InteractionClassHandle	HLAcontinueHandle Handle for the HLAcontinue interaction.
private ParameterHandle	HLAfederationSynchronized_synchronizationPointLabelHandle Handle for the synchronizationPointLabel parameter of the HLAfederationSynchronized interaction.
private InteractionClassHandle	HLAfederationSynchronizedHandle Handle for the HLAfederationSynchronized interaction.
private ParameterHandle	HLAinteractionFragment_fragmentContentsHandle Handle for the fragmentContents parameter of the HLAinteractionFragment interaction.
private ParameterHandle	HLAinteractionFragment_fragmentOffsetHandle Handle for the fragmentOffset parameter of the HLAinteractionFragment interaction.
private ParameterHandle	HLAinteractionFragment_interactionNumberHandle Handle for the interactionNumber parameter of the HLAinteractionFragment interaction.
private ParameterHandle	HLAinteractionFragment_interactionSizeHandle Handle for the interactionSize parameter of the HLAinteractionFragment interaction.
private InteractionClassHandle	HLAinteractionFragmentHandle Handle for the HLAinteractionFragment interaction.
private ParameterHandle	HLAregisterFederationSynchronizationPoint_synchronizationPointLabelHandle Handle for the synchronizationPointLabel parameter of the HLAregisterFederationSynchronizationPoint interaction.
private InteractionClassHandle	HLAregisterFederationSynchronizationPointHandle Handle for the HLAregisterFederationSynchronizationPoint interaction.
private ParameterHandle	HLAregisterObjectInstance_objectClassHandleHandle Handle for the objectClassHandle parameter of the HLAregisterObjectInstance interaction.
private ParameterHandle	HLAregisterObjectInstance_objectInstanceHandleHandle Handle for the objectInstanceHandle parameter of the HLAregisterObjectInstance interaction.
private ParameterHandle	HLAregisterObjectInstance_objectNameHandle Handle for the objectName parameter of the HLAregisterObjectInstance interaction.
private InteractionClassHandle	HLAregisterObjectInstanceHandle Handle for the HLAregisterObjectInstance interaction.
private ParameterHandle	HLAreportHandles_blockSizeHandle Handle for the blockSize parameter of the HLAreportHandles interaction.
private ParameterHandle	HLAreportHandles_blockStartHandle Handle for the blockStart parameter of the HLAreportHandles interaction.
private InteractionClassHandle	HLAreportHandlesHandle Handle for the HLAreportHandles interaction.
private ParameterHandle	HLArequestAttributeValueUpdate_attributeHandleListHandle Handle for the attributeHandleList parameter of the HLArequestAttributeValueUpdate interaction.
private ParameterHandle	HLArequestAttributeValueUpdate_objectInstanceHandleHandle Handle for the objectInstanceHandle parameter of the HLArequestAttributeValueUpdate interaction.
private InteractionClassHandle	HLArequestAttributeValueUpdateHandle Handle for the HLArequestAttributeValueUpdate interaction.
private ParameterHandle	HLArequestHandles_blockSizeHandle Handle for the blockSize parameter of the HLArequestHandles interaction.
private InteractionClassHandle	HLArequestHandlesHandle Handle for the HLArequestHandles interaction.
private ParameterHandle	HLAresultBoolean_resultHandle Handle for the result parameter of the HLAresultBoolean interaction.
private InteractionClassHandle	HLAresultBooleanHandle Handle for the HLAresultBoolean interaction.
private ParameterHandle	HLAsynchronizationPointRegistrationFailed_synchronizationPointLabelHandle Handle for the synchronizationPointLabel parameter of the HLAsynchronizationPointRegistrationFailed interaction.
private InteractionClassHandle	HLAsynchronizationPointRegistrationFailedHandle Handle for the HLAsynchronizationPointRegistrationFailed interaction.
private ParameterHandle	HLAsynchronizationPointRegistrationSucceeded_synchronizationPointLabelHandle Handle for the synchronizationPointLabel parameter of the HLAsynchronizationPointRegistrationSucceeded interaction.
private InteractionClassHandle	HLAsynchronizationPointRegistrationSucceededHandle Handle for the HLAsynchronizationPointRegistrationSucceeded interaction.
private ParameterHandle	HLAtimeAdvanceGrant_theTimeHandle Handle for the theTime parameter of the HLAtimeAdvanceGrant interaction.
private InteractionClassHandle	HLAtimeAdvanceGrantHandle Handle for the HLAtimeAdvanceGrant interaction.
private ParameterHandle	HLAtimeConstrainedEnabled_timeHandle Handle for the time parameter of the HLAtimeConstrainedEnabled interaction.
private InteractionClassHandle	HLAtimeConstrainedEnabledHandle Handle for the HLAtimeConstrainedEnabled interaction.
private ParameterHandle	HLAtimeRegulationEnabled_timeHandle Handle for the time parameter of the HLAtimeRegulationEnabled interaction.
private InteractionClassHandle	HLAtimeRegulationEnabledHandle Handle for the HLAtimeRegulationEnabled interaction.
private ParameterHandle	HLAupdateAttributeValuesBestEffort_attributeHandleValuePairListHandle Handle for the attributeHandleValuePairList parameter of the HLAupdateAttributeValuesBestEffort interaction.
private ParameterHandle	HLAupdateAttributeValuesBestEffort_objectInstanceHandleHandle Handle for the objectInstanceHandle parameter of the HLAupdateAttributeValuesBestEffort interaction.
private InteractionClassHandle	HLAupdateAttributeValuesBestEffortHandle Handle for the HLAupdateAttributeValuesBestEffort interaction.
private ParameterHandle	HLAupdateAttributeValuesReliable_attributeHandleValuePairListHandle Handle for the attributeHandleValuePairList parameter of the HLAupdateAttributeValuesReliable interaction.
private ParameterHandle	HLAupdateAttributeValuesReliable_objectInstanceHandleHandle Handle for the objectInstanceHandle parameter of the HLAupdateAttributeValuesReliable interaction.
private InteractionClassHandle	HLAupdateAttributeValuesReliableHandle Handle for the HLAupdateAttributeValuesReliable interaction.
private java.util.Vector	interactionListeners The list of interaction listeners.

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

objectInstanceHandleProxyMap, proxyAmbassadorListeners, rtiAmbassador

Constructor Summary

BootstrapProxyAmbassador(RTIambassador pRTIAmbassador)
Constructor.

Method Summary

void	addInteractionListener(BootstrapInteractionListener il) Adds a listener for the interactions processed by this ambassador.
void	publishAndSubscribeObjectClassAttributes() Publishes and subscribes all supported object class attributes.
void	receiveInteraction(InteractionClassHandle interactionClass, ParameterHandleValueMap theParameters, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) Notifies the federate of a received interaction.
void	removeInteractionListener(BootstrapInteractionListener il) Removes a listener for the interactions processed by this ambassador.
void	sendHLAannounceSynchronizationPoint(java.lang.String synchronizationPointLabel, byte[] userSuppliedTag) Notifies the federate that a synchronization point has been announced.
void	sendHLAcontinue(byte[] userSuppliedTag) Notifies the federate that the executive is done sending callbacks.
void	sendHLAfederationSynchronized(java.lang.String synchronizationPointLabel, byte[] userSuppliedTag) Notifies the federate that the federation has been synchronized.
void	sendHLAinteractionFragment(int interactionNumber, int interactionSize, int fragmentOffset, byte[] fragmentContents, byte[] userSuppliedTag) A piece of a fragmented interaction.
void	sendHLAregisterFederationSynchronizationPoint(java.lang.String synchronizationPointLabel, byte[] userSuppliedTag) Federate's request for registering a federation synchronization point.
void	sendHLAregisterObjectInstance(java.lang.String objectName, long objectInstanceHandle, long objectClassHandle, byte[] userSuppliedTag) Registers a new object instance.
void	sendHLAreportHandles(long blockStart, long blockSize, byte[] userSuppliedTag) Reports a block of handles.
void	sendHLArequestAttributeValueUpdate(long objectInstanceHandle, long[] attributeHandleList, byte[] userSuppliedTag) Requests an attribute value update.
void	sendHLArequestHandles(long blockSize, byte[] userSuppliedTag) Requests a block of handles.
void	sendHLAresultBoolean(boolean result, byte[] userSuppliedTag) Notifies the federate about the result of last invoked service.
void	sendHLAsynchronizationPointRegistrationFailed(java.lang.String synchronizationPointLabel, byte[] userSuppliedTag) Notifies the federate that the synchronization point registration operation has failed.
void	sendHLAsynchronizationPointRegistrationSucceeded(java.lang.String synchronizationPointLabel, byte[] userSuppliedTag) Notifies the federate that the synchronization point registration operation has succeeded.
void	sendHLAtimeAdvanceGrant(byte[] theTime, byte[] userSuppliedTag) Notifies the federate that a time advance has been granted.
void	sendHLAtimeConstrainedEnabled(byte[] time, byte[] userSuppliedTag) Notifies the federate that time-constrained mode has been enabled.
void	sendHLAtimeRegulationEnabled(byte[] time, byte[] userSuppliedTag) Notifies the federate that time regulation has been enabled.
void	sendHLAupdateAttributeValuesBestEffort(long objectInstanceHandle, HLAattributeHandleValuePair[] attributeHandleValuePairList, byte[] userSuppliedTag) Updates a set of attribute values with best-effort transportation and receive ordering.
void	sendHLAupdateAttributeValuesReliable(long objectInstanceHandle, HLAattributeHandleValuePair[] attributeHandleValuePairList, byte[] userSuppliedTag) Updates a set of attribute values with reliable transportation and receive ordering.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

interactionListeners

private java.util.Vector interactionListeners

The list of interaction listeners.

HLAinteractionFragmentHandle

private InteractionClassHandle HLAinteractionFragmentHandle

Handle for the HLAinteractionFragment interaction.

HLAinteractionFragment_interactionNumberHandle

private ParameterHandle HLAinteractionFragment_interactionNumberHandle

Handle for the interactionNumber parameter of the HLAinteractionFragment interaction.

HLAinteractionFragment_interactionSizeHandle

private ParameterHandle HLAinteractionFragment_interactionSizeHandle

Handle for the interactionSize parameter of the HLAinteractionFragment interaction.

HLAinteractionFragment_fragmentOffsetHandle

private ParameterHandle HLAinteractionFragment_fragmentOffsetHandle

Handle for the fragmentOffset parameter of the HLAinteractionFragment interaction.

HLAinteractionFragment_fragmentContentsHandle

private ParameterHandle HLAinteractionFragment_fragmentContentsHandle

Handle for the fragmentContents parameter of the HLAinteractionFragment interaction.

HLArequestHandlesHandle

private InteractionClassHandle HLArequestHandlesHandle

Handle for the HLArequestHandles interaction.

HLArequestHandles_blockSizeHandle

private ParameterHandle HLArequestHandles_blockSizeHandle

Handle for the blockSize parameter of the HLArequestHandles interaction.

HLAreportHandlesHandle

private InteractionClassHandle HLAreportHandlesHandle

Handle for the HLAreportHandles interaction.

HLAreportHandles_blockStartHandle

private ParameterHandle HLAreportHandles_blockStartHandle

Handle for the blockStart parameter of the HLAreportHandles interaction.

HLAreportHandles_blockSizeHandle

private ParameterHandle HLAreportHandles_blockSizeHandle

Handle for the blockSize parameter of the HLAreportHandles interaction.

HLAcontinueHandle

private InteractionClassHandle HLAcontinueHandle

Handle for the HLAcontinue interaction.

HLAregisterObjectInstanceHandle

private InteractionClassHandle HLAregisterObjectInstanceHandle

Handle for the HLAregisterObjectInstance interaction.

HLAregisterObjectInstance_objectNameHandle

private ParameterHandle HLAregisterObjectInstance_objectNameHandle

Handle for the objectName parameter of the HLAregisterObjectInstance interaction.

HLAregisterObjectInstance_objectInstanceHandleHandle

private ParameterHandle HLAregisterObjectInstance_objectInstanceHandleHandle

Handle for the objectInstanceHandle parameter of the HLAregisterObjectInstance interaction.

HLAregisterObjectInstance_objectClassHandleHandle

private ParameterHandle HLAregisterObjectInstance_objectClassHandleHandle

Handle for the objectClassHandle parameter of the HLAregisterObjectInstance interaction.

HLArequestAttributeValueUpdateHandle

private InteractionClassHandle HLArequestAttributeValueUpdateHandle

Handle for the HLArequestAttributeValueUpdate interaction.

HLArequestAttributeValueUpdate_objectInstanceHandleHandle

private ParameterHandle HLArequestAttributeValueUpdate_objectInstanceHandleHandle

Handle for the objectInstanceHandle parameter of the HLArequestAttributeValueUpdate interaction.

HLArequestAttributeValueUpdate_attributeHandleListHandle

private ParameterHandle HLArequestAttributeValueUpdate_attributeHandleListHandle

Handle for the attributeHandleList parameter of the HLArequestAttributeValueUpdate interaction.

HLAupdateAttributeValuesBestEffortHandle

private InteractionClassHandle HLAupdateAttributeValuesBestEffortHandle

Handle for the HLAupdateAttributeValuesBestEffort interaction.

HLAupdateAttributeValuesBestEffort_objectInstanceHandleHandle

private ParameterHandle HLAupdateAttributeValuesBestEffort_objectInstanceHandleHandle

Handle for the objectInstanceHandle parameter of the HLAupdateAttributeValuesBestEffort interaction.

HLAupdateAttributeValuesBestEffort_attributeHandleValuePairListHandle

private ParameterHandle HLAupdateAttributeValuesBestEffort_attributeHandleValuePairListHandle

Handle for the attributeHandleValuePairList parameter of the HLAupdateAttributeValuesBestEffort interaction.

HLAupdateAttributeValuesReliableHandle

private InteractionClassHandle HLAupdateAttributeValuesReliableHandle

Handle for the HLAupdateAttributeValuesReliable interaction.

HLAupdateAttributeValuesReliable_objectInstanceHandleHandle

private ParameterHandle HLAupdateAttributeValuesReliable_objectInstanceHandleHandle

Handle for the objectInstanceHandle parameter of the HLAupdateAttributeValuesReliable interaction.

HLAupdateAttributeValuesReliable_attributeHandleValuePairListHandle

private ParameterHandle HLAupdateAttributeValuesReliable_attributeHandleValuePairListHandle

Handle for the attributeHandleValuePairList parameter of the HLAupdateAttributeValuesReliable interaction.

HLAresultBooleanHandle

private InteractionClassHandle HLAresultBooleanHandle

Handle for the HLAresultBoolean interaction.

HLAresultBoolean_resultHandle

private ParameterHandle HLAresultBoolean_resultHandle

Handle for the result parameter of the HLAresultBoolean interaction.

HLAtimeRegulationEnabledHandle

private InteractionClassHandle HLAtimeRegulationEnabledHandle

Handle for the HLAtimeRegulationEnabled interaction.

HLAtimeRegulationEnabled_timeHandle

private ParameterHandle HLAtimeRegulationEnabled_timeHandle

Handle for the time parameter of the HLAtimeRegulationEnabled interaction.

HLAtimeConstrainedEnabledHandle

private InteractionClassHandle HLAtimeConstrainedEnabledHandle

Handle for the HLAtimeConstrainedEnabled interaction.

HLAtimeConstrainedEnabled_timeHandle

private ParameterHandle HLAtimeConstrainedEnabled_timeHandle

Handle for the time parameter of the HLAtimeConstrainedEnabled interaction.

HLAtimeAdvanceGrantHandle

private InteractionClassHandle HLAtimeAdvanceGrantHandle

Handle for the HLAtimeAdvanceGrant interaction.

HLAtimeAdvanceGrant_theTimeHandle

private ParameterHandle HLAtimeAdvanceGrant_theTimeHandle

Handle for the theTime parameter of the HLAtimeAdvanceGrant interaction.

HLAregisterFederationSynchronizationPointHandle

private InteractionClassHandle HLAregisterFederationSynchronizationPointHandle

Handle for the HLAregisterFederationSynchronizationPoint interaction.

HLAregisterFederationSynchronizationPoint_synchronizationPointLabelHandle

private ParameterHandle HLAregisterFederationSynchronizationPoint_synchronizationPointLabelHandle

Handle for the synchronizationPointLabel parameter of the HLAregisterFederationSynchronizationPoint interaction.

HLAsynchronizationPointRegistrationSucceededHandle

private InteractionClassHandle HLAsynchronizationPointRegistrationSucceededHandle

Handle for the HLAsynchronizationPointRegistrationSucceeded interaction.

HLAsynchronizationPointRegistrationSucceeded_synchronizationPointLabelHandle

private ParameterHandle HLAsynchronizationPointRegistrationSucceeded_synchronizationPointLabelHandle

Handle for the synchronizationPointLabel parameter of the HLAsynchronizationPointRegistrationSucceeded interaction.

HLAsynchronizationPointRegistrationFailedHandle

private InteractionClassHandle HLAsynchronizationPointRegistrationFailedHandle

Handle for the HLAsynchronizationPointRegistrationFailed interaction.

HLAsynchronizationPointRegistrationFailed_synchronizationPointLabelHandle

private ParameterHandle HLAsynchronizationPointRegistrationFailed_synchronizationPointLabelHandle

Handle for the synchronizationPointLabel parameter of the HLAsynchronizationPointRegistrationFailed interaction.

HLAannounceSynchronizationPointHandle

private InteractionClassHandle HLAannounceSynchronizationPointHandle

Handle for the HLAannounceSynchronizationPoint interaction.

HLAannounceSynchronizationPoint_synchronizationPointLabelHandle

private ParameterHandle HLAannounceSynchronizationPoint_synchronizationPointLabelHandle

Handle for the synchronizationPointLabel parameter of the HLAannounceSynchronizationPoint interaction.

HLAfederationSynchronizedHandle

private InteractionClassHandle HLAfederationSynchronizedHandle

Handle for the HLAfederationSynchronized interaction.

HLAfederationSynchronized_synchronizationPointLabelHandle

private ParameterHandle HLAfederationSynchronized_synchronizationPointLabelHandle

Handle for the synchronizationPointLabel parameter of the HLAfederationSynchronized interaction.

Constructor Detail

BootstrapProxyAmbassador

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

Constructor.

Parameters:

pRTIAmbassador - the run-time infrastructure ambassador

Throws:

InvalidInteractionClassHandle - if an interaction class handle was invalid

NameNotFound - if an interaction or parameter name was not found

InteractionClassNotDefined - if an interaction class is not defined

FederateServiceInvocationsAreBeingReportedViaMOM - if federate service invocations are being reported via the management object model

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

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurred in the run-time infrastructure

InvalidObjectClassHandle

Method Detail

publishAndSubscribeObjectClassAttributes

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

Publishes and subscribes all supported object class attributes.

Throws:

InvalidObjectClassHandle - if an object class handle is invalid

NameNotFound - if a name is not found

ObjectClassNotDefined - if an object class is undefined

AttributeNotDefined - if an attribute is undefined

FederateNotExecutionMember - if the federate is not an execution member

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurs in the run-time infrastructure

addInteractionListener

public void addInteractionListener(BootstrapInteractionListener il)

Adds a listener for the interactions processed by this ambassador.

Parameters:

il - the listener object to add

removeInteractionListener

public void removeInteractionListener(BootstrapInteractionListener il)

Removes a listener for the interactions processed by this ambassador.

Parameters:

il - the listener object to remove

receiveInteraction

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

Notifies the federate of a received interaction.

Specified by:

receiveInteraction in interface FederateAmbassador

Overrides:

receiveInteraction in class ProxyAmbassador

Parameters:

interactionClass - the class of the received interaction

theParameters - the map between parameter handles and the values of the identified parameters

userSuppliedTag - a user-supplied tag associated with the interaction

sentOrdering - the type of ordering with which the interaction was sent

theTransport - the type of transport associated with the interaction

Throws:

InteractionClassNotRecognized - if the interaction class was not recognized

InteractionParameterNotRecognized - if a parameter of the interaction was not recognized

InteractionClassNotSubscribed - if the federate had not subscribed to the interaction class

FederateInternalError - if an error occurs in the federate

sendHLAinteractionFragment

public void sendHLAinteractionFragment(int interactionNumber,
                                       int interactionSize,
                                       int fragmentOffset,
                                       byte[] fragmentContents,
                                       byte[] userSuppliedTag)
                                throws InteractionClassNotPublished,
                                       InteractionClassNotDefined,
                                       InteractionParameterNotDefined,
                                       FederateNotExecutionMember,
                                       SaveInProgress,
                                       RestoreInProgress,
                                       RTIinternalError

A piece of a fragmented interaction.

Parameters:

interactionNumber - The sequence number of the fragmented interaction.

interactionSize - The size of the fragmented interaction.

fragmentOffset - The offset of this fragment in the buffer.

fragmentContents - The contents of the fragment.

userSuppliedTag - a user-supplied tag to accompany the interaction

Throws:

InteractionClassNotPublished - if the interaction class is not published

InteractionClassNotDefined - if the interaction class is not defined

InteractionParameterNotDefined - if one of the parameters is not defined

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

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLArequestHandles

public void sendHLArequestHandles(long blockSize,
                                  byte[] userSuppliedTag)
                           throws InteractionClassNotPublished,
                                  InteractionClassNotDefined,
                                  InteractionParameterNotDefined,
                                  FederateNotExecutionMember,
                                  SaveInProgress,
                                  RestoreInProgress,
                                  RTIinternalError

Requests a block of handles.

Parameters:

blockSize - The number of handles desired.

userSuppliedTag - a user-supplied tag to accompany the interaction

Throws:

InteractionClassNotPublished - if the interaction class is not published

InteractionClassNotDefined - if the interaction class is not defined

InteractionParameterNotDefined - if one of the parameters is not defined

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

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAreportHandles

public void sendHLAreportHandles(long blockStart,
                                 long blockSize,
                                 byte[] userSuppliedTag)
                          throws InteractionClassNotPublished,
                                 InteractionClassNotDefined,
                                 InteractionParameterNotDefined,
                                 FederateNotExecutionMember,
                                 SaveInProgress,
                                 RestoreInProgress,
                                 RTIinternalError

Reports a block of handles.

Parameters:

blockStart - The first handle in the block.

blockSize - The number of handles in the block.

userSuppliedTag - a user-supplied tag to accompany the interaction

Throws:

InteractionClassNotPublished - if the interaction class is not published

InteractionClassNotDefined - if the interaction class is not defined

InteractionParameterNotDefined - if one of the parameters is not defined

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

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAcontinue

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

Notifies the federate that the executive is done sending callbacks.

Parameters:

userSuppliedTag - a user-supplied tag to accompany the interaction

Throws:

InteractionClassNotPublished - if the interaction class is not published

InteractionClassNotDefined - if the interaction class is not defined

InteractionParameterNotDefined - if one of the parameters is not defined

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

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAregisterObjectInstance

public void sendHLAregisterObjectInstance(java.lang.String objectName,
                                          long objectInstanceHandle,
                                          long objectClassHandle,
                                          byte[] userSuppliedTag)
                                   throws InteractionClassNotPublished,
                                          InteractionClassNotDefined,
                                          InteractionParameterNotDefined,
                                          FederateNotExecutionMember,
                                          SaveInProgress,
                                          RestoreInProgress,
                                          RTIinternalError

Registers a new object instance.

Parameters:

objectName - The name of the object.

objectInstanceHandle - The object instance handle.

objectClassHandle - The object class handle.

userSuppliedTag - a user-supplied tag to accompany the interaction

Throws:

InteractionClassNotPublished - if the interaction class is not published

InteractionClassNotDefined - if the interaction class is not defined

InteractionParameterNotDefined - if one of the parameters is not defined

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

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLArequestAttributeValueUpdate

public void sendHLArequestAttributeValueUpdate(long objectInstanceHandle,
                                               long[] attributeHandleList,
                                               byte[] userSuppliedTag)
                                        throws InteractionClassNotPublished,
                                               InteractionClassNotDefined,
                                               InteractionParameterNotDefined,
                                               FederateNotExecutionMember,
                                               SaveInProgress,
                                               RestoreInProgress,
                                               RTIinternalError

Requests an attribute value update.

Parameters:

objectInstanceHandle - Object instance handle.

attributeHandleList - List of attribute handles.

userSuppliedTag - a user-supplied tag to accompany the interaction

Throws:

InteractionClassNotPublished - if the interaction class is not published

InteractionClassNotDefined - if the interaction class is not defined

InteractionParameterNotDefined - if one of the parameters is not defined

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

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAupdateAttributeValuesBestEffort

public void sendHLAupdateAttributeValuesBestEffort(long objectInstanceHandle,
                                                   HLAattributeHandleValuePair[] attributeHandleValuePairList,
                                                   byte[] userSuppliedTag)
                                            throws InteractionClassNotPublished,
                                                   InteractionClassNotDefined,
                                                   InteractionParameterNotDefined,
                                                   FederateNotExecutionMember,
                                                   SaveInProgress,
                                                   RestoreInProgress,
                                                   RTIinternalError

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

Parameters:

objectInstanceHandle - Object instance handle.

attributeHandleValuePairList - List of attribute handle/value pairs.

userSuppliedTag - a user-supplied tag to accompany the interaction

Throws:

InteractionClassNotPublished - if the interaction class is not published

InteractionClassNotDefined - if the interaction class is not defined

InteractionParameterNotDefined - if one of the parameters is not defined

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

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAupdateAttributeValuesReliable

public void sendHLAupdateAttributeValuesReliable(long objectInstanceHandle,
                                                 HLAattributeHandleValuePair[] attributeHandleValuePairList,
                                                 byte[] userSuppliedTag)
                                          throws InteractionClassNotPublished,
                                                 InteractionClassNotDefined,
                                                 InteractionParameterNotDefined,
                                                 FederateNotExecutionMember,
                                                 SaveInProgress,
                                                 RestoreInProgress,
                                                 RTIinternalError

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

Parameters:

objectInstanceHandle - Object instance handle.

attributeHandleValuePairList - List of attribute handle/value pairs.

userSuppliedTag - a user-supplied tag to accompany the interaction

Throws:

InteractionClassNotPublished - if the interaction class is not published

InteractionClassNotDefined - if the interaction class is not defined

InteractionParameterNotDefined - if one of the parameters is not defined

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

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAresultBoolean

public void sendHLAresultBoolean(boolean result,
                                 byte[] userSuppliedTag)
                          throws InteractionClassNotPublished,
                                 InteractionClassNotDefined,
                                 InteractionParameterNotDefined,
                                 FederateNotExecutionMember,
                                 SaveInProgress,
                                 RestoreInProgress,
                                 RTIinternalError

Notifies the federate about the result of last invoked service.

Parameters:

result - Result of last invoked service.

userSuppliedTag - a user-supplied tag to accompany the interaction

Throws:

InteractionClassNotPublished - if the interaction class is not published

InteractionClassNotDefined - if the interaction class is not defined

InteractionParameterNotDefined - if one of the parameters is not defined

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

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAtimeRegulationEnabled

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

Notifies the federate that time regulation has been enabled.

Parameters:

time - The current logical time

userSuppliedTag - a user-supplied tag to accompany the interaction

Throws:

InteractionClassNotPublished - if the interaction class is not published

InteractionClassNotDefined - if the interaction class is not defined

InteractionParameterNotDefined - if one of the parameters is not defined

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

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAtimeConstrainedEnabled

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

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

Parameters:

time - The current logical time

userSuppliedTag - a user-supplied tag to accompany the interaction

Throws:

InteractionClassNotPublished - if the interaction class is not published

InteractionClassNotDefined - if the interaction class is not defined

InteractionParameterNotDefined - if one of the parameters is not defined

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

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAtimeAdvanceGrant

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

Notifies the federate that a time advance has been granted.

Parameters:

theTime - The new logical time

userSuppliedTag - a user-supplied tag to accompany the interaction

Throws:

InteractionClassNotPublished - if the interaction class is not published

InteractionClassNotDefined - if the interaction class is not defined

InteractionParameterNotDefined - if one of the parameters is not defined

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

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAregisterFederationSynchronizationPoint

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

Federate's request for registering a federation synchronization point.

Parameters:

synchronizationPointLabel - Label associated with the synchronization point.

userSuppliedTag - a user-supplied tag to accompany the interaction

Throws:

InteractionClassNotPublished - if the interaction class is not published

InteractionClassNotDefined - if the interaction class is not defined

InteractionParameterNotDefined - if one of the parameters is not defined

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

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAsynchronizationPointRegistrationSucceeded

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

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

Parameters:

synchronizationPointLabel - Label associated with the synchronization point.

userSuppliedTag - a user-supplied tag to accompany the interaction

Throws:

InteractionClassNotPublished - if the interaction class is not published

InteractionClassNotDefined - if the interaction class is not defined

InteractionParameterNotDefined - if one of the parameters is not defined

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

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAsynchronizationPointRegistrationFailed

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

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

Parameters:

synchronizationPointLabel - Label associated with the synchronization point.

userSuppliedTag - a user-supplied tag to accompany the interaction

Throws:

InteractionClassNotPublished - if the interaction class is not published

InteractionClassNotDefined - if the interaction class is not defined

InteractionParameterNotDefined - if one of the parameters is not defined

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

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAannounceSynchronizationPoint

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

Notifies the federate that a synchronization point has been announced.

Parameters:

synchronizationPointLabel - Label associated with the synchronization point.

userSuppliedTag - a user-supplied tag to accompany the interaction

Throws:

InteractionClassNotPublished - if the interaction class is not published

InteractionClassNotDefined - if the interaction class is not defined

InteractionParameterNotDefined - if one of the parameters is not defined

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

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurs in the run-time infrastructure

sendHLAfederationSynchronized

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

Notifies the federate that the federation has been synchronized.

Parameters:

synchronizationPointLabel - Label associated with the synchronization point.

userSuppliedTag - a user-supplied tag to accompany the interaction

Throws:

InteractionClassNotPublished - if the interaction class is not published

InteractionClassNotDefined - if the interaction class is not defined

InteractionParameterNotDefined - if one of the parameters is not defined

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

SaveInProgress - if a save operation is in progress

RestoreInProgress - if a restore operation is in progress

RTIinternalError - if an internal error occurs in the run-time infrastructure