Package org.eclipse.mosaic.rti.api.parameters

Class FederateDescriptor

java.lang.Object

org.eclipse.mosaic.rti.api.parameters.FederateDescriptor

public class FederateDescriptor
extends Object

The federation handle is the description of a federate. If a federate is to join a federation, it must be described using an instance of this class.

Constructor Summary

Constructors

Constructor	Description
FederateDescriptor(String id, FederateAmbassador ambassador, byte priority)	Creates a new FederateDescriptor which provides various information for managing the ambassador and the federate it presents.

Method Summary

Modifier and Type	Method	Description
FederateAmbassador	getAmbassador()
File	getBinariesDir()
File	getConfigDir()
Path	getConfigTargetPath()
FederateExecutor	getFederateExecutor()
CLocalHost	getHost()
String	getId()	Returns the unique identifier of the federate.
Collection<InteractionDescriptor>	getInteractions()
JavaFederateParameters	getJavaFederateParameters()
byte	getPriority()	Returns the priority of this federate.
boolean	isToDeployAndUndeploy()
boolean	isToStartAndStop()
void	setBinariesDir(File binariesDir)
void	setConfigDir(File configDir)
void	setConfigTargetPath(Path configTargetPath)
void	setDeployAndUndeploy(boolean deployAndUndeploy)
void	setFederateExecutor(FederateExecutor federateExecutor)
void	setHost(CLocalHost host)
void	setInteractions(Collection<InteractionDescriptor> interactions)
void	setJavaFederateParameters(JavaFederateParameters javaFederateParameters)
void	setStartAndStop(boolean startAndStop)

Methods inherited from class java.lang.Object

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

Constructor Detail

FederateDescriptor

public FederateDescriptor(String id,
                          FederateAmbassador ambassador,
                          byte priority)

Creates a new FederateDescriptor which provides various information for managing the ambassador and the federate it presents.

Parameters:

id - unique string identifying a federate

ambassador - ambassador representing a federate in federation

priority - the priority for this federate

Method Detail

getId

public String getId()

Returns the unique identifier of the federate.

getAmbassador

public FederateAmbassador getAmbassador()

getPriority

public byte getPriority()

Returns the priority of this federate. The lower the value the higher the priority.

getInteractions

@Nonnull
public Collection<InteractionDescriptor> getInteractions()

setInteractions

public void setInteractions(@Nonnull
                            Collection<InteractionDescriptor> interactions)

getConfigTargetPath

public Path getConfigTargetPath()

setConfigTargetPath

public void setConfigTargetPath(Path configTargetPath)

getBinariesDir

public File getBinariesDir()

setBinariesDir

public void setBinariesDir(File binariesDir)

getConfigDir

public File getConfigDir()

setConfigDir

public void setConfigDir(File configDir)

getHost

public CLocalHost getHost()

setHost

public void setHost(CLocalHost host)

isToDeployAndUndeploy

public boolean isToDeployAndUndeploy()

setDeployAndUndeploy

public void setDeployAndUndeploy(boolean deployAndUndeploy)

isToStartAndStop

public boolean isToStartAndStop()

setStartAndStop

public void setStartAndStop(boolean startAndStop)

getFederateExecutor

public FederateExecutor getFederateExecutor()

setFederateExecutor

public void setFederateExecutor(@Nonnull
                                FederateExecutor federateExecutor)

getJavaFederateParameters

public JavaFederateParameters getJavaFederateParameters()

setJavaFederateParameters

public void setJavaFederateParameters(JavaFederateParameters javaFederateParameters)