nominal-api-conjure 0.1422.0

Conjure HTTP 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
58
59
60
61
62
63
64
65
66
67
68
69
70

/// Produces ranges spanning the regions where a boolean input is true.
///
/// The condition is evaluated point-wise at each aligned timestamp; the numeric series it compares are aligned
/// against each other the same way arithmetic between them would be.
#[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 BooleanRanges {
    #[builder(custom(type = super::BooleanSeries, convert = Box::new))]
    #[serde(rename = "input")]
    input: Box<super::BooleanSeries>,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::IntegerConstant>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(rename = "minPoints", skip_serializing_if = "Option::is_none", default)]
    min_points: Option<Box<super::IntegerConstant>>,
    #[builder(
        default,
        custom(
            type = impl
            Into<Option<super::Duration>>,
            convert = |v|v.into().map(Box::new)
        )
    )]
    #[serde(rename = "minDuration", skip_serializing_if = "Option::is_none", default)]
    min_duration: Option<Box<super::Duration>>,
    #[builder(default, into)]
    #[serde(rename = "rangeStart", skip_serializing_if = "Option::is_none", default)]
    range_start: Option<super::RangeStart>,
}
impl BooleanRanges {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(input: super::BooleanSeries) -> Self {
        Self::builder().input(input).build()
    }
    /// The condition whose true regions become ranges.
    #[inline]
    pub fn input(&self) -> &super::BooleanSeries {
        &*self.input
    }
    /// Minimum number of matching points. Defaults to 1.
    #[inline]
    pub fn min_points(&self) -> Option<&super::IntegerConstant> {
        self.min_points.as_ref().map(|o| &**o)
    }
    /// Minimum matching duration. Defaults to one nanosecond.
    #[inline]
    pub fn min_duration(&self) -> Option<&super::Duration> {
        self.min_duration.as_ref().map(|o| &**o)
    }
    /// Selects whether the output begins at the first match or after persistence is satisfied.
    #[inline]
    pub fn range_start(&self) -> Option<&super::RangeStart> {
        self.range_start.as_ref().map(|o| &*o)
    }
}