Package org.see.skf.core

Class SKBaseFederate

java.lang.Object

org.see.skf.core.SKBaseFederate

All Implemented Interfaces:

SKFederateInterface

Direct Known Subclasses:

SEEAbstractFederate

public abstract class SKBaseFederate
extends Object
implements SKFederateInterface

A rudimentary implementation of the SKFederateInterface that comes with object and interaction management functionality. It is a good starting point for building SpaceFOM federates that require specialized behavior not provided by the SEEAbstractFederate and its descendants.

Since:

2.0

See Also:

• SKFederateInterface
• SEEAbstractFederate

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SKBaseFederate(SKFederateAmbassador federateAmbassador, org.see.skf.conf.FederateConfiguration config)

Method Summary

Modifier and Type	Method	Description
final void	addInteractionListener(InteractionListener listener)	Register an interaction listener to be notified about the dispatch of interactions in the federation execution.
void	addRemoteObjectInstanceListener(RemoteObjectInstanceListener listener)	Register a remote object instance listener to be notified about the initialization of remote object instances created by another federate.
abstract void	configureAndStart()
final void	connectToRTI(hla.rti1516_2025.RtiConfiguration rtiConfig)	Connect the federate to the RTI.
final void	deleteObjectInstance(Object objectInstance, boolean relinquishNameReservation)	Delete the object instance from the RTI.
final org.see.skf.conf.FederateConfiguration	getConfiguration()
SKFederateAmbassador	getFederateAmbassador()
final void	joinFederationExecution()	Join the federation execution.
final void	publishInteractionClass(Class<?> interactionClass)	Declare to the RTI that interactions of the specified HLA interaction class will be published by the federate.
final void	publishObjectClass(Class<?> objectClass)	Declare to the RTI that attribute information about the instances of the specified HLA object class will be published by the federate.
final Object	queryRemoteObjectInstance(String instanceName)	Finds the representation of a remote object instance if previously discovered and stored by the federate.
final String	registerObjectInstance(Object objectInstanceElement)	Create an instance of an HLA object class that will be published by the federate.
final String	registerObjectInstance(Object objectInstanceElement, String requestedName)	Create a named instance of an HLA object class that will be published by the federate.
final void	removeInteractionListener(InteractionListener listener)	Remove a previously registered interaction listener to stop receiving events when interactions are sent.
void	removeRemoteObjectInstanceListener(RemoteObjectInstanceListener listener)	Register a remote object instance listener to be notified about the deletion of remote object instances.
final void	resignFederationExecution()	Gracefully resign from the federation execution.
final boolean	sendInteraction(Object interaction)	Send an interaction of an HLA interaction class that has been previously declared as publishable by the federate to the RTI.
final void	subscribeInteractionClass(Class<?> interactionClass)	Declare to the RTI that the federate wants to stop receiving interactions of the specified HLA interaction class.
final void	subscribeObjectClass(Class<?> objectClass)	Declare to the RTI that the federate will subscribe to instance updates of the specified HLA object class.
final void	unpublishInteractionClass(Class<?> interactionClass)	Declare to the RTI that the federate will subscribe to interactions of the specified HLA interaction class.
final void	unpublishObjectClass(Class<?> objectClass)	Declare to the RTI that all information about instances of a previously published object class will no longer be sent by the federate.
final void	unsubscribeInteractionClass(Class<?> interactionClass)	Declare to the RTI that interactions of a previously published HLA interaction class will no longer be sent by the federate.
final void	unsubscribeObjectClass(Class<?> objectClass)	Declare to the RTI that the federate wants to stop receiving updates about the instances of the specified HLA object class.
final void	updateObjectInstance(Object objectInstance)	Issue an update in the instance's attributes to the RTI for other federates to receive.

Methods inherited from class java.lang.Object

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

Constructor Details

SKBaseFederate

protected SKBaseFederate(SKFederateAmbassador federateAmbassador,
 org.see.skf.conf.FederateConfiguration config)

Method Details

configureAndStart

public abstract void configureAndStart()

connectToRTI

public final void connectToRTI(hla.rti1516_2025.RtiConfiguration rtiConfig)
                        throws hla.rti1516_2025.exceptions.CallNotAllowedFromWithinCallback,
hla.rti1516_2025.exceptions.Unauthorized,
hla.rti1516_2025.exceptions.RTIinternalError,
hla.rti1516_2025.exceptions.ConnectionFailed,
hla.rti1516_2025.exceptions.UnsupportedCallbackModel

