Struct DfcoControls 

#[non_exhaustive]
pub struct DfcoControls {
    pub dfco_enabled: bool,
    pub minimum_dfco_speed: Velocity,
    pub minimum_dfco_deceleration: Acceleration,
    pub stopped_speed_threshold: Velocity,
    pub save_interval: Option<usize>,
    pub state: DfcoState,
    pub history: DfcoStateHistoryVec,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

dfco_enabled: bool

If true DFCO is enabled, else it will never run.

minimum_dfco_speed: Velocity

The minimum speed at or above which which DFCO can activate.

minimum_dfco_deceleration: Acceleration

The minimum vehicle acceleration required for DFCO to be able to activate.

stopped_speed_threshold: Velocity

Speed threshold at or below which DFCO is considered unavailable due to near-stop operation.

save_interval: Option<usize>

Time step interval between saves. 1 is a good option. If None, no saving occurs.

state: DfcoState

current state of control variables

history: DfcoStateHistoryVec

history of current state

Implementations

impl DfcoControls

pub fn is_dfco_disabled_due_to_veh_dynamics( prev_speed: Velocity, speed: Velocity, dt: Time, dfco_allowed: bool, minimum_dfco_speed: Velocity, minimum_dfco_deceleration: Acceleration, stopped_speed_threshold: Velocity, ) -> bool

Determine if decel fuel cut-off (DFCO) is disabled based on vehicle dynamics considerations (i.e., speed, acceleration). Note: considerations related to whether the engine is too cold and such would be handled elsewhere.

impl DfcoControls

pub fn new( dfco_enabled: bool, minimum_dfco_speed: Velocity, minimum_dfco_deceleration: Acceleration, save_interval: Option<usize>, ) -> Result<Self>

Trait Implementations

impl Clone for DfcoControls

fn clone(&self) -> DfcoControls

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DfcoControls

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

Formats the value using the given formatter.

impl Default for DfcoControls

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DfcoControls

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl HistoryMethods for DfcoControls

fn set_save_interval(&mut self, save_interval: Option<usize>) -> Result<()>

Recursively sets save interval

fn save_interval(&self) -> Result<Option<usize>>

Returns save interval for self but does not guarantee recursive consistency in nested objects

fn clear(&mut self)

Remove all history

impl Init for DfcoControls

fn init(&mut self) -> Result<(), Error>

Specialized code to execute upon initialization. For any struct with fields that implement Init, this should propagate down the hierarchy.

impl PartialEq for DfcoControls

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

Equality operator ==.

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

Inequality operator !=.

impl SaveState for DfcoControls

fn save_state<F: Fn() -> String>(&mut self, loc: F) -> Result<()>

Implementation for structs with save_interval

impl SerdeAPI for DfcoControls

const ACCEPTED_BYTE_FORMATS: &'static [&'static str] = _

const ACCEPTED_STR_FORMATS: &'static [&'static str] = _

const RESOURCES_DIR: &'static Dir<'_> = _

const RESOURCES_SUBDIR: &'static str = ""

fn from_resource<P: AsRef<Path>>( filepath: P, skip_init: bool, ) -> Result<Self, Error>

Read (deserialize) an object from a resource file packaged with the fastsim-core crate

fn list_resources() -> Result<Vec<PathBuf>, Error>

List the available resources in the resources directory

fn to_file<P: AsRef<Path>>(&self, filepath: P) -> Result<(), Error>

Write (serialize) an object to a file. Supported file extensions are listed in ACCEPTED_BYTE_FORMATS. Creates a new file if it does not already exist, otherwise truncates the existing file.

fn from_file<P: AsRef<Path>>( filepath: P, skip_init: bool, ) -> Result<Self, Error>

Read (deserialize) an object from a file. Supported file extensions are listed in ACCEPTED_BYTE_FORMATS.

fn to_writer<W: Write>(&self, wtr: W, format: &str) -> Result<(), Error>

Write (serialize) an object into anything that implements std::io::Write

fn from_reader<R: Read>( rdr: &mut R, format: &str, skip_init: bool, ) -> Result<Self, Error>

Deserialize an object from anything that implements std::io::Read

fn to_str(&self, format: &str) -> Result<String>

Write (serialize) an object into a string

fn from_str<S: AsRef<str>>( contents: S, format: &str, skip_init: bool, ) -> Result<Self>

Read (deserialize) an object from a string

fn to_json(&self) -> Result<String>

Write (serialize) an object to a JSON string

fn from_json<S: AsRef<str>>(json_str: S, skip_init: bool) -> Result<Self>

Read (deserialize) an object from a JSON string

fn to_msg_pack(&self) -> Result<Vec<u8>>

Write (serialize) an object to a message pack

fn from_msg_pack(msg_pack: &[u8], skip_init: bool) -> Result<Self>

Read (deserialize) an object from a message pack

fn to_toml(&self) -> Result<String>

Write (serialize) an object to a TOML string

fn from_toml<S: AsRef<str>>(toml_str: S, skip_init: bool) -> Result<Self>

Read (deserialize) an object from a TOML string

fn to_yaml(&self) -> Result<String>

Write (serialize) an object to a YAML string

fn from_yaml<S: AsRef<str>>(yaml_str: S, skip_init: bool) -> Result<Self>

Read (deserialize) an object from a YAML string

impl Serialize for DfcoControls

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SetCumulative for DfcoControls

fn set_cumulative<F: Fn() -> String>(&mut self, dt: Time, loc: F) -> Result<()>

Sets cumulative values based on rate values

fn reset_cumulative<F: Fn() -> String>(&mut self, loc: F) -> Result<()>

Resets cumulative and corresponding rate values to zero

impl StateMethods for DfcoControls

impl Step for DfcoControls

fn step<F: Fn() -> String>(&mut self, loc: F) -> Result<()>

Increments i field of this and all contained structs, recursively

fn reset_step<F: Fn() -> String>(&mut self, loc: F) -> Result<()>

Resets i field of this and all contained structs, recursively

impl StructuralPartialEq for DfcoControls

impl TrackedStateMethods for DfcoControls

fn check_and_reset<F: Fn() -> String>(&mut self, loc: F) -> Result<()>

Ensure [State::Fresh] and reset to [State::Stale]

fn mark_fresh<F: Fn() -> String>(&mut self, loc: F) -> Result<()>

Mark states as [State::Fresh]