org.npsnet.xrti.proxies
Class MetaFederationProxyAmbassador

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

All Implemented Interfaces:

FederateAmbassador

public class MetaFederationProxyAmbassador

extends ProxyAmbassador

Autogenerated proxy ambassador.

Author:

org.npsnet.xrti.utilities.ProxyCompiler

Field Summary

private ParameterHandle	HLAcreateFederationExecution_federationDescriptionDocumentHandle Handle for the federationDescriptionDocument parameter of the HLAcreateFederationExecution interaction.
private ParameterHandle	HLAcreateFederationExecution_federationExecutionNameHandle Handle for the federationExecutionName parameter of the HLAcreateFederationExecution interaction.
private InteractionClassHandle	HLAcreateFederationExecutionHandle Handle for the HLAcreateFederationExecution interaction.
private ParameterHandle	HLAdestroyFederationExecution_federationExecutionNameHandle Handle for the federationExecutionName parameter of the HLAdestroyFederationExecution interaction.
private InteractionClassHandle	HLAdestroyFederationExecutionHandle Handle for the HLAdestroyFederationExecution interaction.
private ObjectClassHandle	HLAfederationExecutionHandle Handle for the HLAfederationExecution object class.
private ParameterHandle	HLAjoinFederationExecution_federateHandleHandle Handle for the federateHandle parameter of the HLAjoinFederationExecution interaction.
private ParameterHandle	HLAjoinFederationExecution_federateTypeHandle Handle for the federateType parameter of the HLAjoinFederationExecution interaction.
private ParameterHandle	HLAjoinFederationExecution_federationExecutionNameHandle Handle for the federationExecutionName parameter of the HLAjoinFederationExecution interaction.
private InteractionClassHandle	HLAjoinFederationExecutionHandle Handle for the HLAjoinFederationExecution interaction.
private ObjectClassHandle	HLAmetaFederationHandle Handle for the HLAmetaFederation object class.
private ObjectClassHandle	HLAobjectRootHandle Handle for the HLAobjectRoot object class.
private java.util.Vector	interactionListeners The list of interaction listeners.

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

objectInstanceHandleProxyMap, proxyAmbassadorListeners, rtiAmbassador

Constructor Summary

MetaFederationProxyAmbassador(RTIambassador pRTIAmbassador)
Constructor.

Method Summary

void	addInteractionListener(MetaFederationInteractionListener il) Adds a listener for the interactions processed by this ambassador.
void	discoverObjectInstance(ObjectInstanceHandle theObject, ObjectClassHandle theObjectClass, java.lang.String objectName) Notifies the federate of the presence of an object instance.
HLAfederationExecutionProxy	newHLAfederationExecution() Registers a new HLAfederationExecution and returns a proxy object that may be used to examine and control its state.
HLAfederationExecutionProxy	newHLAfederationExecution(java.lang.String name) Registers a new HLAfederationExecution with the specified name and returns a proxy object that may be used to examine and control its state.
HLAmetaFederationProxy	newHLAmetaFederation() Registers a new HLAmetaFederation and returns a proxy object that may be used to examine and control its state.
HLAmetaFederationProxy	newHLAmetaFederation(java.lang.String name) Registers a new HLAmetaFederation with the specified name and returns a proxy object that may be used to examine and control its state.
HLAobjectRootProxy	newHLAobjectRoot() Registers a new HLAobjectRoot and returns a proxy object that may be used to examine and control its state.
HLAobjectRootProxy	newHLAobjectRoot(java.lang.String name) Registers a new HLAobjectRoot with the specified name and returns a proxy object that may be used to examine and control its state.
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(MetaFederationInteractionListener il) Removes a listener for the interactions processed by this ambassador.
void	sendHLAcreateFederationExecution(java.lang.String federationExecutionName, byte[] federationDescriptionDocument, byte[] userSuppliedTag) Creates a federation execution.
void	sendHLAdestroyFederationExecution(java.lang.String federationExecutionName, byte[] userSuppliedTag) Destroys a federation execution.
void	sendHLAjoinFederationExecution(java.lang.String federationExecutionName, java.lang.String federateType, long federateHandle, byte[] userSuppliedTag) Joins a federation execution.

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