Description copied from interface: SKFederateInterface

Connect the federate to the RTI. In HLA 4, the local_settings_designator string has been supplanted by the RTIConfiguration class that encapsulates the information needed to connect to the RTI.

Specified by:

connectToRTI in interface SKFederateInterface

Parameters:

rtiConfig - An RTI configuration object.

Throws:

hla.rti1516_2025.exceptions.CallNotAllowedFromWithinCallback

hla.rti1516_2025.exceptions.Unauthorized

hla.rti1516_2025.exceptions.RTIinternalError

hla.rti1516_2025.exceptions.ConnectionFailed

hla.rti1516_2025.exceptions.UnsupportedCallbackModel

joinFederationExecution

public final void joinFederationExecution()
                                   throws hla.rti1516_2025.exceptions.ErrorReadingFOM,
hla.rti1516_2025.exceptions.CouldNotCreateLogicalTimeFactory,
hla.rti1516_2025.exceptions.RestoreInProgress,
hla.rti1516_2025.exceptions.CallNotAllowedFromWithinCallback,
hla.rti1516_2025.exceptions.InconsistentFOM,
hla.rti1516_2025.exceptions.FederationExecutionDoesNotExist,
hla.rti1516_2025.exceptions.Unauthorized,
hla.rti1516_2025.exceptions.CouldNotOpenFOM,
hla.rti1516_2025.exceptions.NotConnected,
hla.rti1516_2025.exceptions.InvalidFOM,
hla.rti1516_2025.exceptions.RTIinternalError,
hla.rti1516_2025.exceptions.SaveInProgress,
hla.rti1516_2025.exceptions.FederateNotExecutionMember,
hla.rti1516_2025.exceptions.AsynchronousDeliveryAlreadyEnabled

Description copied from interface: SKFederateInterface

Join the federation execution.

Specified by:

joinFederationExecution in interface SKFederateInterface

Throws:

hla.rti1516_2025.exceptions.ErrorReadingFOM

hla.rti1516_2025.exceptions.CouldNotCreateLogicalTimeFactory

hla.rti1516_2025.exceptions.RestoreInProgress

hla.rti1516_2025.exceptions.CallNotAllowedFromWithinCallback

hla.rti1516_2025.exceptions.InconsistentFOM

hla.rti1516_2025.exceptions.FederationExecutionDoesNotExist

hla.rti1516_2025.exceptions.Unauthorized

hla.rti1516_2025.exceptions.CouldNotOpenFOM

hla.rti1516_2025.exceptions.NotConnected

hla.rti1516_2025.exceptions.InvalidFOM

hla.rti1516_2025.exceptions.RTIinternalError

hla.rti1516_2025.exceptions.SaveInProgress

hla.rti1516_2025.exceptions.FederateNotExecutionMember

hla.rti1516_2025.exceptions.AsynchronousDeliveryAlreadyEnabled

resignFederationExecution

public final void resignFederationExecution()
                                     throws hla.rti1516_2025.exceptions.FederateNotExecutionMember,
hla.rti1516_2025.exceptions.RestoreInProgress,
hla.rti1516_2025.exceptions.NotConnected,
hla.rti1516_2025.exceptions.RTIinternalError,
hla.rti1516_2025.exceptions.SaveInProgress,
hla.rti1516_2025.exceptions.CallNotAllowedFromWithinCallback,
hla.rti1516_2025.exceptions.InvalidResignAction,
hla.rti1516_2025.exceptions.OwnershipAcquisitionPending,
hla.rti1516_2025.exceptions.FederateOwnsAttributes,
hla.rti1516_2025.exceptions.FederateIsExecutionMember

Description copied from interface: SKFederateInterface

Gracefully resign from the federation execution.

Specified by:

resignFederationExecution in interface SKFederateInterface

Throws:

hla.rti1516_2025.exceptions.FederateNotExecutionMember

hla.rti1516_2025.exceptions.RestoreInProgress

hla.rti1516_2025.exceptions.NotConnected

hla.rti1516_2025.exceptions.RTIinternalError

hla.rti1516_2025.exceptions.SaveInProgress

hla.rti1516_2025.exceptions.CallNotAllowedFromWithinCallback

hla.rti1516_2025.exceptions.InvalidResignAction

