Introduction

The users can either launch the director in a full user interface mode or execute the director with command line arguments depending on the needs.

• Running in a full user interface mode allows to create, configure, launch and monitor simulators. For more details of the director user interface please refer to this document Director User Guide. 
• Using the Vortex Director with command line arguments allows to launch the turn key simulators without having to go through the Director user Interface to start the simulation. The next section of the document will detail the available command line arguments.

the Vortex Director's command line arguments

--help : 

Shows all available Vortex Director's command line arguments.

--log

> VortexDirector.exe --log 1

The argument is used to set the log level value. The log level defines which messages will be taken into consideration by the logging system.

If the argument is not used, the default log level is (4=info)

The supported log levels:

0 : Turn the logging Off.

1 : Fatal error. The application cannot further proceed.

2 : Error message, exception is thrown and the application can continue.

3 : Warning message, it is to report an issue that requires a user action. Message is expected to be visible on the status console.

4 : Info message, it is to describe application level operations.

5 : Debug message, it is to report potential issues. Messages are written to the logs only.

6 : Trace message. Messages are written to the logs only.

7 : Turn all messages logging on.

--logDir : 

Sets the directory where the Vortex Director will output the logged data. Any Vortex Services that is launched by the Director will also use this directory for their logged data.

--launch

> VortexDirector.exe --launch "C:\Users\cmlabs\Documents\CM Labs\Simulators\demoscene.vxsimulator"

The argument is used to launch a simulator of the specified simulator file (.vxsimulator) without showing the director user interface. 

The simplified user interface of the Vortex director will be accessible in the system tray.

--selectLaunch

> VortexDirector.exe --selectLaunch "C:\Users\cmlabs\Documents\CM Labs\Simulators"

The argument is used to prompt the users with a list of the available simulator files (.vxsimulator) in the specified folder.

The option is more suited to touch screen and for the users that do not need to create and configure the simulators and where the characteristics of each simulator is not displayed, only the simulators' names.

If the folder is not specified, the default simulator folder is used.

Once a simulator is selected, it will be launched without showing the director user interface. 

The simplified user interface of the Vortex director will be accessible in the system tray.

--multicast

> VortexDirector.exe --multicast 168.255.44.22:49152

The argument is used to specify the multicast address and port number that are used to discover Vortex Services are currently running on the network. The above sample format shows:

IP address : 168.255.44.22

Port number: 49152

If the argument is not used, the default IP address and the port number are 239.255.44.22:54750

The port number must be in the range (49152, 65535)

--simulatorFolder

> VortexDirector.exe --simulatorFolder "C:\Users\cmlabs\Documents\CM Labs\Simulators"

Starts the director in the full user interface and uses the simulators in the specified folder.