From 06514a62e3a56c365a0cea24526531dcabbaf983 Mon Sep 17 00:00:00 2001 From: haarer Date: Fri, 18 Oct 2024 14:13:17 +0200 Subject: [PATCH] work on standards and terms vp --- Gemfile.lock | 8 +- .../SAF_term_and_standard_C_Definition.md | 7 +- developing-saf/concept/concepts.md | 33 +- .../SAF_term_and_standard_C_Definition.svg | 121 +- .../Common-Standards-Definition-Viewpoint.md | 4 +- .../Common-Standards-Definition-Concept.svg | 77 +- .../Common-Standards-Definition-Profile.svg | 194 +- .../Common-Terms-Definition-Concept.svg | 2 +- .../Common-Terms-Definition-Profile.svg | 2 +- ...Definition-Viewpoint-primary-example-1.svg | 1254 +++++----- ...Definition-Viewpoint-primary-example-2.svg | 14 +- ...s-Definition-Viewpoint-primary-example.svg | 594 ++--- ...e-Definition-Viewpoint-primary-example.svg | 1958 ++++++++-------- ...ype-Overview-Viewpoint-primary-example.svg | 339 +-- ...t-Exchange-Viewpoint-primary-example-1.svg | 2040 ++++++++--------- src/_data/concept-diags.json | 166 +- src/_data/exposes.json | 4 +- src/_data/mdexamples.json | 214 +- src/_data/realizeconcept.json | 8 +- src/_data/stereotypes.json | 18 +- ...x_2_8710274_1700810074468_724882_47626.svg | 121 +- ...x_2_8710274_1674584322770_399266_27192.svg | 1954 ++++++++-------- ...x_2_8710274_1700819581949_354470_51885.svg | 594 ++--- ...1x_2_8710274_1700819812340_12506_51948.svg | 1254 +++++----- ...x_1_26f0132_1729187834545_976361_22741.svg | 14 +- ...24x_26f0132_1719745438501_922673_37455.svg | 393 ++-- ...24x_8710274_1717757970886_981437_15535.svg | 2040 ++++++++--------- stereotypes.csv | 8 +- stereotypes.md | 22 +- .../Common-Standards-Definition-Viewpoint.md | 4 +- 30 files changed, 6502 insertions(+), 6959 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index 718636ac..10067b67 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -88,10 +88,10 @@ GEM rexml (3.3.8) rouge (4.4.0) safe_yaml (1.0.5) - sass-embedded (1.79.4-x64-mingw-ucrt) - google-protobuf (~> 4.27) - sass-embedded (1.79.4-x86_64-linux-gnu) - google-protobuf (~> 4.27) + sass-embedded (1.80.2-x64-mingw-ucrt) + google-protobuf (~> 4.28) + sass-embedded (1.80.2-x86_64-linux-gnu) + google-protobuf (~> 4.28) sawyer (0.9.2) addressable (>= 2.3.5) faraday (>= 0.17.3, < 3) diff --git a/developing-saf/concept/SAF_term_and_standard_C_Definition.md b/developing-saf/concept/SAF_term_and_standard_C_Definition.md index 687043f1..2bcf5806 100644 --- a/developing-saf/concept/SAF_term_and_standard_C_Definition.md +++ b/developing-saf/concept/SAF_term_and_standard_C_Definition.md @@ -2,16 +2,17 @@ ![SAF_term_and_standard_C_Definition.svg](./diagrams/SAF_term_and_standard_C_Definition.svg) |Concept|Documentation| | --- | --- | +| ASFconformToSTD | Specifies, that a SAF Element may be conform to one or more Standards.| | Any SAF Element | A concept used only together with relational concepts to specify that the relation goes to any other SAF Concept.| +| Category Of Standard | Specifies categories in which the standard could be categorized , e.g., a data exchange format or a protocol standard, or categories as national, company or international standard.| | GYcontainsTRM | specifies that a glossary contains a number of terms. A term is contained only in one glossary. | | Glossary | specifies a coherent set of terms.| -| SDTcoveringSBS | Specifies the fact that a standard covers one or more specific subject of standardization, e.g., data exchange format or protocol.| +| SDTcategorizedCOF | Specifies the fact that a standard is categorized by one or more categories.| | SDTincludingSDT | Specifies the fact that a standard is part of another standard.| | SDTsupersedingSDT | Specifies the fact that a standard supersedes one or more other standards.| | STDcontainsGY | specifies that a standard may contain one or more glossaries.| | STDissuedBySTO | Specifies the fact that a standard is issued by an organization of standardization.| -| Standard | An international standard is a technical standard developed by one or more international standards organizations. International standards are available for consideration and use worldwide.| +| Standard | Specifies a standard which shall potentially be complied by the system or a part of the system.
| | Standardization Organization | An organization of standardization, e.g., International Organization for Standardization (ISO), Object Management Group (OMG), etc.| -| Subject of Standardization | Specifies a certain topic which the standard covers, e.g., a data exchange format or a protocol.| | TRMdefinedBySDT | Specifies the fact that a term is defined by a standard.| | Term | Specifies the fact that a term is usually defined by a standard, but can also be defined as part of system development work.| diff --git a/developing-saf/concept/concepts.md b/developing-saf/concept/concepts.md index a6cb0b5c..1a24a196 100644 --- a/developing-saf/concept/concepts.md +++ b/developing-saf/concept/concepts.md @@ -25,6 +25,12 @@ realized by Stereotype [SCM_AspectColumn](../../stereotypes.md#scm_aspectcolumn) Aspects capture a set of characteristics or features of the Entity of Interest in its Environment to address Concerns within an Architecture Description. ## Asset +## Category Of Standard +exposed in viewpoint [Common Standards Definition Viewpoint](../viewpoints/Common-Standards-Definition-Viewpoint.md) + +realized by Stereotype [SAF_StandardCategory](../../stereotypes.md#saf_standardcategory) + +Specifies categories in which the standard could be categorized , e.g., a data exchange format or a protocol standard, or categories as national, company or international standard. ## Claim exposed in viewpoint [Argumentation Assurance Viewpoint](../viewpoints/Argumentation-Assurance-Viewpoint.md) @@ -572,7 +578,8 @@ exposed in viewpoint [Common Standards Definition Viewpoint](../viewpoints/Commo realized by Stereotype [SAF_Standard](../../stereotypes.md#saf_standard) -An international standard is a technical standard developed by one or more international standards organizations. International standards are available for consideration and use worldwide. +Specifies a standard which shall potentially be complied by the system or a part of the system. + ## Standardization Organization exposed in viewpoint [Common Standards Definition Viewpoint](../viewpoints/Common-Standards-Definition-Viewpoint.md) @@ -585,12 +592,6 @@ exposed in viewpoint [Argumentation Assurance Viewpoint](../viewpoints/Argumenta realized by Stereotype [SAF_ClaimSubject](../../stereotypes.md#saf_claimsubject) Note: A claim cannot be generic, it has to be about something, it has to have a defined subject, e.g., system safety. -## Subject of Standardization -exposed in viewpoint [Common Standards Definition Viewpoint](../viewpoints/Common-Standards-Definition-Viewpoint.md) - -realized by Stereotype [SAF_StandardizationSubject](../../stereotypes.md#saf_standardizationsubject) - -Specifies a certain topic which the standard covers, e.g., a data exchange format or a protocol. ## SysML Stereotype exposed in viewpoint [Framework Viewpoint Implementation Viewpoint](../viewpoints/Framework-Viewpoint-Implementation-Viewpoint.md) @@ -786,6 +787,14 @@ Specifies the fact that a Physical System Element can be in distinct states. 1 [Abstract Physical Element](#Abstract-Physical-Element) APEimplementingGFN 1..* [General Function](#General-Function) +## ASFconformToSTD +0..* [Any SAF Element](#Any-SAF-Element) ASFconformToSTD 0..* [Standard](#Standard) + +exposed in viewpoint [Common Standards Definition Viewpoint](../viewpoints/Common-Standards-Definition-Viewpoint.md) + +realized by Stereotype [SAF_ConformsStandard](../../stereotypes.md#saf_conformsstandard) + +Specifies, that a SAF Element may be conform to one or more Standards. ## CCMcounteringCIM 0..* [CounterClaim](#CounterClaim) CCMcounteringCIM 0..* [Claimable Item](#Claimable-Item) @@ -1494,14 +1503,14 @@ exposed in viewpoint [System Interface Definition Viewpoint](../viewpoints/Syste realized by FlowProperty typed by SAF_DomainKind Specifies the fact that a System Domain Kind defines the type of a Logical Interaction Point Property. -## SDTcoveringSBS -0..* [Standard](#Standard) SDTcoveringSBS 0..* [Subject of Standardization](#Subject-of-Standardization) +## SDTcategorizedCOF +0..* [Standard](#Standard) SDTcategorizedCOF 0..* [Category Of Standard](#Category-Of-Standard) exposed in viewpoint [Common Standards Definition Viewpoint](../viewpoints/Common-Standards-Definition-Viewpoint.md) -realized by Stereotype [SAF_StandardCovering](../../stereotypes.md#saf_standardcovering) +realized by Stereotype [SAF_StandardCategoryAssignment](../../stereotypes.md#saf_standardcategoryassignment) -Specifies the fact that a standard covers one or more specific subject of standardization, e.g., data exchange format or protocol. +Specifies the fact that a standard is categorized by one or more categories. ## SDTincludingSDT 0..* [Standard](#Standard) SDTincludingSDT 0..* [Standard](#Standard) @@ -1746,7 +1755,7 @@ realized by Stereotype [SCM_RealizeConcept](../../stereotypes.md#scm_realizeconc specifies, that one ore more SAF Stereotypes implement a viewpoint. Note: Multiple Stereotypes are used if there are alternate presentations. ## STDcontainsGY -1 [Standard](#Standard) STDcontainsGY 0..* [Glossary](#Glossary) +0..* [Standard](#Standard) STDcontainsGY 0..* [Glossary](#Glossary) realized by SAF_Glossary contained in SAF_Standard diff --git a/developing-saf/concept/diagrams/SAF_term_and_standard_C_Definition.svg b/developing-saf/concept/diagrams/SAF_term_and_standard_C_Definition.svg index b448517a..f413eecf 100644 --- a/developing-saf/concept/diagrams/SAF_term_and_standard_C_Definition.svg +++ b/developing-saf/concept/diagrams/SAF_term_and_standard_C_Definition.svg @@ -1,11 +1,11 @@ - - - - -Implementation of SAF Concept ASFconformToSTD
ASFconformToSTD: Specifies, that a SAF Element may be conform to one or more Standards.
\n" }, { "Name" : "SAF_ContextAction", "ID" : "_2021x_2_8710274_1676920197680_884628_29235", @@ -97,7 +97,7 @@ }, { "Name" : "SAF_Glossary", "ID" : "_2024x_1_26f0132_1729193328493_921636_25629", - "Documentation" : "" + "Documentation" : "Implementation of SAF Concept Glossary
Glossary: specifies a coherent set of terms.
\n" }, { "Name" : "SAF_InterfaceLayerRelationship", "ID" : "_2021x_2_8710274_1695985266083_110612_25287", @@ -313,11 +313,15 @@ }, { "Name" : "SAF_Standard", "ID" : "_2021x_2_8710274_1700810557668_637315_48235", - "Documentation" : "Implementation of SAF Concept Standard
Standard: An international standard is a technical standard developed by one or more international standards organizations. International standards are available for consideration and use worldwide.
\n" + "Documentation" : "Implementation of SAF Concept Standard
Standard: Specifies a standard which shall potentially be complied by the system or a part of the system.\n
\n" +}, { + "Name" : "SAF_StandardCategory", + "ID" : "_2021x_2_8710274_1700819040067_20402_51257", + "Documentation" : "Implementation of SAF Concept Category Of Standard
Category Of Standard: Specifies categories in which the standard could be categorized , e.g., a data exchange format or a protocol standard, or categories as national, company or international standard.
\n" }, { - "Name" : "SAF_StandardCovering", + "Name" : "SAF_StandardCategoryAssignment", "ID" : "_2021x_2_8710274_1701360709869_194778_91148", - "Documentation" : "Implementation of SAF Concept SDTcoveringSBS
SDTcoveringSBS: Specifies the fact that a standard covers one or more specific subject of standardization, e.g., data exchange format or protocol.
\n" + "Documentation" : "Implementation of SAF Concept SDTcategorizedCOF
SDTcategorizedCOF: Specifies the fact that a standard is categorized by one or more categories.
\n" }, { "Name" : "SAF_StandardSuperseding", "ID" : "_2021x_2_8710274_1700817699465_496750_50736", @@ -326,10 +330,6 @@ "Name" : "SAF_StandardizationOrganization", "ID" : "_2021x_2_8710274_1700812596870_49325_49849", "Documentation" : "Implementation of SAF Concept Standardization Organization
Standardization Organization: An organization of standardization, e.g., International Organization for Standardization (ISO), Object Management Group (OMG), etc.
\n" -}, { - "Name" : "SAF_StandardizationSubject", - "ID" : "_2021x_2_8710274_1700819040067_20402_51257", - "Documentation" : "Implementation of SAF Concept Subject of Standardization
Subject of Standardization: Specifies a certain topic which the standard covers, e.g., a data exchange format or a protocol.
\n" }, { "Name" : "SAF_SystemCapability", "ID" : "_19_0_3_6d8019d_1614802234951_841733_423", diff --git a/src/diagrams/concept/exa_2021x_2_8710274_1700810074468_724882_47626.svg b/src/diagrams/concept/exa_2021x_2_8710274_1700810074468_724882_47626.svg index b448517a..f413eecf 100644 --- a/src/diagrams/concept/exa_2021x_2_8710274_1700810074468_724882_47626.svg +++ b/src/diagrams/concept/exa_2021x_2_8710274_1700810074468_724882_47626.svg @@ -1,11 +1,11 @@ - - - - -Implementation of SAF Concept ASFconformToSTD
ASFconformToSTD: Specifies, that a SAF Element may be conform to one or more Standards.
+ ## SAF_ContextAction @@ -1629,43 +1630,44 @@ A assignment matrix featuring *none* ### Documentation -Implementation of SAF Concept Standard
Standard: An international standard is a technical standard developed by one or more international standards organizations. International standards are available for consideration and use worldwide.
+Implementation of SAF Concept Standard
Standard: Specifies a standard which shall potentially be complied by the system or a part of the system. +
-## SAF_StandardCovering +## SAF_StandardCategory ### Icon *none* ### Documentation -Implementation of SAF Concept SDTcoveringSBS
SDTcoveringSBS: Specifies the fact that a standard covers one or more specific subject of standardization, e.g., data exchange format or protocol.
+Implementation of SAF Concept Category Of Standard
Category Of Standard: Specifies categories in which the standard could be categorized , e.g., a data exchange format or a protocol standard, or categories as national, company or international standard.
-## SAF_StandardSuperseding +## SAF_StandardCategoryAssignment ### Icon *none* ### Documentation -Implementation of SAF Concept SDTsupersedingSDT
SDTsupersedingSDT: Specifies the fact that a standard supersedes one or more other standards.
+Implementation of SAF Concept SDTcategorizedCOF
SDTcategorizedCOF: Specifies the fact that a standard is categorized by one or more categories.
-## SAF_StandardizationOrganization +## SAF_StandardSuperseding ### Icon *none* ### Documentation -Implementation of SAF Concept Standardization Organization
Standardization Organization: An organization of standardization, e.g., International Organization for Standardization (ISO), Object Management Group (OMG), etc.
+Implementation of SAF Concept SDTsupersedingSDT
SDTsupersedingSDT: Specifies the fact that a standard supersedes one or more other standards.
-## SAF_StandardizationSubject +## SAF_StandardizationOrganization ### Icon *none* ### Documentation -Implementation of SAF Concept Subject of Standardization
Subject of Standardization: Specifies a certain topic which the standard covers, e.g., a data exchange format or a protocol.
+Implementation of SAF Concept Standardization Organization
Standardization Organization: An organization of standardization, e.g., International Organization for Standardization (ISO), Object Management Group (OMG), etc.
## SAF_SystemCapability diff --git a/viewpoints/Common-Standards-Definition-Viewpoint.md b/viewpoints/Common-Standards-Definition-Viewpoint.md index 8ddc769d..647cccf5 100644 --- a/viewpoints/Common-Standards-Definition-Viewpoint.md +++ b/viewpoints/Common-Standards-Definition-Viewpoint.md @@ -28,11 +28,11 @@ The following Stereotypes / Model Elements are used in the Viewpoint: * [SAF_C2_CSTD_Table](../stereotypes.md#saf_c2_cstd_table) * [SAF_ConformsStandard](../stereotypes.md#saf_conformsstandard) * [SAF_IssuedBy](../stereotypes.md#saf_issuedby) -* [SAF_StandardCovering](../stereotypes.md#saf_standardcovering) +* [SAF_StandardCategoryAssignment](../stereotypes.md#saf_standardcategoryassignment) +* [SAF_StandardCategory](../stereotypes.md#saf_standardcategory) * [SAF_StandardSuperseding](../stereotypes.md#saf_standardsuperseding) * [SAF_Standard](../stereotypes.md#saf_standard) * [SAF_StandardizationOrganization](../stereotypes.md#saf_standardizationorganization) -* [SAF_StandardizationSubject](../stereotypes.md#saf_standardizationsubject) ## Input from other Viewpoints ### Required Viewpoints *none*