addProxyAmbassadorListener, announceSynchronizationPoint, attributeIsNotOwned, attributeIsOwnedByRTI, attributeOwnershipAcquisitionNotification, attributeOwnershipUnavailable, attributesInScope, attributesOutOfScope, confirmAttributeOwnershipAcquisitionCancellation, deregisterFederateAmbassador, 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.

HLAcreateFederationExecutionHandle

private InteractionClassHandle HLAcreateFederationExecutionHandle

Handle for the HLAcreateFederationExecution interaction.

HLAcreateFederationExecution_federationExecutionNameHandle

private ParameterHandle HLAcreateFederationExecution_federationExecutionNameHandle

Handle for the federationExecutionName parameter of the HLAcreateFederationExecution interaction.

HLAcreateFederationExecution_federationDescriptionDocumentHandle

private ParameterHandle HLAcreateFederationExecution_federationDescriptionDocumentHandle

Handle for the federationDescriptionDocument parameter of the HLAcreateFederationExecution interaction.

HLAdestroyFederationExecutionHandle

private InteractionClassHandle HLAdestroyFederationExecutionHandle

Handle for the HLAdestroyFederationExecution interaction.

HLAdestroyFederationExecution_federationExecutionNameHandle

private ParameterHandle HLAdestroyFederationExecution_federationExecutionNameHandle

Handle for the federationExecutionName parameter of the HLAdestroyFederationExecution interaction.

HLAjoinFederationExecutionHandle

private InteractionClassHandle HLAjoinFederationExecutionHandle

Handle for the HLAjoinFederationExecution interaction.

HLAjoinFederationExecution_federationExecutionNameHandle

private ParameterHandle HLAjoinFederationExecution_federationExecutionNameHandle

Handle for the federationExecutionName parameter of the HLAjoinFederationExecution interaction.

HLAjoinFederationExecution_federateTypeHandle

private ParameterHandle HLAjoinFederationExecution_federateTypeHandle

Handle for the federateType parameter of the HLAjoinFederationExecution interaction.

HLAjoinFederationExecution_federateHandleHandle

private ParameterHandle HLAjoinFederationExecution_federateHandleHandle

Handle for the federateHandle parameter of the HLAjoinFederationExecution interaction.

HLAobjectRootHandle

private ObjectClassHandle HLAobjectRootHandle

Handle for the HLAobjectRoot object class.

HLAmetaFederationHandle

private ObjectClassHandle HLAmetaFederationHandle

Handle for the HLAmetaFederation object class.

HLAfederationExecutionHandle

private ObjectClassHandle HLAfederationExecutionHandle

Handle for the HLAfederationExecution object class.

Constructor Detail

MetaFederationProxyAmbassador

