Struct Cycle

#[non_exhaustive]
pub struct Cycle {
    pub name: String,
    pub init_elev: Option<Length>,
    pub time: Vec<Time>,
    pub speed: Vec<Velocity>,
    pub dist: Vec<Length>,
    pub grade: Vec<Ratio>,
    pub elev: Vec<Length>,
    pub pwr_max_chrg: Vec<Power>,
    pub temp_amb_air: Vec<Temperature>,
    pub pwr_solar_load: Vec<Power>,
    pub grade_interp: Option<Interpolator>,
    pub elev_interp: Option<Interpolator>,
}

Container

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.

name: String

Name of cycle (can be left empty)

init_elev: Option<Length>

inital elevation

time: Vec<Time>

simulation time

speed: Vec<Velocity>

prescribed speed

dist: Vec<Length>

calculated prescribed distance based on RHS integral of time and speed

grade: Vec<Ratio>

road grade (expressed as a decimal, not percent)

elev: Vec<Length>

calculated prescribed elevation based on RHS integral distance and grade

pwr_max_chrg: Vec<Power>

road charging/discharing capacity

temp_amb_air: Vec<Temperature>

ambient air temperature w.r.t. to time (rather than spatial position)

pwr_solar_load: Vec<Power>

solar heat load w.r.t. to time (rather than spatial position)

grade_interp: Option<Interpolator>

grade interpolator

elev_interp: Option<Interpolator>

elevation interpolator

Implementations

impl Cycle

pub fn dt_at_i(&self, i: usize) -> Result<Time>

rust-internal time steps at i

pub fn len_checked(&self) -> Result<usize>

pub fn is_empty(&self) -> Result<bool>

pub fn push(&mut self, element: CycleElement) -> Result<()>

pub fn extend(&mut self, vec: Vec<CycleElement>) -> Result<()>

pub fn trim( &mut self, start_idx: Option<usize>, end_idx: Option<usize>, ) -> Result<()>

pub fn to_csv(&self) -> Result<String>

Write (serialize) cycle to a CSV string

pub fn to_fastsim2(&self) -> Result<Cycle2>

Trait Implementations

impl Clone for Cycle

fn clone(&self) -> Cycle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cycle

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

Formats the value using the given formatter.

impl Default for Cycle

fn default() -> Cycle

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Cycle

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Init for Cycle

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

Sets self.dist and self.elev

Assumptions

• if init_elev.is_none(), then defaults to [static@ELEV_DEFAULT]

impl PartialEq for Cycle

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

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

const 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 Cycle

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

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

Arguments:

• wtr - The writer into which to write object data
• format - The target format, any of those listed in ACCEPTED_BYTE_FORMATS

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

Arguments:

• rdr - The reader from which to read object data
• format - The source format, any of those listed in ACCEPTED_BYTE_FORMATS

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

Write (serialize) an object into a string

Arguments:

• format - The target format, any of those listed in ACCEPTED_STR_FORMATS

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

Read (deserialize) an object from a string

Arguments:

• contents - The string containing the object data
• format - The source format, any of those listed in ACCEPTED_STR_FORMATS

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

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

const RESOURCE_PREFIX: &'static str = "cycles"

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

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 Cycle