hla.rti1516_2025.exceptions.OwnershipAcquisitionPending

hla.rti1516_2025.exceptions.FederateOwnsAttributes

hla.rti1516_2025.exceptions.FederateIsExecutionMember

publishObjectClass

public final void publishObjectClass(Class<?> objectClass)
                              throws hla.rti1516_2025.exceptions.FederateNotExecutionMember,
hla.rti1516_2025.exceptions.NameNotFound,
hla.rti1516_2025.exceptions.NotConnected,
hla.rti1516_2025.exceptions.RTIinternalError,
hla.rti1516_2025.exceptions.InvalidObjectClassHandle,
hla.rti1516_2025.exceptions.AttributeNotDefined,
hla.rti1516_2025.exceptions.ObjectClassNotDefined,
hla.rti1516_2025.exceptions.RestoreInProgress,
hla.rti1516_2025.exceptions.SaveInProgress

Description copied from interface: SKFederateInterface

Declare to the RTI that attribute information about the instances of the specified HLA object class will be published by the federate.

Specified by:

publishObjectClass in interface SKFederateInterface

Parameters:

objectClass - The Java class representation of the HLA object class.

Throws:

hla.rti1516_2025.exceptions.FederateNotExecutionMember

hla.rti1516_2025.exceptions.NameNotFound

hla.rti1516_2025.exceptions.NotConnected

hla.rti1516_2025.exceptions.RTIinternalError

hla.rti1516_2025.exceptions.InvalidObjectClassHandle

hla.rti1516_2025.exceptions.AttributeNotDefined

hla.rti1516_2025.exceptions.ObjectClassNotDefined

hla.rti1516_2025.exceptions.RestoreInProgress

hla.rti1516_2025.exceptions.SaveInProgress

unpublishObjectClass

public final void unpublishObjectClass(Class<?> objectClass)
                                throws hla.rti1516_2025.exceptions.FederateNotExecutionMember,
hla.rti1516_2025.exceptions.ObjectClassNotDefined,
hla.rti1516_2025.exceptions.RestoreInProgress,
hla.rti1516_2025.exceptions.OwnershipAcquisitionPending,
hla.rti1516_2025.exceptions.NotConnected,
hla.rti1516_2025.exceptions.RTIinternalError,
hla.rti1516_2025.exceptions.SaveInProgress,
hla.rti1516_2025.exceptions.AttributeNotDefined

Description copied from interface: SKFederateInterface

Declare to the RTI that all information about instances of a previously published object class will no longer be sent by the federate. Does nothing if the HLA object class has not been published by the federate beforehand.

Specified by:

unpublishObjectClass in interface SKFederateInterface

Parameters:

objectClass - The Java class representation of the HLA object class.

Throws:

hla.rti1516_2025.exceptions.FederateNotExecutionMember

hla.rti1516_2025.exceptions.ObjectClassNotDefined

hla.rti1516_2025.exceptions.RestoreInProgress

hla.rti1516_2025.exceptions.OwnershipAcquisitionPending

hla.rti1516_2025.exceptions.NotConnected

hla.rti1516_2025.exceptions.RTIinternalError

hla.rti1516_2025.exceptions.SaveInProgress

hla.rti1516_2025.exceptions.AttributeNotDefined

See Also:

• SKFederateInterface.publishObjectClass(Class)

subscribeObjectClass

public final void subscribeObjectClass(Class<?> objectClass)
                                throws hla.rti1516_2025.exceptions.FederateNotExecutionMember,
hla.rti1516_2025.exceptions.NameNotFound,
hla.rti1516_2025.exceptions.NotConnected,
hla.rti1516_2025.exceptions.RTIinternalError,
hla.rti1516_2025.exceptions.InvalidObjectClassHandle,
hla.rti1516_2025.exceptions.AttributeNotDefined,
hla.rti1516_2025.exceptions.ObjectClassNotDefined,
hla.rti1516_2025.exceptions.RestoreInProgress,
hla.rti1516_2025.exceptions.SaveInProgress

Description copied from interface: SKFederateInterface

Declare to the RTI that the federate will subscribe to instance updates of the specified HLA object class.

Specified by:

subscribeObjectClass in interface SKFederateInterface

Parameters:

objectClass - The Java class representation of the HLA object class.

Throws:

hla.rti1516_2025.exceptions.FederateNotExecutionMember

hla.rti1516_2025.exceptions.NameNotFound

