Skip to main content

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

1/// For every timestamp specified in the input series, multiply it by a constant factor.
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 ScaleSeries {
14    #[builder(custom(type = super::NumericSeries, convert = Box::new))]
15    #[serde(rename = "input")]
16    input: Box<super::NumericSeries>,
17    #[builder(custom(type = super::DoubleConstant, convert = Box::new))]
18    #[serde(rename = "scalar")]
19    scalar: Box<super::DoubleConstant>,
20    #[builder(default, into)]
21    #[serde(rename = "scalarUnit", skip_serializing_if = "Option::is_none", default)]
22    scalar_unit: Option<super::super::super::units::api::UnitSymbol>,
23}
24impl ScaleSeries {
25    /// Constructs a new instance of the type.
26    #[inline]
27    pub fn new(input: super::NumericSeries, scalar: super::DoubleConstant) -> Self {
28        Self::builder().input(input).scalar(scalar).build()
29    }
30    #[inline]
31    pub fn input(&self) -> &super::NumericSeries {
32        &*self.input
33    }
34    /// The constant to multiply each point by
35    #[inline]
36    pub fn scalar(&self) -> &super::DoubleConstant {
37        &*self.scalar
38    }
39    /// The units of the scalar to multiply by. If empty, the scalar is considered unit-less.
40    #[inline]
41    pub fn scalar_unit(&self) -> Option<&super::super::super::units::api::UnitSymbol> {
42        self.scalar_unit.as_ref().map(|o| &*o)
43    }
44}