org.npsnet.xrti.proxies
Interface MetaFederationInteractionListener

All Known Implementing Classes:

ExecutiveClientAmbassador

public interface MetaFederationInteractionListener

Autogenerated interaction listener interface.

Author:

org.npsnet.xrti.utilities.ProxyCompiler

Method Summary

void	receiveHLAcreateFederationExecution(java.lang.String federationExecutionName, byte[] federationDescriptionDocument, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) Creates a federation execution.
void	receiveHLAdestroyFederationExecution(java.lang.String federationExecutionName, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) Destroys a federation execution.
void	receiveHLAjoinFederationExecution(java.lang.String federationExecutionName, java.lang.String federateType, long federateHandle, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) Joins a federation execution.

Method Detail

receiveHLAcreateFederationExecution

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

Creates a federation execution.

Parameters:

federationExecutionName - The name of the execution to create.

federationDescriptionDocument - The encoded federation description document.

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

receiveHLAdestroyFederationExecution

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

Destroys a federation execution.

Parameters:

federationExecutionName - The name of the execution to destroy.

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

receiveHLAjoinFederationExecution

public void receiveHLAjoinFederationExecution(java.lang.String federationExecutionName,
                                              java.lang.String federateType,
                                              long federateHandle,
                                              byte[] userSuppliedTag,
                                              OrderType sentOrdering,
                                              TransportationType theTransport)
                                       throws InteractionClassNotRecognized,
                                              InteractionParameterNotRecognized,
                                              InteractionClassNotSubscribed,
                                              FederateInternalError

Joins a federation execution.

Parameters:

federationExecutionName - The name of the execution to join.

federateType - The type of the joining federate.

federateHandle - The handle of the joining federate.

userSuppliedTag - a user-supplied tag associated with the interaction

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

theTransport - the type of transport associated with the interaction

Throws:

InteractionClassNotRecognized - if the interaction class was not recognized

InteractionParameterNotRecognized - if a parameter of the interaction was not recognized

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

FederateInternalError - if an error occurs in the federate