oxirs-samm 0.2.4

Semantic Aspect Meta Model (SAMM) implementation for OxiRS
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

//! Aspect Model Element
//!
//! An Aspect is the root element describing a specific aspect of a digital twin.

use super::{ElementMetadata, ModelElement, Operation, Property};
use serde::{Deserialize, Serialize};

/// An Aspect in the SAMM meta model
///
/// Aspects are the root elements of SAMM models and describe specific functionalities
/// or features of digital twins.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Aspect {
    /// Element metadata (URN, names, descriptions)
    pub metadata: ElementMetadata,

    /// Properties of this Aspect
    pub properties: Vec<Property>,

    /// Operations that can be performed on this Aspect
    pub operations: Vec<Operation>,

    /// Events that can be emitted by this Aspect
    pub events: Vec<super::Event>,
}

impl Aspect {
    /// Create a new Aspect
    pub fn new(urn: String) -> Self {
        Self {
            metadata: ElementMetadata::new(urn),
            properties: Vec::new(),
            operations: Vec::new(),
            events: Vec::new(),
        }
    }

    /// Get the properties of this Aspect
    pub fn properties(&self) -> &[Property] {
        &self.properties
    }

    /// Add a property to this Aspect
    pub fn add_property(&mut self, property: Property) {
        self.properties.push(property);
    }

    /// Get the operations of this Aspect
    pub fn operations(&self) -> &[Operation] {
        &self.operations
    }

    /// Add an operation to this Aspect
    pub fn add_operation(&mut self, operation: Operation) {
        self.operations.push(operation);
    }

    /// Get the events of this Aspect
    pub fn events(&self) -> &[super::Event] {
        &self.events
    }

    /// Add an event to this Aspect
    pub fn add_event(&mut self, event: super::Event) {
        self.events.push(event);
    }
}

impl ModelElement for Aspect {
    fn urn(&self) -> &str {
        &self.metadata.urn
    }

    fn metadata(&self) -> &ElementMetadata {
        &self.metadata
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_aspect_creation() {
        let mut aspect = Aspect::new("urn:samm:org.example:1.0.0#TestAspect".to_string());
        aspect
            .metadata
            .add_preferred_name("en".to_string(), "Test Aspect".to_string());

        assert_eq!(aspect.name(), "TestAspect");
        assert_eq!(aspect.properties().len(), 0);
        assert_eq!(aspect.operations().len(), 0);
    }
}