Struct BaseArgs

pub struct BaseArgs {

    pub random_seed: u64,
    pub config: Option<PathBuf>,
    pub output_dir: Option<PathBuf>,
    pub file_prefix: Option<String>,
    pub force_overwrite: bool,
    pub log_level: Option<String>,
    pub verbose: u8,
    pub warn: bool,
    pub debug: bool,
    pub trace: bool,
    pub debugger: Option<Option<f64>>,
    pub web: Option<Option<u16>>,
    pub timeline_progress_max: Option<f64>,
    pub no_stats: bool,
    /* private fields */
}

Default cli arguments for ixa runner

Fields

random_seed: u64

Random seed

config: Option<PathBuf>

Optional path for a global properties config file

output_dir: Option<PathBuf>

Optional path for report output

file_prefix: Option<String>

Optional prefix for report files

force_overwrite: bool

Overwrite existing report files?

log_level: Option<String>

Enable logging

verbose: u8

warn: bool

Set logging to WARN level. Shortcut for --log-level warn.

debug: bool

Set logging to DEBUG level. Shortcut for --log-level DEBUG.

trace: bool

Set logging to TRACE level. Shortcut for --log-level TRACE.

debugger: Option<Option<f64>>

Set a breakpoint at a given time and start the debugger. Defaults to t=0.0

web: Option<Option<u16>>

Enable the Web API at a given time. Defaults to t=0.0

timeline_progress_max: Option<f64>

Enable the timeline progress bar with a maximum time.

no_stats: bool

Suppresses the printout of summary statistics at the end of the simulation.

Trait Implementations

impl Args for BaseArgs

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Debug for BaseArgs

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BaseArgs

fn default() -> Self

Returns the “default value” for a type.

impl FromArgMatches for BaseArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.