hla.rti1516_2025.exceptions.NotConnected

hla.rti1516_2025.exceptions.RTIinternalError

hla.rti1516_2025.exceptions.InvalidObjectClassHandle

hla.rti1516_2025.exceptions.AttributeNotDefined

hla.rti1516_2025.exceptions.ObjectClassNotDefined

hla.rti1516_2025.exceptions.RestoreInProgress

hla.rti1516_2025.exceptions.SaveInProgress

unsubscribeObjectClass

public final void unsubscribeObjectClass(Class<?> objectClass)
                                  throws hla.rti1516_2025.exceptions.FederateNotExecutionMember,
hla.rti1516_2025.exceptions.AttributeNotDefined,
hla.rti1516_2025.exceptions.ObjectClassNotDefined,
hla.rti1516_2025.exceptions.RestoreInProgress,
hla.rti1516_2025.exceptions.NotConnected,
hla.rti1516_2025.exceptions.RTIinternalError,
hla.rti1516_2025.exceptions.SaveInProgress

Description copied from interface: SKFederateInterface

Declare to the RTI that the federate wants to stop receiving updates about the instances of the specified HLA object class. Does nothing is the object class was not subscribed to beforehand.

Specified by:

unsubscribeObjectClass in interface SKFederateInterface

Parameters:

objectClass - The Java class representation of the HLA object class.

Throws:

hla.rti1516_2025.exceptions.FederateNotExecutionMember

hla.rti1516_2025.exceptions.AttributeNotDefined

hla.rti1516_2025.exceptions.ObjectClassNotDefined

hla.rti1516_2025.exceptions.RestoreInProgress

hla.rti1516_2025.exceptions.NotConnected

hla.rti1516_2025.exceptions.RTIinternalError

hla.rti1516_2025.exceptions.SaveInProgress

See Also:

• SKFederateInterface.subscribeObjectClass(Class)

publishInteractionClass

public final void publishInteractionClass(Class<?> interactionClass)
                                   throws hla.rti1516_2025.exceptions.FederateNotExecutionMember,
hla.rti1516_2025.exceptions.NameNotFound,
hla.rti1516_2025.exceptions.NotConnected,
hla.rti1516_2025.exceptions.RTIinternalError,
hla.rti1516_2025.exceptions.InvalidInteractionClassHandle,
hla.rti1516_2025.exceptions.RestoreInProgress,
hla.rti1516_2025.exceptions.InteractionClassNotDefined,
hla.rti1516_2025.exceptions.SaveInProgress

Description copied from interface: SKFederateInterface

Declare to the RTI that interactions of the specified HLA interaction class will be published by the federate.

Specified by:

publishInteractionClass in interface SKFederateInterface

Parameters:

interactionClass - The Java class representation of the HLA interaction class.

Throws:

hla.rti1516_2025.exceptions.FederateNotExecutionMember

hla.rti1516_2025.exceptions.NameNotFound

hla.rti1516_2025.exceptions.NotConnected

hla.rti1516_2025.exceptions.RTIinternalError

hla.rti1516_2025.exceptions.InvalidInteractionClassHandle

hla.rti1516_2025.exceptions.RestoreInProgress

hla.rti1516_2025.exceptions.InteractionClassNotDefined

hla.rti1516_2025.exceptions.SaveInProgress

unpublishInteractionClass

public final void unpublishInteractionClass(Class<?> interactionClass)
                                     throws hla.rti1516_2025.exceptions.FederateNotExecutionMember,
hla.rti1516_2025.exceptions.RestoreInProgress,
hla.rti1516_2025.exceptions.InteractionClassNotDefined,
hla.rti1516_2025.exceptions.NotConnected,
hla.rti1516_2025.exceptions.RTIinternalError,
hla.rti1516_2025.exceptions.SaveInProgress

Description copied from interface: SKFederateInterface

Declare to the RTI that the federate will subscribe to interactions of the specified HLA interaction class. Does nothing if the interaction class was not published beforehand.

Specified by:

unpublishInteractionClass in interface SKFederateInterface

Parameters:

interactionClass - The Java class representation of the HLA interaction class.

Throws:

hla.rti1516_2025.exceptions.FederateNotExecutionMember

hla.rti1516_2025.exceptions.RestoreInProgress

hla.rti1516_2025.exceptions.InteractionClassNotDefined

