org.eodisp.hla.common.crc
Interface CrcRemote

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

CrcRemoteImpl

public interface CrcRemote
extends java.rmi.Remote

Remote interface of the central RTI component.

Version:

$Id:$

Author:

ibirrer

Field Summary

static java.lang.String

REGISTRY_NAME

Method Summary

FederationExecutionRemote	createFederationExecution(java.lang.String federationExecutionName, byte[] fdd) Implements HLA service 4.2 (See IEEE Std 1516.1-2000).
void	destroyFederationExecution(java.lang.String federationExecutionName) Implements HLA service 4.3 (See IEEE Std 1516.1-2000).
FederationExecutionRemote	getFederationExecution(java.lang.String federationExecutionName) Returns the federation execution with the given name.
FederateHandle	joinFederationExecution(java.lang.String federationExecutionName, java.lang.String federateType, LrcHandle lrcHandle, MobileFederateServices serviceReferences) Implements HLA service 4.4 (See IEEE Std 1516.1-2000).
LrcHandle	registerLrc(LrcRemote lrcRemote) TODO
void	reset() Resets the CRC.
void	shutdownAndExit() Calls shutdown on the CrcApplication and then exits the JVM.
void	unregisterLrc(LrcHandle lrcHandle)

Field Detail

REGISTRY_NAME

static final java.lang.String REGISTRY_NAME

See Also:

Constant Field Values

Method Detail

createFederationExecution

FederationExecutionRemote createFederationExecution(java.lang.String federationExecutionName,
                                                    byte[] fdd)
                                                    throws java.rmi.RemoteException,
                                                           FederationExecutionAlreadyExists,
                                                           ErrorReadingFDD

Implements HLA service 4.2 (See IEEE Std 1516.1-2000). Creates a new federation execution.

Parameters:

federationExecutionName - the name of the federation execution

fdd - the federation object model (FOM) as an XML file encoded in UTF-8

Returns:

the newly created federation execution

Throws:

FederationExecutionAlreadyExists - if a federation execution with the same name has been created before

ErrorReadingFDD - if fdd could not be read. This is the case if the given fdd is not a valid XML file or does not conform to the HLA XMl Schema.

java.rmi.RemoteException - RMI remote exception happened while calling this method

implementation priority

1

destroyFederationExecution

void destroyFederationExecution(java.lang.String federationExecutionName)
                                throws FederatesCurrentlyJoined,
                                       FederationExecutionDoesNotExist,
                                       java.rmi.RemoteException

Implements HLA service 4.3 (See IEEE Std 1516.1-2000). Destroys this federation execution.

Throws:

FederatesCurrentlyJoined - if there are still federates joined to this federation execution

FederationExecutionDoesNotExist - if no federation execution exists with the given name

java.rmi.RemoteException - RMI remote exception happened while calling this method

getFederationExecution

FederationExecutionRemote getFederationExecution(java.lang.String federationExecutionName)
                                                 throws java.rmi.RemoteException

Returns the federation execution with the given name.

Parameters:

federationExecutionName - the name of the federation execution to be received

Returns:

the federation execution with the given name or null if no federation execution exists with the given name.

Throws:

java.rmi.RemoteException - RMI remote exception happened while calling this method

implementation priority

1

joinFederationExecution

FederateHandle joinFederationExecution(java.lang.String federationExecutionName,
                                       java.lang.String federateType,
                                       LrcHandle lrcHandle,
                                       MobileFederateServices serviceReferences)
                                       throws FederationExecutionDoesNotExist,
                                              java.rmi.RemoteException

Implements HLA service 4.4 (See IEEE Std 1516.1-2000).

Parameters:

federateType - the type of the federate that want to join this federation execution

lrcHandle - a reference to the LRC which runs the federated that wants tho join

serviceReferences - unused

Returns:

a federation execution wide unique handle for the joined federate.

Throws:

SaveInProgress - not implemented

RestoreInProgress - not implemented

java.rmi.RemoteException - RMI remote exception happened while calling this method

FederationExecutionDoesNotExist

registerLrc

LrcHandle registerLrc(LrcRemote lrcRemote)
                      throws java.rmi.RemoteException

TODO

Parameters:

lrcRemote -

Returns:

Throws:

java.rmi.RemoteException

unregisterLrc

void unregisterLrc(LrcHandle lrcHandle)
                   throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

reset

void reset()
           throws java.rmi.RemoteException

Resets the CRC. This means that after this method returned the CRC is in a state as if no federate ever called any method on the CRC. Used for testing purposes only.

Throws:

java.rmi.RemoteException

shutdownAndExit

void shutdownAndExit()
                     throws java.rmi.RemoteException

Calls shutdown on the CrcApplication and then exits the JVM. Does not block

Throws:

java.rmi.RemoteException