Struct SetSpeedTrainSim 

pub struct SetSpeedTrainSim {
    pub loco_con: Consist,
    pub n_cars_by_type: HashMap<String, u32>,
    pub state: TrainState,
    pub speed_trace: SpeedTrace,
    pub train_res: TrainRes,
    pub history: TrainStateHistoryVec,
    /* private fields */
}

Train simulation in which speed is prescribed. Note that this is not guaranteed to produce identical results to super::SpeedLimitTrainSim because of differences in braking controls but should generally be very close (i.e. error in cumulative fuel/battery energy should be less than 0.1%)

Fields

loco_con: Consist

n_cars_by_type: HashMap<String, u32>

state: TrainState

speed_trace: SpeedTrace

train_res: TrainRes

train resistance calculation

history: TrainStateHistoryVec

Custom vector of Self::state

Implementations

impl SetSpeedTrainSim

pub fn trim_failed_steps(&mut self) -> Result<()>

Trims off any portion of the trip that failed to run

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

Sets save_interval for self and nested loco_con.

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

Returns self.save_interval and asserts that this is equal to self.loco_con.get_save_interval().

pub fn solve_step(&mut self) -> Result<()>

Solves time step.

pub fn walk(&mut self) -> Result<()>

Iterates save_state and step through all time steps.

pub fn solve_required_pwr(&mut self, dt: Time) -> Result<()>

Sets power requirements based on:

• rolling resistance
• drag
• inertia
• acceleration

Trait Implementations

impl CheckAndResetState for SetSpeedTrainSim

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

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

impl Clone for SetSpeedTrainSim

fn clone(&self) -> SetSpeedTrainSim

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SetSpeedTrainSim

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

Formats the value using the given formatter.

impl Default for SetSpeedTrainSim

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SetSpeedTrainSim

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SetSpeedTrainSimBuilder> for SetSpeedTrainSim

fn from(value: SetSpeedTrainSimBuilder) -> Self

Converts to this type from the input type.

impl Init for SetSpeedTrainSim

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 SetSpeedTrainSim

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SaveState for SetSpeedTrainSim

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

Saves current time step for self and nested loco_con.

impl SerdeAPI for SetSpeedTrainSim

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

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

const RESOURCES_SUBDIR: &'static str = ""

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

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 altrios-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<()>

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<()>

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

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 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_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 SetSpeedTrainSim

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 SetSpeedTrainSim

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

Sets cumulative values based on rate values

impl Step for SetSpeedTrainSim

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

Solves step, saves state, steps nested loco_con, and increments self.i.

impl StateMethods for SetSpeedTrainSim

impl StructuralPartialEq for SetSpeedTrainSim