hla.rti1516_2025.exceptions.NotConnected

hla.rti1516_2025.exceptions.RTIinternalError

hla.rti1516_2025.exceptions.SaveInProgress

See Also:

• SKFederateInterface.publishInteractionClass(Class)

subscribeInteractionClass

public final void subscribeInteractionClass(Class<?> interactionClass)
                                     throws hla.rti1516_2025.exceptions.FederateNotExecutionMember,
hla.rti1516_2025.exceptions.NameNotFound,
hla.rti1516_2025.exceptions.NotConnected,
hla.rti1516_2025.exceptions.RTIinternalError,
hla.rti1516_2025.exceptions.InvalidInteractionClassHandle,
hla.rti1516_2025.exceptions.RestoreInProgress,
hla.rti1516_2025.exceptions.InteractionClassNotDefined,
hla.rti1516_2025.exceptions.SaveInProgress,
hla.rti1516_2025.exceptions.FederateServiceInvocationsAreBeingReportedViaMOM

Description copied from interface: SKFederateInterface

Declare to the RTI that the federate wants to stop receiving interactions of the specified HLA interaction class. Does nothing if the interaction class was not subscribed to beforehand.

Specified by:

subscribeInteractionClass in interface SKFederateInterface

Parameters:

interactionClass - The Java class representation of the HLA interaction class.

Throws:

hla.rti1516_2025.exceptions.FederateNotExecutionMember

hla.rti1516_2025.exceptions.NameNotFound

hla.rti1516_2025.exceptions.NotConnected

hla.rti1516_2025.exceptions.RTIinternalError

hla.rti1516_2025.exceptions.InvalidInteractionClassHandle

hla.rti1516_2025.exceptions.RestoreInProgress

hla.rti1516_2025.exceptions.InteractionClassNotDefined

hla.rti1516_2025.exceptions.SaveInProgress

hla.rti1516_2025.exceptions.FederateServiceInvocationsAreBeingReportedViaMOM

unsubscribeInteractionClass

public final void unsubscribeInteractionClass(Class<?> interactionClass)
                                       throws hla.rti1516_2025.exceptions.FederateNotExecutionMember,
hla.rti1516_2025.exceptions.RestoreInProgress,
hla.rti1516_2025.exceptions.InteractionClassNotDefined,
hla.rti1516_2025.exceptions.NotConnected,
hla.rti1516_2025.exceptions.RTIinternalError,
hla.rti1516_2025.exceptions.SaveInProgress

Description copied from interface: SKFederateInterface

Declare to the RTI that interactions of a previously published HLA interaction class will no longer be sent by the federate.

Specified by:

unsubscribeInteractionClass in interface SKFederateInterface

Parameters:

interactionClass - The Java class representation of the HLA interaction class.

Throws:

hla.rti1516_2025.exceptions.FederateNotExecutionMember

hla.rti1516_2025.exceptions.RestoreInProgress

hla.rti1516_2025.exceptions.InteractionClassNotDefined

hla.rti1516_2025.exceptions.NotConnected

hla.rti1516_2025.exceptions.RTIinternalError

hla.rti1516_2025.exceptions.SaveInProgress

queryRemoteObjectInstance

public final Object queryRemoteObjectInstance(String instanceName)

Description copied from interface: SKFederateInterface

Finds the representation of a remote object instance if previously discovered and stored by the federate.

Specified by:

queryRemoteObjectInstance in interface SKFederateInterface

Parameters:

instanceName - Name of the object instance to look for.

Returns:

The object representing the HLA object instance or null if not found.

registerObjectInstance

public final String registerObjectInstance(Object objectInstanceElement)
                                    throws hla.rti1516_2025.exceptions.FederateNotExecutionMember,
hla.rti1516_2025.exceptions.ObjectClassNotPublished,
hla.rti1516_2025.exceptions.ObjectClassNotDefined,
hla.rti1516_2025.exceptions.RestoreInProgress,
hla.rti1516_2025.exceptions.ObjectInstanceNotKnown,
hla.rti1516_2025.exceptions.NotConnected,
hla.rti1516_2025.exceptions.RTIinternalError,
hla.rti1516_2025.exceptions.SaveInProgress

Description copied from interface: SKFederateInterface

Create an instance of an HLA object class that will be published by the federate.

The HLA object class that this instance belongs to must have been previously declared as publishable to the RTI.

Specified by:

