Skip to main content

nominal_api/conjure/objects/scout/chartdefinition/api/
secondary_variable.rs

1/// A secondary variable to associate with a trace
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 SecondaryVariable {
14    #[serde(rename = "variableName")]
15    variable_name: super::super::super::channelvariables::api::ChannelVariableName,
16    #[builder(default, into)]
17    #[serde(rename = "label", skip_serializing_if = "Option::is_none", default)]
18    label: Option<String>,
19    #[builder(default, into)]
20    #[serde(rename = "enabled", skip_serializing_if = "Option::is_none", default)]
21    enabled: Option<bool>,
22    #[builder(
23        default,
24        custom(
25            type = impl
26            Into<Option<super::SecondaryVariableOptions>>,
27            convert = |v|v.into().map(Box::new)
28        )
29    )]
30    #[serde(
31        rename = "visualizationOption",
32        skip_serializing_if = "Option::is_none",
33        default
34    )]
35    visualization_option: Option<Box<super::SecondaryVariableOptions>>,
36}
37impl SecondaryVariable {
38    /// Constructs a new instance of the type.
39    #[inline]
40    pub fn new(
41        variable_name: super::super::super::channelvariables::api::ChannelVariableName,
42    ) -> Self {
43        Self::builder().variable_name(variable_name).build()
44    }
45    #[inline]
46    pub fn variable_name(
47        &self,
48    ) -> &super::super::super::channelvariables::api::ChannelVariableName {
49        &self.variable_name
50    }
51    #[inline]
52    pub fn label(&self) -> Option<&str> {
53        self.label.as_ref().map(|o| &**o)
54    }
55    /// Default true
56    #[inline]
57    pub fn enabled(&self) -> Option<bool> {
58        self.enabled.as_ref().map(|o| *o)
59    }
60    #[inline]
61    pub fn visualization_option(&self) -> Option<&super::SecondaryVariableOptions> {
62        self.visualization_option.as_ref().map(|o| &**o)
63    }
64}