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 Details

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

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