public MetaFederationProxyAmbassador(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

newHLAobjectRoot

public HLAobjectRootProxy newHLAobjectRoot()
                                    throws ObjectClassNotDefined,
                                           ObjectClassNotPublished,
                                           FederateNotExecutionMember,
                                           SaveInProgress,
                                           RestoreInProgress,
                                           RTIinternalError

Registers a new HLAobjectRoot and returns a proxy object that may be used to examine and control its state.

Returns:

the newly created proxy object

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

newHLAobjectRoot

public HLAobjectRootProxy newHLAobjectRoot(java.lang.String name)
                                    throws ObjectClassNotDefined,
                                           ObjectClassNotPublished,
                                           IllegalName,
                                           ObjectInstanceNameInUse,
                                           FederateNotExecutionMember,
                                           SaveInProgress,
                                           RestoreInProgress,
                                           RTIinternalError

Registers a new HLAobjectRoot with the specified name and returns a proxy object that may be used to examine and control its state.

Parameters:

name - the name of the new object

Returns:

the newly created proxy object

Throws:

ObjectClassNotDefined - if the specified object class is not defined

ObjectClassNotPublished - if the specified object class is not published

IllegalName - if the instance name has is illegal

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

newHLAmetaFederation

public HLAmetaFederationProxy newHLAmetaFederation()
                                            throws ObjectClassNotDefined,
                                                   ObjectClassNotPublished,
                                                   FederateNotExecutionMember,
                                                   SaveInProgress,
                                                   RestoreInProgress,
                                                   RTIinternalError

Registers a new HLAmetaFederation and returns a proxy object that may be used to examine and control its state.

Returns:

the newly created proxy object

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

newHLAmetaFederation

public HLAmetaFederationProxy newHLAmetaFederation(java.lang.String name)
                                            throws ObjectClassNotDefined,
                                                   ObjectClassNotPublished,
                                                   IllegalName,
                                                   ObjectInstanceNameInUse,
                                                   FederateNotExecutionMember,
                                                   SaveInProgress,
                                                   RestoreInProgress,
                                                   RTIinternalError

Registers a new HLAmetaFederation with the specified name and returns a proxy object that may be used to examine and control its state.

Parameters:

name - the name of the new object

Returns:

the newly created proxy object

Throws:

ObjectClassNotDefined - if the specified object class is not defined

ObjectClassNotPublished - if the specified object class is not published

IllegalName - if the instance name has is illegal

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

newHLAfederationExecution

public HLAfederationExecutionProxy newHLAfederationExecution()
                                                      throws ObjectClassNotDefined,
                                                             ObjectClassNotPublished,
                                                             FederateNotExecutionMember,
                                                             SaveInProgress,
                                                             RestoreInProgress,
                                                             RTIinternalError

Registers a new HLAfederationExecution and returns a proxy object that may be used to examine and control its state.

Returns:

the newly created proxy object

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

newHLAfederationExecution

public HLAfederationExecutionProxy newHLAfederationExecution(java.lang.String name)
                                                      throws ObjectClassNotDefined,
                                                             ObjectClassNotPublished,
                                                             IllegalName,
                                                             ObjectInstanceNameInUse,
                                                             FederateNotExecutionMember,
                                                             SaveInProgress,
                                                             RestoreInProgress,
                                                             RTIinternalError

Registers a new HLAfederationExecution with the specified name and returns a proxy object that may be used to examine and control its state.

Parameters:

name - the name of the new object

Returns:

the newly created proxy object

Throws:

ObjectClassNotDefined - if the specified object class is not defined

ObjectClassNotPublished - if the specified object class is not published

IllegalName - if the instance name has is illegal

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

addInteractionListener

public void addInteractionListener(MetaFederationInteractionListener il)

Adds a listener for the interactions processed by this ambassador.

Parameters:

il - the listener object to add

removeInteractionListener

public void removeInteractionListener(MetaFederationInteractionListener 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

discoverObjectInstance

public void discoverObjectInstance(ObjectInstanceHandle theObject,
                                   ObjectClassHandle theObjectClass,
                                   java.lang.String objectName)
                            throws CouldNotDiscover,
                                   ObjectClassNotRecognized,
                                   FederateInternalError

Notifies the federate of the presence of an object instance.

Specified by:

discoverObjectInstance in interface FederateAmbassador

Overrides:

discoverObjectInstance in class ProxyAmbassador

Parameters:

theObject - the instance handle of the newly discovered object

theObjectClass - the class handle of the newly discovered object

objectName - the name of the newly discovered object

Throws:

CouldNotDiscover - if the object could not be discovered

ObjectClassNotRecognized - if the object class was not recognized

FederateInternalError - if an error occurs in the federate

sendHLAcreateFederationExecution

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

Creates a federation execution.

Parameters:

federationExecutionName - The name of the execution to create.

federationDescriptionDocument - The encoded federation description document.

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

sendHLAdestroyFederationExecution

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

Destroys a federation execution.

Parameters:

federationExecutionName - The name of the execution to destroy.

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

sendHLAjoinFederationExecution

public void sendHLAjoinFederationExecution(java.lang.String federationExecutionName,
                                           java.lang.String federateType,
                                           long federateHandle,
                                           byte[] userSuppliedTag)
                                    throws InteractionClassNotPublished,
                                           InteractionClassNotDefined,
                                           InteractionParameterNotDefined,
                                           FederateNotExecutionMember,
                                           SaveInProgress,
                                           RestoreInProgress,
                                           RTIinternalError

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