Skip to content

Commit 19ce380

Browse files
committed
Merge with 0.6.0, README and docs updateds, Javadoc improved
1 parent ad33d76 commit 19ce380

4 files changed

Lines changed: 13 additions & 21 deletions

File tree

src/main/java/it/wldt/adapter/physical/event/PhysicalAssetWldtEvent.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public abstract class PhysicalAssetWldtEvent<T> extends WldtEvent<T> {
4444
private String physicalAdapterId;
4545

4646
/**
47-
* Constructor of the PhysicalAssetWldtEvent<T> containing only the type of the event
47+
* Constructor of the PhysicalAssetWldtEvent containing only the type of the event
4848
* and calling the super constructor of WldtEvent.
4949
* @param type
5050
* @throws EventBusException
@@ -55,7 +55,7 @@ public PhysicalAssetWldtEvent(String type) throws EventBusException {
5555
}
5656

5757
/**
58-
* Constructor of the PhysicalAssetWldtEvent<T> containing the type of the event and the body of the event
58+
* Constructor of the PhysicalAssetWldtEvent containing the type of the event and the body of the event
5959
* and calling the super constructor of WldtEvent.
6060
* @param type Type of the event
6161
* @param body Body of the event
@@ -67,7 +67,7 @@ public PhysicalAssetWldtEvent(String type, T body) throws EventBusException {
6767
}
6868

6969
/**
70-
* Constructor of the PhysicalAssetWldtEvent<T> containing the type of the event,
70+
* Constructor of the PhysicalAssetWldtEvent containing the type of the event,
7171
* the body of the event and the metadata of the event
7272
* and calling the super constructor of WldtEvent.
7373
* @param type Type of the event

src/main/java/it/wldt/core/model/DigitalTwinModel.java

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -46,27 +46,19 @@
4646
* Date: 01/02/2023
4747
* Project: White Label Digital Twin Java Framework - (whitelabel-digitaltwin)
4848
* Core class for Digital Twin modeling, event processing together with lifecycle and behavior management.
49-
* <p>
5049
* The {@code DigitalTwinModel} serves as the central component in shaping Digital Twin behavior,
5150
* managing the Digital Twin's execution, state, and interactions between physical and digital worlds.
5251
* It orchestrates the {@link ShadowingFunction} (modeled throudh a combination of dedicated methods)
5352
* that defines the DT's behavioral logic while coordinating core components including Physical Adapters,
5453
* Digital Adapters, State Management, and Storage.
55-
*
56-
* <h3>Core Responsibilities</h3>
57-
* <ul>
58-
* <li><b>Shadowing Function Orchestration</b>: Manages the shadowing process (replication and
59-
* digitalization) that keeps the Digital Twin State synchronized with the physical asset</li>
60-
* <li><b>Physical Asset Description Management</b>: Coordinates Physical Adapters and their descriptions</li>
61-
* <li><b>Digital Twin State Management</b>: Maintains the canonical state representation</li>
62-
* <li><b>Storage Management</b>: Coordinates persistent storage of Digital Twin state evolution,
63-
* events, and lifecycle data through the Storage Manager</li>
64-
* <li><b>Resource Management</b>: Handles Digital Twin resources, relationships, and their
65-
* lifecycle through the Resource Manager</li>
66-
* <li><b>Event Routing</b>: Routes events between physical and digital sides through the Shadowing Function</li>
67-
* <li><b>Lifecycle Management</b>: Controls initialization, execution, and termination</li>
68-
* </ul>
69-
*
54+
* Core Responsibilities:
55+
* - Shadowing Function Orchestration: Manages the shadowing process (replication and digitalization) that keeps the Digital Twin State synchronized with the physical asset
56+
* - Physical Asset Description Management: Coordinates Physical Adapters and their descriptions
57+
* - Digital Twin State Management: Maintains the canonical state representation
58+
* - Storage Management: Coordinates persistent storage of Digital Twin state evolution, events, and lifecycle data through the Storage Manager
59+
* - Resource Management: Handles Digital Twin resources, relationships, and their lifecycle through the Resource Manager
60+
* - Event Routing: Routes events between physical and digital sides through the Shadowing Function
61+
* - Lifecycle Management: Controls initialization, execution, and termination
7062
*
7163
* @see ShadowingFunction
7264
* @see DigitalTwinStateManager

src/main/java/it/wldt/core/model/ShadowingModelListener.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
* interface to react to synchronization status changes between the Digital Twin State and the
3535
* physical asset.
3636
*
37-
* <h3>State Transitions</h3>
37+
* State Transitions
3838
* <ul>
3939
* <li><b>Synchronized</b>: Digital Twin State accurately reflects the physical asset state.
4040
* All Physical Adapters are bound and actively providing data.</li>

src/main/java/it/wldt/core/model/annotation/ShadowingFunction.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
* <li>Metrics and observability instrumentation</li>
1919
* </ul>
2020
*
21-
* <h3>Example Usage</h3>
21+
* Example Usage
2222
* <pre>{@code
2323
* @ShadowingFunction(
2424
* value = ShadowingType.PHYSICAL_PROPERTY_VARIATION,

0 commit comments

Comments
 (0)