nominal_api/conjure/objects/scout/compute/api/
derivative_series.rs

1/// Calculates the rate of change between subsequent points.
2#[derive(
3    Debug,
4    Clone,
5    conjure_object::serde::Serialize,
6    conjure_object::serde::Deserialize,
7    conjure_object::private::DeriveWith
8)]
9#[serde(crate = "conjure_object::serde")]
10#[derive_with(PartialEq, Eq, PartialOrd, Ord, Hash)]
11#[conjure_object::private::staged_builder::staged_builder]
12#[builder(crate = conjure_object::private::staged_builder, update, inline)]
13pub struct DerivativeSeries {
14    #[builder(custom(type = super::NumericSeries, convert = Box::new))]
15    #[serde(rename = "input")]
16    input: Box<super::NumericSeries>,
17    #[builder(default, into)]
18    #[serde(rename = "timeUnit", skip_serializing_if = "Option::is_none", default)]
19    time_unit: Option<super::super::super::super::api::TimeUnit>,
20    #[builder(
21        default,
22        custom(
23            type = impl
24            Into<Option<super::NegativeValueConfiguration>>,
25            convert = |v|v.into().map(Box::new)
26        )
27    )]
28    #[serde(
29        rename = "negativeValuesConfiguration",
30        skip_serializing_if = "Option::is_none",
31        default
32    )]
33    negative_values_configuration: Option<Box<super::NegativeValueConfiguration>>,
34}
35impl DerivativeSeries {
36    /// Constructs a new instance of the type.
37    #[inline]
38    pub fn new(input: super::NumericSeries) -> Self {
39        Self::builder().input(input).build()
40    }
41    #[inline]
42    pub fn input(&self) -> &super::NumericSeries {
43        &*self.input
44    }
45    /// Time unit used to calculate the derivative. Defaults to seconds if not specified.
46    #[inline]
47    pub fn time_unit(&self) -> Option<&super::super::super::super::api::TimeUnit> {
48        self.time_unit.as_ref().map(|o| &*o)
49    }
50    /// Defines the strategy for handling negative output values. Defaults to allowNegativeValues if not specified.
51    #[inline]
52    pub fn negative_values_configuration(
53        &self,
54    ) -> Option<&super::NegativeValueConfiguration> {
55        self.negative_values_configuration.as_ref().map(|o| &**o)
56    }
57}
nominal_api/conjure/objects/scout/compute/api/derivative_series.rs

nominal_api/conjure/objects/scout/compute/api/
derivative_series.rs
