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

//******************************************************************************************************
//  measurement.rs - Gbtc
//
//  Copyright © 2023, Grid Protection Alliance.  All Rights Reserved.
//
//  Licensed to the Grid Protection Alliance (GPA) under one or more contributor license agreements. See
//  the NOTICE file distributed with this work for additional information regarding copyright ownership.
//  The GPA licenses this file to you under the MIT License (MIT), the "License"; you may not use this
//  file except in compliance with the License. You may obtain a copy of the License at:
//
//      http://opensource.org/licenses/MIT
//
//  Unless agreed to in writing, the subject software distributed under the License is distributed on an
//  "AS-IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. Refer to the
//  License for the specific language governing permissions and limitations.
//
//  Code Modification History:
//  ----------------------------------------------------------------------------------------------------
//  03/29/2023 - J. Ritchie Carroll
//       Generated original version of source code.
//
//*****************************************************************************************************

use crate::{transport::StateFlags, Ticks};
use chrono::{DateTime, Utc};
use std::fmt::{Display, Formatter, Result as FmtResult};
use uuid::Uuid;

/// Defines a trait representing measured data in the STTP API.
pub trait Measurement: Display {
    /// Gets measurement's globally unique identifier.
    fn signal_id(&self) -> Uuid;
    /// Sets measurement's globally unique identifier.
    fn set_signal_id(&mut self, signal_id: Uuid);

    /// Gets instantaneous value of the measurement.
    fn value(&self) -> f64;
    /// Sets instantaneous value of the measurement.
    fn set_value(&mut self, value: f64);

    /// Gets the STTP uint64 timestamp, in ticks, that measurement was taken.
    fn timestamp(&self) -> Ticks;
    /// Sets the STTP uint64 timestamp, in ticks, that measurement was taken.
    fn set_timestamp(&mut self, timestamp: Ticks);

    /// Gets flags indicating the state of the measurement as reported by the device that took it.
    fn flags(&self) -> StateFlags;
    /// Sets flags indicating the state of the measurement as reported by the device that took it.
    fn set_flags(&mut self, flags: StateFlags);

    /// Gets the integer-based time from a `Measurement` ticks-based timestamp, i.e.,
    /// the 62-bit time value excluding any leap-second flags.
    fn timestamp_value(&self) -> u64;

    /// Gets `Measurement` ticks-based timestamp as a standard Rust `DateTime` value.
    fn datetime(&self) -> DateTime<Utc>;

    /// Formats the `Measurement` using a default formatter.
    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
        write!(
            f,
            "{} @ {} = {:.3} ({:?})",
            self.signal_id(),
            self.timestamp().to_short_string(),
            self.value(),
            self.flags()
        )
    }
}