efb 0.7.1

Electronic Flight Bag library to plan and conduct a flight.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

// SPDX-License-Identifier: Apache-2.0
// Copyright 2024 Joe Pearson
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

use crate::measurements::{Length, Mass};

/// A position within the aircraft that can be loaded with a payload.
///
/// The payload if an aircraft is loaded to defined _stations_ e.g. a
/// seat. Thus, the station defines where in reference to the aircraft's datum a
/// payload can be placed. The [`LoadedStation`] provides a station with it's
/// actual payload.
///
/// [`Aircraft`]: super::Aircraft
#[derive(Clone, Eq, PartialEq, Debug, Default)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Station {
    arm: Length,
    description: Option<String>,
}

impl Station {
    pub fn new(arm: Length, description: Option<String>) -> Self {
        Self { arm, description }
    }

    /// The lever's arm from the reference datum.
    pub fn arm(&self) -> &Length {
        &self.arm
    }

    /// A description of the station.
    pub fn description(&self) -> Option<&String> {
        self.description.as_ref()
    }
}

/// A mass at a defined point within an aircraft.
///
/// The mass may differ from when on ramp to after landing (burned fuel or a
/// skydiver).
///
/// [`Aircraft`]: super::Aircraft
#[derive(Clone, Eq, PartialEq, Debug, Default)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct LoadedStation {
    /// The station that is being loaded.
    pub station: Station,

    /// The mass on ramp.
    pub on_ramp: Mass,

    /// The mass after landing.
    pub after_landing: Mass,
}