org.npsnet.xrti.proxies
Interface BootstrapInteractionListener

All Known Implementing Classes:

XRTIAmbassador

public interface BootstrapInteractionListener

Autogenerated interaction listener interface.

Author:

org.npsnet.xrti.utilities.ProxyCompiler

Method Summary

void	receiveHLAannounceSynchronizationPoint(java.lang.String synchronizationPointLabel, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) Notifies the federate that a synchronization point has been announced.
void	receiveHLAcontinue(byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) Notifies the federate that the executive is done sending callbacks.
void	receiveHLAfederationSynchronized(java.lang.String synchronizationPointLabel, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) Notifies the federate that the federation has been synchronized.
void	receiveHLAinteractionFragment(int interactionNumber, int interactionSize, int fragmentOffset, byte[] fragmentContents, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) A piece of a fragmented interaction.
void	receiveHLAregisterFederationSynchronizationPoint(java.lang.String synchronizationPointLabel, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) Federate's request for registering a federation synchronization point.
void	receiveHLAregisterObjectInstance(java.lang.String objectName, long objectInstanceHandle, long objectClassHandle, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) Registers a new object instance.
void	receiveHLAreportHandles(long blockStart, long blockSize, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) Reports a block of handles.
void	receiveHLArequestAttributeValueUpdate(long objectInstanceHandle, long[] attributeHandleList, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) Requests an attribute value update.
void	receiveHLArequestHandles(long blockSize, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) Requests a block of handles.
void	receiveHLAresultBoolean(boolean result, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) Notifies the federate about the result of last invoked service.
void	receiveHLAsynchronizationPointRegistrationFailed(java.lang.String synchronizationPointLabel, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) Notifies the federate that the synchronization point registration operation has failed.
void	receiveHLAsynchronizationPointRegistrationSucceeded(java.lang.String synchronizationPointLabel, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) Notifies the federate that the synchronization point registration operation has succeeded.
void	receiveHLAtimeAdvanceGrant(byte[] theTime, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) Notifies the federate that a time advance has been granted.
void	receiveHLAtimeConstrainedEnabled(byte[] time, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) Notifies the federate that time-constrained mode has been enabled.
void	receiveHLAtimeRegulationEnabled(byte[] time, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) Notifies the federate that time regulation has been enabled.
void	receiveHLAupdateAttributeValuesBestEffort(long objectInstanceHandle, HLAattributeHandleValuePair[] attributeHandleValuePairList, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) Updates a set of attribute values with best-effort transportation and receive ordering.
void	receiveHLAupdateAttributeValuesReliable(long objectInstanceHandle, HLAattributeHandleValuePair[] attributeHandleValuePairList, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) Updates a set of attribute values with reliable transportation and receive ordering.

Method Detail

receiveHLAinteractionFragment

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

A piece of a fragmented interaction.

Parameters:

interactionNumber - The sequence number of the fragmented interaction.

interactionSize - The size of the fragmented interaction.

fragmentOffset - The offset of this fragment in the buffer.

fragmentContents - The contents of the fragment.

userSuppliedTag - a user-supplied tag associated with the interaction

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

theTransport - the type of transport associated with the interaction

Throws:

InteractionClassNotRecognized - if the interaction class was not recognized

InteractionParameterNotRecognized - if a parameter of the interaction was not recognized

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

FederateInternalError - if an error occurs in the federate

receiveHLArequestHandles

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

Requests a block of handles.

Parameters:

blockSize - The number of handles desired.

userSuppliedTag - a user-supplied tag associated with the interaction

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

theTransport - the type of transport associated with the interaction

Throws:

InteractionClassNotRecognized - if the interaction class was not recognized

InteractionParameterNotRecognized - if a parameter of the interaction was not recognized

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

FederateInternalError - if an error occurs in the federate

receiveHLAreportHandles

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

Reports a block of handles.

Parameters:

blockStart - The first handle in the block.

blockSize - The number of handles in the block.

userSuppliedTag - a user-supplied tag associated with the interaction

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

theTransport - the type of transport associated with the interaction

Throws:

InteractionClassNotRecognized - if the interaction class was not recognized

InteractionParameterNotRecognized - if a parameter of the interaction was not recognized

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

FederateInternalError - if an error occurs in the federate

receiveHLAcontinue

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

Notifies the federate that the executive is done sending callbacks.

Parameters:

userSuppliedTag - a user-supplied tag associated with the interaction

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

theTransport - the type of transport associated with the interaction

Throws:

InteractionClassNotRecognized - if the interaction class was not recognized

InteractionParameterNotRecognized - if a parameter of the interaction was not recognized

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

FederateInternalError - if an error occurs in the federate

receiveHLAregisterObjectInstance

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

Registers a new object instance.

Parameters:

objectName - The name of the object.

objectInstanceHandle - The object instance handle.

objectClassHandle - The object class handle.

userSuppliedTag - a user-supplied tag associated with the interaction

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

theTransport - the type of transport associated with the interaction

Throws:

InteractionClassNotRecognized - if the interaction class was not recognized

InteractionParameterNotRecognized - if a parameter of the interaction was not recognized

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

FederateInternalError - if an error occurs in the federate

receiveHLArequestAttributeValueUpdate

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

Requests an attribute value update.

Parameters:

objectInstanceHandle - Object instance handle.

attributeHandleList - List of attribute handles.

userSuppliedTag - a user-supplied tag associated with the interaction

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

