Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

PlantUML Macro
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Database

CLAMP_GUI -> CLAMP_Runtime: [REST] Read Control Loop Type Definitions
CLAMP_Runtime -> Database: Read Control Loop Type Definition
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Type Definition for Parameterization
CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch GUI fields for Common Parameter Definitions

alt Control Loop Type Definition not Commissioned on Participants
  CLAMP_Runtime -> Database: Read Control Loop Type Definition
  CLAMP_Runtime -> CLAMP_Runtime: Generate fields for Common Parameters for GUI
  CLAMP_Runtime -> CLAMP_GUI: [REST] Return GUI fields Common Parameter Definitions
  CLAMP_GUI -> CLAMP_GUI: Render UI for Common Parameters
  CLAMP_GUI -> CLAMP_GUI: Get values for Common Parameters from user
  CLAMP_GUI -> CLAMP_Runtime: [REST] Set values for Common Parameters
  CLAMP_Runtime -> Database: Store values for Common Parameters
  CLAMP_Runtime -> CLAMP_GUI: [REST] Common Parameter values stored
else Control Loop Type Definition already Commissioned on Participants
  CLAMP_Runtime -> CLAMP_GUI: [REST] Cannot set Common Parameters on\nControl Loop Type Definition that has\nbeen commissioned on participants
end

@enduml

...

2.1 Creating a Control Loop Instance

PlantUML Macro
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Database

CLAMP_GUI -> CLAMP_Runtime: [REST] Read Control Loop Type Definitions
CLAMP_Runtime -> Database: Read Control Loop Type Definition
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Type Definition to use to create Control Loop Instance
CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch GUI fields for Instance Specific Parameter Definitions
CLAMP_Runtime -> Database: Read Control Loop Type Definition
CLAMP_Runtime -> CLAMP_Runtime: Generate fields for Instance Specific Parameters for GUI
CLAMP_Runtime -> CLAMP_GUI: [REST] Return GUI fields Instance Specific Parameter Definitions
CLAMP_GUI -> CLAMP_GUI: Render UI for Instance Specific Parameters
CLAMP_GUI -> CLAMP_GUI: Get values for Instance Specific Parameters from user
CLAMP_GUI -> CLAMP_Runtime: [REST] Request Creation of Control Loop Instance
CLAMP_Runtime -> CLAMP_Runtime: Create of Control Loop Instance
CLAMP_Runtime -> Database: Store Control Loop Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Control Loop Instance stored

@enduml

2.2 Setting Instance Specific Parameters on a Control Loop Instance

...