Struct preexplorer::Configuration

pub struct Configuration { /* fields omitted */ }

Configuration for all basic options included.

See trait Configurable documentation for its main use.

Implementations

impl Configuration

pub fn opening_plot_script(&self) -> String

Opening for a plot script including all common or setted configurations.

pub fn ending_plot_script(&self) -> String

Ending for a plot script including all common or setted configurations.

Trait Implementations

impl Clone for Configuration

pub fn clone(&self) -> Configuration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for Configuration

pub fn configuration_mut(&mut self) -> &mut Configuration

Mutable access to Configuration.

pub fn configuration(&self) -> &Configuration

Reference access to Configuration.

pub fn set_plot_extension<S: AsRef<OsStr>>(&mut self, extension: S) -> &mut Self

Set an extension for the data file.

pub fn set_title<S: Display>(&mut self, title: S) -> &mut Self

Set title, which in comparisons correspond to legends.

pub fn set_logx<N: Into<f64>>(&mut self, logx: N) -> &mut Self

Set logaritmic scale in the x axis.

pub fn set_logy<N: Into<f64>>(&mut self, logy: N) -> &mut Self

Set logaritmic scale in the y axis.

pub fn set_labelx<S: Display>(&mut self, labelx: S) -> &mut Self

Set a label in the x axis.

pub fn set_labely<S: Display>(&mut self, labely: S) -> &mut Self

Set a label in the y axis.

pub fn set_rangex<S, T>(&mut self, left: S, right: T) -> &mut Self where
    f64: From<S>,
    f64: From<T>, 

Set the range in the x axis. If left > right, then the x axis is inverted.

pub fn set_rangey<S, T>(&mut self, down: S, up: T) -> &mut Self where
    f64: From<S>,
    f64: From<T>, 

Set the range in the y axis. If down > up, then the y axis is inverted.

pub fn set_style<S>(&mut self, style: S) -> &mut Self where
    Style: From<S>, 

Choose the style for the plot. Too see all options, go to Style struct. If you set a style and then compare with other structs, then in the joint plot, the style shall be mantained for those structs that had a style not setted by default.

pub fn set_dashtype(&mut self, dashtype: usize) -> &mut Self

Choose the dashtype for the plot. Following the gnuplot standar, it has a cyclic behaviour.

pub fn set_ticsx<T, S>(&mut self, ticsx: T) -> &mut Self where
    T: Into<Option<S>>,
    S: Display, 

Control tics in the x axis. Passing "" shows no tics. See gnuplot documentation for a correct format.

pub fn set_ticsy<T, S>(&mut self, ticsy: T) -> &mut Self where
    T: Into<Option<S>>,
    S: Display, 

Control tics in the y axis. Passing "" shows no tics. See gnuplot documentation for a correct format.

pub fn set_pause<T, S>(&mut self, pause: T) -> &mut Self where
    T: Into<Option<S>>,
    f64: From<S>, 

Control the time for which the plot is in the screen. The unit is seconds. Any negative number means "until a key is pressed". To have no pause, pass 0, instead of None.

pub fn plot_extension(&self) -> Option<&OsStr>

pub fn plot_path(&self) -> &Path

pub fn title(&self) -> Option<&String>

pub fn logx(&self) -> Option<f64>

pub fn logy(&self) -> Option<f64>

pub fn labelx(&self) -> Option<&String>

pub fn labely(&self) -> Option<&String>

pub fn rangex(&self) -> Option<(f64, f64)>

pub fn rangey(&self) -> Option<(f64, f64)>

pub fn style(&self) -> &Style

pub fn dashtype(&self) -> Option<usize>

pub fn ticsx(&self) -> Option<&String>

pub fn ticsy(&self) -> Option<&String>

pub fn pause(&self) -> Option<f64>

pub fn set_data_extension<S: AsRef<OsStr>>(&mut self, extension: S) -> &mut Self

Set an extension for the data file.

pub fn set_header(&mut self, header: bool) -> &mut Self

Decide the presence of headers in the data file. If activated, then title, date and other information are included as a comment in the data file.

pub fn set_date(&mut self, date: DateTime<Local>) -> &mut Self

Choose the date used when saving files.

pub fn set_id<S: Display>(&mut self, id: S) -> &mut Self

Set the unique id or file name with which both data and plot script will be saved. There is no default value and one must set it before plotting or saving.

pub fn data_extension(&self) -> Option<&OsStr>

pub fn data_path(&self) -> &Path

pub fn header(&self) -> bool

pub fn date(&self) -> &DateTime<Local>

pub fn id(&self) -> Option<&String>

pub fn checked_id(&self) -> &String

pub fn set_custom<S: Display, T: Display>(
    &mut self,
    key: S,
    value: T
) -> &mut Self

Include custom configuration fields into the Configuration struct. This is intended for all new configurations you want, specially if you are implementing the traits.

pub fn custom<S: Display>(&self, key: S) -> Option<&String>

pub fn set_xlog<N: Into<f64>>(&mut self, logx: N) -> &mut Self

Set logaritmic scale in the x axis.

pub fn set_ylog<N: Into<f64>>(&mut self, logy: N) -> &mut Self

Set logaritmic scale in the y axis.

pub fn set_xlabel<S: Display>(&mut self, labelx: S) -> &mut Self

Set a label in the x axis.

pub fn set_ylabel<S: Display>(&mut self, labely: S) -> &mut Self

Set a label in the y axis.

pub fn set_xrange<S, T>(&mut self, left: S, right: T) -> &mut Self where
    f64: From<S>,
    f64: From<T>, 

Set the range in the x axis. If left > right, then the x axis is inverted.

pub fn set_yrange<S, T>(&mut self, down: S, up: T) -> &mut Self where
    f64: From<S>,
    f64: From<T>, 

Set the range in the y axis. If down > up, then the y axis is inverted.

pub fn set_xtics<T, S>(&mut self, ticsx: T) -> &mut Self where
    T: Into<Option<S>>,
    S: Display, 

Control tics in the x axis. See gnuplot documentation for a correct format.

pub fn set_ytics<T, S>(&mut self, ticsy: T) -> &mut Self where
    T: Into<Option<S>>,
    S: Display, 

Control tics in the y axis. See gnuplot documentation for a correct format.

pub fn xlog(&self) -> Option<f64>

pub fn ylog(&self) -> Option<f64>

pub fn xlabel(&self) -> Option<&String>

pub fn ylabel(&self) -> Option<&String>

pub fn xrange(&self) -> Option<(f64, f64)>

pub fn yrange(&self) -> Option<(f64, f64)>

pub fn xtics(&self) -> Option<&String>

pub fn ytics(&self) -> Option<&String>

impl Debug for Configuration

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

Formats the value using the given formatter.

impl Default for Configuration

pub fn default() -> Configuration

Returns the "default value" for a type.

impl PartialEq<Configuration> for Configuration

pub fn eq(&self, other: &Configuration) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Configuration) -> bool

This method tests for !=.

impl StructuralPartialEq for Configuration