theTransport - the type of transport associated with the interaction

Throws:

InteractionClassNotRecognized - if the interaction class was not recognized

InteractionParameterNotRecognized - if a parameter of the interaction was not recognized

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

FederateInternalError - if an error occurs in the federate

receiveHLAupdateAttributeValuesBestEffort

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

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

Parameters:

objectInstanceHandle - Object instance handle.

attributeHandleValuePairList - List of attribute handle/value pairs.

userSuppliedTag - a user-supplied tag associated with the interaction

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

theTransport - the type of transport associated with the interaction

Throws:

InteractionClassNotRecognized - if the interaction class was not recognized

InteractionParameterNotRecognized - if a parameter of the interaction was not recognized

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

FederateInternalError - if an error occurs in the federate

receiveHLAupdateAttributeValuesReliable

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

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

Parameters:

objectInstanceHandle - Object instance handle.

attributeHandleValuePairList - List of attribute handle/value pairs.

userSuppliedTag - a user-supplied tag associated with the interaction

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

theTransport - the type of transport associated with the interaction

Throws:

InteractionClassNotRecognized - if the interaction class was not recognized

InteractionParameterNotRecognized - if a parameter of the interaction was not recognized

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

FederateInternalError - if an error occurs in the federate

receiveHLAresultBoolean

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

Notifies the federate about the result of last invoked service.

Parameters:

result - Result of last invoked service.

userSuppliedTag - a user-supplied tag associated with the interaction

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

theTransport - the type of transport associated with the interaction

Throws:

InteractionClassNotRecognized - if the interaction class was not recognized

InteractionParameterNotRecognized - if a parameter of the interaction was not recognized

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

FederateInternalError - if an error occurs in the federate

receiveHLAtimeRegulationEnabled

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

Notifies the federate that time regulation has been enabled.

Parameters:

time - The current logical time

userSuppliedTag - a user-supplied tag associated with the interaction

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

theTransport - the type of transport associated with the interaction

Throws:

InteractionClassNotRecognized - if the interaction class was not recognized

InteractionParameterNotRecognized - if a parameter of the interaction was not recognized

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

FederateInternalError - if an error occurs in the federate

receiveHLAtimeConstrainedEnabled

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

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

Parameters:

time - The current logical time

userSuppliedTag - a user-supplied tag associated with the interaction

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

theTransport - the type of transport associated with the interaction

Throws:

InteractionClassNotRecognized - if the interaction class was not recognized

InteractionParameterNotRecognized - if a parameter of the interaction was not recognized

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

FederateInternalError - if an error occurs in the federate

receiveHLAtimeAdvanceGrant

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

Notifies the federate that a time advance has been granted.

Parameters:

theTime - The new logical time

userSuppliedTag - a user-supplied tag associated with the interaction

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

theTransport - the type of transport associated with the interaction

Throws:

InteractionClassNotRecognized - if the interaction class was not recognized

InteractionParameterNotRecognized - if a parameter of the interaction was not recognized

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

FederateInternalError - if an error occurs in the federate

receiveHLAregisterFederationSynchronizationPoint

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

Federate's request for registering a federation synchronization point.

Parameters:

synchronizationPointLabel - Label associated with the synchronization point.

userSuppliedTag - a user-supplied tag associated with the interaction

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

theTransport - the type of transport associated with the interaction

Throws:

InteractionClassNotRecognized - if the interaction class was not recognized

InteractionParameterNotRecognized - if a parameter of the interaction was not recognized

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

FederateInternalError - if an error occurs in the federate

receiveHLAsynchronizationPointRegistrationSucceeded

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

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

Parameters:

synchronizationPointLabel - Label associated with the synchronization point.

userSuppliedTag - a user-supplied tag associated with the interaction

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

theTransport - the type of transport associated with the interaction

Throws:

InteractionClassNotRecognized - if the interaction class was not recognized

InteractionParameterNotRecognized - if a parameter of the interaction was not recognized

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

FederateInternalError - if an error occurs in the federate

receiveHLAsynchronizationPointRegistrationFailed

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

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

Parameters:

synchronizationPointLabel - Label associated with the synchronization point.

userSuppliedTag - a user-supplied tag associated with the interaction

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

theTransport - the type of transport associated with the interaction

Throws:

InteractionClassNotRecognized - if the interaction class was not recognized

InteractionParameterNotRecognized - if a parameter of the interaction was not recognized

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

FederateInternalError - if an error occurs in the federate

receiveHLAannounceSynchronizationPoint

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

Notifies the federate that a synchronization point has been announced.

Parameters:

synchronizationPointLabel - Label associated with the synchronization point.

userSuppliedTag - a user-supplied tag associated with the interaction

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

theTransport - the type of transport associated with the interaction

Throws:

InteractionClassNotRecognized - if the interaction class was not recognized

InteractionParameterNotRecognized - if a parameter of the interaction was not recognized

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

FederateInternalError - if an error occurs in the federate

receiveHLAfederationSynchronized

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

Notifies the federate that the federation has been synchronized.

Parameters:

synchronizationPointLabel - Label associated with the synchronization point.

userSuppliedTag - a user-supplied tag associated with the interaction

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

theTransport - the type of transport associated with the interaction

Throws:

InteractionClassNotRecognized - if the interaction class was not recognized

InteractionParameterNotRecognized - if a parameter of the interaction was not recognized

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

FederateInternalError - if an error occurs in the federate