Enum BankConvention 

#[non_exhaustive]
pub enum BankConvention {
    TangentRotation,
    VerticalRise,
}

Which height difference a cant D states on a grade (ADR 0081).

See the module docs for both frames. No variant is a default: a Banked3 names one.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

TangentRotation

The level-track section turned about the 3D tangent by psi = asin(D / b). The rail heads differ in height by D cos(theta) at grade angle theta.

VerticalRise

The section rolled about the 3D tangent by asin(D / (b cos theta)), so the rail heads, b apart square to the tangent, differ in height by exactly D.

Implementations

impl BankConvention

pub fn roll( self, cant: Scalar, rail_head_distance: Scalar, grade_cosine: Scalar, ) -> Result<Scalar, BankError>

The roll about the tangent, in radians, for cant cant over rail-head distance rail_head_distance at a grade whose angle has cosine grade_cosine.

Errors

BankError::RailHeadDistance for a non-positive or non-finite b; BankError::CantExceedsRailHeadDistance when |D| > b; BankError::CantExceedsVerticalSpan when, under VerticalRise, |D| > b cos(theta); BankError::NonFinite for a non-finite cant or cosine.

pub fn roll_from_angle( self, psi: Scalar, rail_head_distance: Scalar, grade_cosine: Scalar, ) -> Result<Scalar, BankError>

roll from a nominal bank angle psi with sin(psi) = D / b, as an angle-form piece gives it.

Under TangentRotation this is psi itself, with no round trip through the cant.

Errors

As roll, and BankError::AngleOutOfRange for |psi| > pi / 2, which no cant gives.

Trait Implementations

impl Clone for BankConvention

fn clone(&self) -> BankConvention

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BankConvention

impl Debug for BankConvention

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BankConvention

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for BankConvention

impl Hash for BankConvention

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BankConvention

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BankConvention

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 BankConvention