Package org.eclipse.mosaic.rti.api

Interface ComponentProvider

All Known Implementing Classes:

MosaicComponentProvider

public interface ComponentProvider

Provides access to all components required for the simulation, such as the TimeManagement, InteractionManagement or FederationManagement instances.

Method Summary

Modifier and Type	Method	Description
RandomNumberGenerator	createRandomNumberGenerator()	Creates a new instance of a RandomNumberGenerator.
RtiAmbassador	createRtiAmbassador(String federateId)	Creates a new instance of the RtiAmbassador for the bridge between RTI and the ambassador.
String	getFederationId()	Returns the identifier of this federation for logging purposes.
FederationManagement	getFederationManagement()	Provides access to the FederationManagement implementation of this federation.
InteractionManagement	getInteractionManagement()	Provides access to the InteractionManagement implementation of this federation.
Monitor	getMonitor()	Provides access to the Monitor implementation of this federation.
TimeManagement	getTimeManagement()	Provides access to the TimeManagement implementation of this federation.

Method Detail

getFederationId

@Nonnull
String getFederationId()

Returns the identifier of this federation for logging purposes.

Returns:

the identifier of this federation

getTimeManagement

@Nonnull
TimeManagement getTimeManagement()

Provides access to the TimeManagement implementation of this federation.

Returns:

the TimeManagement implementation

getFederationManagement

@Nonnull
FederationManagement getFederationManagement()

Provides access to the FederationManagement implementation of this federation. The FederationManagement takes care of deploying, starting, and stopping of federates.

Returns:

the FederationManagement implementation

getInteractionManagement

@Nonnull
InteractionManagement getInteractionManagement()

Provides access to the InteractionManagement implementation of this federation. The InteractionManagement takes care of distributing interactions to subscribed ambassadors.

Returns:

the InteractionManagement implementation

getMonitor

@Nonnull
Monitor getMonitor()

Provides access to the Monitor implementation of this federation. The Monitor can be use to monitor certain events, e.g. the begin of the simulation, time of interactions, and the like.

Returns:

the Monitor implementation

createRtiAmbassador

@Nonnull
RtiAmbassador createRtiAmbassador(String federateId)

Creates a new instance of the RtiAmbassador for the bridge between RTI and the ambassador.

Parameters:

federateId - the unique ID of the federate

Returns:

a new instance of the RtiAmbassador

createRandomNumberGenerator

@Nonnull
RandomNumberGenerator createRandomNumberGenerator()

Creates a new instance of a RandomNumberGenerator.

Returns:

a new instance of the RandomNumberGenerator