From j661

The Embedded Client is a generic User Application with, contrary to the Client provided in the j661 project, has a minimal Graphical user interface, and is much more configurable.

The Embedded Client has the following features:

• It is possible to start only a User Application, without any associated Server. Note that in this case the arincServer.jar and all associated libraries don't need to be provided
• It is possible to start a User Application, and it's associated Server, sharing the same configuration properties
• It is possible to add any list of Scripts to the User Application, to code the logic. Note that as it is the case for an ARINC 661 library embedded in a Java application, the scripts will use the Client java API
• It is possible to add a list of DataProviders to the User Application, and wire the datas returned by the DataProviders to ARINC 661 parameters.

Contents 1 Architecture 2 Launch options 2.1 Examples 2.2 Specific properties 2.3 Examples 3 See also

Architecture

Launch options

• -config: configuration properties file
• -df: Additional Definition File (optional)
• -hasServer: true if an associated Server will be started and connected with the Client (default=false)
• -autoStart: true if the Client (and Server) are automatically started at beginning (default=true)

Examples

java -jar lib/embedClient.jar -df=samples/Layer.xml -hasServer=true -autoStart=false launch the Embedded Client with an associated Server.

java -jar lib/embedClient.jar -df=samples/Layer.xml -hasServer=false -autoStart=false launch the Embedded Client without an associated Server

java -jar lib/embedClient.jar -propFile=config/arinc.properties -hasServer=true -autoStart=false launch the Embedded Client with an associated Server, and set the properties to use

Specific properties

These are properties specific to the Embedded Client, that can be defined in the configuration properties file (config parameter). Of course, any additional Client properties (for the User Application), or Server properties (if the hasServer option has been set to true) can be found in this properties file.

The specific properties are:

• scripts: The list of Scripts list, separated by a ";" (optional)
• providers: The list of DataProviders jar files, separated by a ";" (optional)
• providerConfs: The list of XML configuration files for the DataProviders, separated by a ";" (optional, but there must be one XML configuration file for each DataProvider). These configuration files wire the datas returned by the DataProviders to the ARINC 661 properties.

Note that putting these properties is not necessary if you add your DataProviders at compile-time.

Examples

java EmbedClient.jar -config=config/arinc.properties with the following property in the arinc.properties file:

scripts=scripts/myScript.groovy

launch the Embedded Client and the associated Server with the arinc.properties properties file in the config directory. The Embedded Client will use the myScript.groovy code.

You will see the Server Windows, depending on the configuration, and a Client window looking like this:

.

Click on the "Activate" button on the toolbar to connect the Client and the Server. The button image will change to show you that the Client and the Server have been connected:

java EmbedClient.jar -hasServer=false -config=config/arinc.properties with the following property in the arinc.properties file:

scripts=scripts/myScript.groovy

same without starting the associated Server

java EmbedClient.jar -hasServer=false -autoStart=false -config=config/arinc.properties

scripts=scripts/myScript.groovy

same without autostarting (the "Activate" button in the toolbar must be manually clicked to start the Client)

See also

• Client
• Client launcher
• Server launcher
• DataProvider
• FGPlayback, a DataProvider which feed a FlightGear Playback recording
• FGLiveProvider, another provider which connect to a live FlightGear instance