nominal-api 0.1239.0

API bindings for the Nominal platform
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

/// Calculates the rate of change between subsequent points.
#[derive(
    Debug,
    Clone,
    conjure_object::serde::Serialize,
    conjure_object::serde::Deserialize,
    conjure_object::private::DeriveWith
)]
#[serde(crate = "conjure_object::serde")]
#[derive_with(PartialEq, Eq, PartialOrd, Ord, Hash)]
#[conjure_object::private::staged_builder::staged_builder]
#[builder(crate = conjure_object::private::staged_builder, update, inline)]
pub struct DerivativeSeries {
    #[builder(custom(type = super::NumericSeries, convert = Box::new))]
    #[serde(rename = "input")]
    input: Box<super::NumericSeries>,
    #[builder(default, into)]
    #[serde(rename = "timeUnit", skip_serializing_if = "Option::is_none", default)]
    time_unit: Option<super::super::super::super::api::TimeUnit>,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::NegativeValueConfiguration>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(
        rename = "negativeValuesConfiguration",
        skip_serializing_if = "Option::is_none",
        default
    )]
    negative_values_configuration: Option<Box<super::NegativeValueConfiguration>>,
}
impl DerivativeSeries {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(input: super::NumericSeries) -> Self {
        Self::builder().input(input).build()
    }
    #[inline]
    pub fn input(&self) -> &super::NumericSeries {
        &*self.input
    }
    /// Time unit used to calculate the derivative. Defaults to seconds if not specified.
    #[inline]
    pub fn time_unit(&self) -> Option<&super::super::super::super::api::TimeUnit> {
        self.time_unit.as_ref().map(|o| &*o)
    }
    /// Defines the strategy for handling negative output values. Defaults to allowNegativeValues if not specified.
    #[inline]
    pub fn negative_values_configuration(
        &self,
    ) -> Option<&super::NegativeValueConfiguration> {
        self.negative_values_configuration.as_ref().map(|o| &**o)
    }
}