trick/trick_source/sim_services/CommandLineArguments/docs/design.dox_in

33 lines
1.1 KiB
Plaintext
Raw Normal View History

2015-02-26 15:02:31 +00:00
/**
@page LEVEL2 Command Line Arguments Design
@section LEVEL3 Processing the Command Line Arguments
The main routine of the Command Line Arguments object is called by the
main program and the command line arguments of the main program are sent in
to the routine. This routine copies the command line arguments and saves
them for all of the other Trick core classes to use. It also processes the
command line arguments to retrieve to output_dir, the input_file, the
default_dir, and the cmdline_name.
@copydetails Trick::CommandLineArguments::process_sim_args(int nargs , char **args)
Trick::CommandLineArguments::process_sim_args(int nargs , char **args)
@section LEVEL3 Timestamping the Output Directory
Before Simulation Initialization is complete the user may choose to
timestamp the output directory.
@copydetails Trick::CommandLineArguments::output_dir_timestamed_on()
Trick::CommandLineArguments::output_dir_timestamed_on()
@section LEVEL3 Removing Timestamping the Output Directory
@copydetails Trick::CommandLineArguments::output_dir_timestamed_off()
Trick::CommandLineArguments::output_dir_timestamed_off()
*/