registerObjectInstance in interface SKFederateInterface

Parameters:

objectInstanceElement - An object with attributes aligned with the attributes of its HLA object class equivalent in the FOM.

Returns:

The name of the object instance assigned by the RTI.

Throws:

hla.rti1516_2025.exceptions.FederateNotExecutionMember

hla.rti1516_2025.exceptions.ObjectClassNotPublished

hla.rti1516_2025.exceptions.ObjectClassNotDefined

hla.rti1516_2025.exceptions.RestoreInProgress

hla.rti1516_2025.exceptions.ObjectInstanceNotKnown

hla.rti1516_2025.exceptions.NotConnected

hla.rti1516_2025.exceptions.RTIinternalError

hla.rti1516_2025.exceptions.SaveInProgress

See Also:

• SKFederateInterface.publishObjectClass(Class)

registerObjectInstance

public final String registerObjectInstance(Object objectInstanceElement,
 String requestedName)
                                    throws hla.rti1516_2025.exceptions.FederateNotExecutionMember,
hla.rti1516_2025.exceptions.RestoreInProgress,
hla.rti1516_2025.exceptions.IllegalName,
hla.rti1516_2025.exceptions.NotConnected,
hla.rti1516_2025.exceptions.RTIinternalError,
hla.rti1516_2025.exceptions.SaveInProgress,
hla.rti1516_2025.exceptions.ObjectClassNotPublished,
hla.rti1516_2025.exceptions.ObjectClassNotDefined,
hla.rti1516_2025.exceptions.ObjectInstanceNotKnown,
hla.rti1516_2025.exceptions.ObjectInstanceNameInUse,
hla.rti1516_2025.exceptions.ObjectInstanceNameNotReserved

Description copied from interface: SKFederateInterface

Create a named instance of an HLA object class that will be published by the federate. It should be noted that there is no guarantee the federate will be able to reserve the provided name. If this happens, the RTI will assign a unique name of its own, which wil be returned by the method for your reference.

The HLA object class that this instance belongs to must have been previously declared as publishable to the RTI.

Specified by:

registerObjectInstance in interface SKFederateInterface

Parameters:

objectInstanceElement - An object with attributes aligned with the attributes of its HLA object class equivalent in the FOM.

requestedName - The requestedName for the object instance.

Returns:

The name of the object instance at the RTI.

Throws:

hla.rti1516_2025.exceptions.FederateNotExecutionMember

hla.rti1516_2025.exceptions.RestoreInProgress

hla.rti1516_2025.exceptions.IllegalName

hla.rti1516_2025.exceptions.NotConnected

hla.rti1516_2025.exceptions.RTIinternalError

hla.rti1516_2025.exceptions.SaveInProgress

hla.rti1516_2025.exceptions.ObjectClassNotPublished

hla.rti1516_2025.exceptions.ObjectClassNotDefined

hla.rti1516_2025.exceptions.ObjectInstanceNotKnown

hla.rti1516_2025.exceptions.ObjectInstanceNameInUse

hla.rti1516_2025.exceptions.ObjectInstanceNameNotReserved

See Also:

• SKFederateInterface.publishObjectClass(Class)

updateObjectInstance

public final void updateObjectInstance(Object objectInstance)

Description copied from interface: SKFederateInterface

Issue an update in the instance's attributes to the RTI for other federates to receive. The HLA object class must have already been declared as publishable by the federate to the RTI beforehand AND the object must have been previously created.

Specified by:

updateObjectInstance in interface SKFederateInterface

Parameters:

objectInstance - The object instance representation to be updated.

See Also:

• SKFederateInterface.publishObjectClass(Class)
• SKFederateInterface.registerObjectInstance(Object)

deleteObjectInstance

public final void deleteObjectInstance(Object objectInstance,
 boolean relinquishNameReservation)
                                throws hla.rti1516_2025.exceptions.FederateNotExecutionMember,
hla.rti1516_2025.exceptions.RestoreInProgress,
hla.rti1516_2025.exceptions.ObjectInstanceNotKnown,
hla.rti1516_2025.exceptions.DeletePrivilegeNotHeld,
hla.rti1516_2025.exceptions.NotConnected,
hla.rti1516_2025.exceptions.RTIinternalError,
hla.rti1516_2025.exceptions.SaveInProgress,
hla.rti1516_2025.exceptions.ObjectInstanceNameNotReserved

