Struct TrainSimBuilder 

pub struct TrainSimBuilder {
    pub train_id: String,
    pub train_config: TrainConfig,
    pub loco_con: Consist,
    pub origin_id: Option<String>,
    pub destination_id: Option<String>,
    /* private fields */
}

Fields

train_id: String

Unique, user-defined identifier for the train

train_config: TrainConfig

loco_con: Consist

origin_id: Option<String>

Origin_ID from train planner to map to track network locations. Only needed if Self::make_speed_limit_train_sim will be called.

destination_id: Option<String>

Destination_ID from train planner to map to track network locations. Only needed if Self::make_speed_limit_train_sim will be called.

Implementations

impl TrainSimBuilder

pub fn new( train_id: String, train_config: TrainConfig, loco_con: Consist, origin_id: Option<String>, destination_id: Option<String>, init_train_state: Option<InitTrainState>, ) -> Self

pub fn make_set_speed_train_sim<Q: AsRef<[Link]>, R: AsRef<[LinkIdx]>>( &self, network: Q, link_path: R, speed_trace: SpeedTrace, save_interval: Option<usize>, temp_trace: Option<TemperatureTrace>, ) -> Result<SetSpeedTrainSim>

pub fn make_set_speed_train_sim_and_parts<Q: AsRef<[Link]>, R: AsRef<[LinkIdx]>>( &self, network: Q, link_path: R, speed_trace: SpeedTrace, save_interval: Option<usize>, temp_trace: Option<TemperatureTrace>, ) -> Result<(SetSpeedTrainSim, TrainParams, PathTpc, TrainRes, FricBrake)>

pub fn make_speed_limit_train_sim( &self, location_map: &LocationMap, save_interval: Option<usize>, simulation_days: Option<i32>, scenario_year: Option<i32>, temp_trace: Option<TemperatureTrace>, ) -> Result<SpeedLimitTrainSim>

pub fn make_speed_limit_train_sim_and_parts( &self, location_map: &LocationMap, save_interval: Option<usize>, simulation_days: Option<i32>, scenario_year: Option<i32>, temp_trace: Option<TemperatureTrace>, ) -> Result<(SpeedLimitTrainSim, PathTpc, TrainRes, FricBrake)>

Trait Implementations

impl Clone for TrainSimBuilder

fn clone(&self) -> TrainSimBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TrainSimBuilder

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

Formats the value using the given formatter.

impl Default for TrainSimBuilder

fn default() -> TrainSimBuilder

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TrainSimBuilder

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Init for TrainSimBuilder

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 TrainSimBuilder

fn eq(&self, other: &TrainSimBuilder) -> 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 SerdeAPI for TrainSimBuilder

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 TrainSimBuilder

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TrainSimBuilder