A.1 Federation Management

.1 createFederationExecution()

1RTI.0

  

▲RTI 1.3

ABSTRACT

This method creates a named federation execution (FedExec) and registers it with the RTI executive (RtiExec). The RTI 1.3 version of this method has an additional argument for specifying the FED file to use for the federation

HLA IF SPECIFICATION

This method realizes the "Create Federation Execution" Federation Management service as specified in the HLA Interface Specification (§2.1 in version 1.1; §4.2 in version 1.3).

SYNOPSIS

#include <RTI.hh>

// RTI 1.0 Only

void

RTI::RTIambassador::

createFederationExecution (

const RTI::FederationExecutionName

executionName

)

throw (

RTI::ConcurrentAccessAttempted,

RTI::FederationExecutionAlreadyExists,

RTI::RTIinternalError,

RTI::RestoreInProgress, ß RTI 1.0 Only

RTI::SaveInProgress ß RTI 1.0 Only

)

// RTI 1.3 Only

void

RTI::RTIambassador::

createFederationExecution (

const char* executionName, ß Changes Type

const char* FED ß RTI 1.3 Only

)

throw (

RTI::ConcurrentAccessAttempted,

RTI::FederationExecutionAlreadyExists,

RTI::RTIinternalError

)

ARGUMENTS

executionName

string specifying the name of the FedExec to create

FED (RTI 1.3 Only)

filename in the directory specified by the RTI_CONFIG environment variable from which to read the Federation Execution Data (FED)

DESCRIPTION

A federate uses createFederationExecution() to create a new federation executive (FedExec) process. [The FedExec is frequently referred to as "the

When createFederationExecution() completes, there is a brief period before the FedExec is ready to accept joining federates. As a result, an immediate call to If several federates compete to create the FedExec, a race condition results. The first federate to request the new federation will succeed. Subsequent requests will encounter an exception.

 

RETURN VALUES

A non-exceptional exit from this method indicates that the RtiExec has approved the creation of the named Federation and that the corresponding FedExec has been forked.

A non-exceptional return does not guarantee that the federation has been successfully created. Errors that occur in the initialization of the FedExec (e.g. a bad path to the FedExec executable) are not detected. Output from the FedExec is logged to the

WINDOWS® NT NOTES

The location of the executable that is forked to start the FedExec is "%RTI_HOME%\bin\win32\fedex.exe". Currently, output from the Fed

UNIX® NOTES

The location of the script that launches the FedExec is "$RTI_HOME/bin/fedex.sh".

RELEASE NOTES

RTI 1.3

The FED-file argument to createFederationExecution() is associated with the federation in the RtiExec and communicated to joining federates.