Description copied from interface: SKFederateInterface

Delete the object instance from the RTI. The HLA object class that the instance belongs to must have already been declared as publishable by the federate to the RTI beforehand AND the object must have previously been created. It is possible to choose whether to release the name of the object instance if it uses a custom name that had to be reserved at the time of creation.

Specified by:

deleteObjectInstance in interface SKFederateInterface

Parameters:

objectInstance - The object instance representation to be deleted.

relinquishNameReservation - true/false to release ownership of the instance name if reserved.

Throws:

hla.rti1516_2025.exceptions.FederateNotExecutionMember

hla.rti1516_2025.exceptions.RestoreInProgress

hla.rti1516_2025.exceptions.ObjectInstanceNotKnown

hla.rti1516_2025.exceptions.DeletePrivilegeNotHeld

hla.rti1516_2025.exceptions.NotConnected

hla.rti1516_2025.exceptions.RTIinternalError

hla.rti1516_2025.exceptions.SaveInProgress

hla.rti1516_2025.exceptions.ObjectInstanceNameNotReserved

See Also:

• SKFederateInterface.publishObjectClass(Class)
• SKFederateInterface.registerObjectInstance(Object)

sendInteraction

public final boolean sendInteraction(Object interaction)
                              throws hla.rti1516_2025.exceptions.FederateNotExecutionMember,
hla.rti1516_2025.exceptions.InteractionParameterNotDefined,
hla.rti1516_2025.exceptions.RestoreInProgress,
hla.rti1516_2025.exceptions.InteractionClassNotDefined,
hla.rti1516_2025.exceptions.InteractionClassNotPublished,
hla.rti1516_2025.exceptions.NotConnected,
hla.rti1516_2025.exceptions.RTIinternalError,
hla.rti1516_2025.exceptions.SaveInProgress

Description copied from interface: SKFederateInterface

Send an interaction of an HLA interaction class that has been previously declared as publishable by the federate to the RTI. The HLA interaction class must have already been declared as publishable by the federate to the RTI beforehand.

Specified by:

sendInteraction in interface SKFederateInterface

Parameters:

interaction - An object with attributes aligned with the parameters of its HLA interaction class equivalent in the FOM.

Returns:

true/false depending on the operation's success.

Throws:

hla.rti1516_2025.exceptions.FederateNotExecutionMember

hla.rti1516_2025.exceptions.InteractionParameterNotDefined

hla.rti1516_2025.exceptions.RestoreInProgress

hla.rti1516_2025.exceptions.InteractionClassNotDefined

hla.rti1516_2025.exceptions.InteractionClassNotPublished

hla.rti1516_2025.exceptions.NotConnected

hla.rti1516_2025.exceptions.RTIinternalError

hla.rti1516_2025.exceptions.SaveInProgress

See Also:

• SKFederateInterface.publishInteractionClass(Class)

addRemoteObjectInstanceListener

public void addRemoteObjectInstanceListener(RemoteObjectInstanceListener listener)

Description copied from interface: SKFederateInterface

Register a remote object instance listener to be notified about the initialization of remote object instances created by another federate.

Specified by:

addRemoteObjectInstanceListener in interface SKFederateInterface

Parameters:

listener - The remote object instance listener to be added.

removeRemoteObjectInstanceListener

public void removeRemoteObjectInstanceListener(RemoteObjectInstanceListener listener)

Description copied from interface: SKFederateInterface

Register a remote object instance listener to be notified about the deletion of remote object instances.

Specified by:

removeRemoteObjectInstanceListener in interface SKFederateInterface

Parameters:

listener - The remote object instance listener to be removed.

addInteractionListener

public final void addInteractionListener(InteractionListener listener)

Description copied from interface: SKFederateInterface

Register an interaction listener to be notified about the dispatch of interactions in the federation execution.

Specified by:

addInteractionListener in interface SKFederateInterface

Parameters:

listener - The interaction listener.

removeInteractionListener

public final void removeInteractionListener(InteractionListener listener)

Description copied from interface: SKFederateInterface

Remove a previously registered interaction listener to stop receiving events when interactions are sent.

Specified by:

removeInteractionListener in interface SKFederateInterface

Parameters:

listener - The interaction listener.

getConfiguration

public final org.see.skf.conf.FederateConfiguration getConfiguration()

getFederateAmbassador

public SKFederateAmbassador getFederateAmbassador()