Struct SimulateArgs 

pub struct SimulateArgs {

    pub tagname: String,
    pub template: String,
    pub process_type: ProcessTypeArg,
    pub controller_type: ControllerTypeArg,
    pub relay_amp: f32,
    pub cycles_skip: Option<u32>,
    pub cycles_count: Option<u32>,
    pub noise_protection_secs: Option<u32>,
    pub sim_gain: f32,
    pub sim_tau: f32,
    pub sim_dead_time: f32,
    pub sim_noise: f32,
    pub sim_seed: u64,
    pub sim_initial_pv: f32,
    pub sim_initial_mv: f32,
    pub notes: Option<String>,
    pub yes: bool,
    pub write_pid: Option<ResponseLevelArg>,
    pub output: OutputFormat,
}

bhtune simulate: every field defaulted for a true zero-configuration demo run.

Fields

tagname: String

template: String

process_type: ProcessTypeArg

controller_type: ControllerTypeArg

relay_amp: f32

cycles_skip: Option<u32>

cycles_count: Option<u32>

noise_protection_secs: Option<u32>

sim_gain: f32

sim_tau: f32

sim_dead_time: f32

sim_noise: f32

sim_seed: u64

sim_initial_pv: f32

sim_initial_mv: f32

notes: Option<String>

Operator notes to attach to this run. See TuneArgs::notes.

yes: bool

See TuneArgs::yes.

write_pid: Option<ResponseLevelArg>

See TuneArgs::write_pid. Note the built-in FOPDT simulator has no PID constant tags at all (see build_loop_tags), so write-back is always skipped for simulate regardless of this flag – it’s accepted here purely so simulate’s flag surface stays a strict defaulted subset of tune’s, matching every other field.

output: OutputFormat

See TuneArgs::output.

Implementations

impl SimulateArgs

pub fn into_tune_args(self) -> TuneArgs

Expands the defaulted simulate flags into a full TuneArgs with --driver simulator implied, so simulate and tune share one execution path.

Trait Implementations

impl Args for SimulateArgs

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 Clone for SimulateArgs

fn clone(&self) -> SimulateArgs

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CommandFactory for SimulateArgs

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for SimulateArgs

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

Formats the value using the given formatter.

impl FromArgMatches for SimulateArgs

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.

impl Parser for SimulateArgs

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.