trick/trick_source/sim_services/CommandLineArguments/main_page.dox_in
2015-02-26 09:02:31 -06:00

51 lines
1.6 KiB
Plaintext

/**
@page LEVEL2 Command Line Arguments
The Trick::CommandLineArguments class stores the command line arguments specified
by the user when starting the simulation. The class provides routines to
access the arguments.
@section LEVEL3 Accessing the Command Line Arguments
The command line arguments are available to user classes through the following two calls.
@li int command_line_args_get_argc() ;
@li char ** command_line_args_get_argv() ;
Specific directories and file names may be accessed by the following calls.
@li const char * command_line_args_get_output_dir() ;
@li const char * command_line_args_get_input_file() ;
@li const char * command_line_args_get_default_dir() ;
@li const char * command_line_args_get_cmdline_name() ;
@section LEVEL3 Modifying the Output Directory
By default the RUN directory of the input file is the output directory. To change this
specify the <tt>-O</tt> or the <tt>-OO</tt> command line arguments.
@verbatim
S_main_${TRICK_HOST_CPU}.exe RUN_dir/input.py -O <output_dir>
@endverbatim
All Trick core output files will be written to the specified <output_dir>.
@section LEVEL3 TimeStamping the Output Directory
The user may also specify a time stamped output directory in the input file.
@code
trick.output_dir_timestamped_on()
@endcode
This will create a dated subdirectory in the current output directory. All of the Trick
core output files will be written to the output directory. This option may be used in
conjunction with the <tt>-O</tt> or the <tt>-OO</tt> command line arguments.
@section LEVEL3 Command Line Arguments Related Pages
Requirements\n
Design
*/