Skip to content

Commit

Permalink
Move from text to description
Browse files Browse the repository at this point in the history
  • Loading branch information
@glguy
glguy committed Jan 13, 2021
1 parent d8271d2 commit 13ed266
Show file tree
Hide file tree
Showing 14 changed files with 77 additions and 117 deletions.
3 changes: 2 additions & 1 deletion Provenance-Example/Example.sadl
View file
Expand Up @@ -104,6 +104,7 @@ ExplanatoryRequirement
is a REQUIREMENT
createdBy DefineRequirements
dataInsertedBy WriteSomeSadl
text "Help RACK users understand the difference between
description
"Help RACK users understand the difference between
authorship of a requirement and the process of ingesting
that requirement into RACK itself".
51 changes: 10 additions & 41 deletions RACK-Ontology/OwlModels/REQUIREMENTS.owl
View file
Expand Up @@ -16,10 +16,6 @@
<owl:imports rdf:resource="http://sadl.org/sadlbasemodel"/>
<rdfs:comment xml:lang="en">This ontology was created from a SADL file 'REQUIREMENTS.sadl' and should not be directly edited.</rdfs:comment>
</owl:Ontology>
<owl:Class rdf:ID="REQUIREMENT_DEVELOPMENT">
<rdfs:comment xml:lang="en">ACTIVITY that produces REQUIREMENTs</rdfs:comment>
<rdfs:subClassOf rdf:resource="PROV-S#ACTIVITY"/>
</owl:Class>
<owl:Class rdf:ID="REQUIREMENT">
<rdfs:subClassOf>
<owl:Restriction>
Expand Down Expand Up @@ -48,43 +44,29 @@
</owl:onProperty>
</owl:Restriction>
</rdfs:subClassOf>
<rdfs:subClassOf>
<owl:Restriction>
<owl:cardinality rdf:datatype="http://www.w3.org/2001/XMLSchema#int"
>1</owl:cardinality>
<owl:onProperty>
<owl:DatatypeProperty rdf:ID="text"/>
</owl:onProperty>
</owl:Restriction>
</rdfs:subClassOf>
<rdfs:comment xml:lang="en">Captures (both high- and low-level) properties of a process or artifact that are to be assessed</rdfs:comment>
<rdfs:subClassOf rdf:resource="PROV-S#ENTITY"/>
</owl:Class>
<owl:Class rdf:ID="REQUIREMENT_DEVELOPMENT">
<rdfs:comment xml:lang="en">ACTIVITY that produces REQUIREMENTs</rdfs:comment>
<rdfs:subClassOf rdf:resource="PROV-S#ACTIVITY"/>
</owl:Class>
<owl:Class rdf:ID="DATA_DICTIONARY_TERM">
<rdfs:subClassOf>
<owl:Restriction>
<owl:maxCardinality rdf:datatype="http://www.w3.org/2001/XMLSchema#int"
>1</owl:maxCardinality>
<owl:onProperty>
<owl:DatatypeProperty rdf:about="#text"/>
</owl:onProperty>
</owl:Restriction>
</rdfs:subClassOf>
<rdfs:comment xml:lang="en">Defines some conceptual data that may be collected somewhere and used somewhere else</rdfs:comment>
<rdfs:subClassOf rdf:resource="PROV-S#ENTITY"/>
</owl:Class>
<owl:ObjectProperty rdf:ID="mitigates">
<rdfs:subPropertyOf rdf:resource="PROV-S#wasImpactedBy"/>
<rdfs:comment xml:lang="en">ENTITY(s) (e.g. HAZARD) that is being mitigated by this REQUIREMENT</rdfs:comment>
<rdfs:range rdf:resource="PROV-S#ENTITY"/>
<rdfs:domain rdf:resource="#REQUIREMENT"/>
</owl:ObjectProperty>
<owl:ObjectProperty rdf:ID="consumedBy">
<rdfs:subPropertyOf rdf:resource="PROV-S#wasImpactedBy"/>
<rdfs:comment xml:lang="en">ENTITY(s) (e.g. REQUIREMENT) that consumes this information</rdfs:comment>
<rdfs:range rdf:resource="PROV-S#ENTITY"/>
<rdfs:domain rdf:resource="#DATA_DICTIONARY_TERM"/>
</owl:ObjectProperty>
<owl:ObjectProperty rdf:ID="mitigates">
<rdfs:subPropertyOf rdf:resource="PROV-S#wasImpactedBy"/>
<rdfs:comment xml:lang="en">ENTITY(s) (e.g. HAZARD) that is being mitigated by this REQUIREMENT</rdfs:comment>
<rdfs:range rdf:resource="HAZARD#HAZARD"/>
<rdfs:domain rdf:resource="#REQUIREMENT"/>
</owl:ObjectProperty>
<owl:ObjectProperty rdf:ID="author">
<rdfs:subPropertyOf rdf:resource="PROV-S#wasAssociatedWith"/>
<rdfs:comment xml:lang="en">AGENT(s) responsible for producing a REQUIREMENT</rdfs:comment>
Expand Down Expand Up @@ -135,19 +117,6 @@
<rdfs:range rdf:resource="PROV-S#ENTITY"/>
<rdfs:domain rdf:resource="#REQUIREMENT"/>
</owl:ObjectProperty>
<owl:DatatypeProperty rdf:about="#text">
<rdfs:comment xml:lang="en">Description of the term</rdfs:comment>
<rdfs:domain>
<owl:Class>
<owl:unionOf rdf:parseType="Collection">
<owl:Class rdf:about="#REQUIREMENT"/>
<owl:Class rdf:about="#DATA_DICTIONARY_TERM"/>
</owl:unionOf>
</owl:Class>
</rdfs:domain>
<rdfs:range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
<rdfs:comment xml:lang="en">Description of the REQUIREMENT</rdfs:comment>
</owl:DatatypeProperty>
<owl:DatatypeProperty rdf:about="#thenText">
<rdfs:comment xml:lang="en">specifies what should hold by this requirement if the requirement conditions are met</rdfs:comment>
<rdfs:range rdf:resource="http://www.w3.org/2001/XMLSchema#string"/>
Expand Down
6 changes: 1 addition & 5 deletions RACK-Ontology/ontology/REQUIREMENTS.sadl
View file
Expand Up @@ -25,7 +25,6 @@ REQUIREMENT
(note "Captures (both high- and low-level) properties of a process or artifact that are to be assessed")
is a type of ENTITY.

text (note "Description of the REQUIREMENT") describes REQUIREMENT with a single value of type string.
// The "text" string can optionally be subdivided into sub-parts : givenText, ifText, thenText
// This corresponds to how rules are defined in SADL and note that in a SADL rule whatever is in
// givenText can simply be included in the ifText part.
Expand All @@ -45,7 +44,7 @@ REQUIREMENT
satisfies (note "Parent ENTITY(s) (e.g. REQUIREMENT) that this REQUIREMENT is derived from") describes REQUIREMENT with values of type ENTITY.
satisfies is a type of wasImpactedBy.

Rq:mitigates (note "ENTITY(s) (e.g. HAZARD) that is being mitigated by this REQUIREMENT") describes REQUIREMENT with values of type HAZARD.
Rq:mitigates (note "ENTITY(s) (e.g. HAZARD) that is being mitigated by this REQUIREMENT") describes REQUIREMENT with values of type ENTITY.
Rq:mitigates is a type of wasImpactedBy.

Rq:createdBy (note "ACTIVITY(s) (e.g. REQUIREMENT_DEVELOPMENT) that created this REQUIREMENT") describes REQUIREMENT with values of type ACTIVITY.
Expand All @@ -55,9 +54,6 @@ DATA_DICTIONARY_TERM
(note "Defines some conceptual data that may be collected somewhere and used somewhere else")
is a type of ENTITY.

text (note "Description of the term") describes DATA_DICTIONARY_TERM with values of type string.
text describes DATA_DICTIONARY_TERM with at most 1 value.

providedBy (note "ENTITY(s) (e.g. REQUIREMENT) that provides this information") describes DATA_DICTIONARY_TERM with values of type ENTITY.
providedBy is a type of wasImpactedBy.

Expand Down
6 changes: 3 additions & 3 deletions Turnstile-Ontology/01-System/TurnstilesSystemDesign.sadl
View file
Expand Up @@ -50,16 +50,16 @@ census is a SystemInterfaceDefinition,

Sys-1 is a SystemRequirement,
has identifier "Sys-1",
has text "Turnstile system shall track the number of people that travel through the in gate.",
has description "Turnstile system shall track the number of people that travel through the in gate.",
has governs Turnstile.

Sys-2 is a SystemRequirement,
has identifier "Sys-2",
has text "Turnstile system shall track the number of people that travel through the out gate. ",
has description "Turnstile system shall track the number of people that travel through the out gate. ",
has governs Turnstile.

Sys-3 is a SystemRequirement,
has identifier "Sys-3",
has text "Turnstile system shall track the number of people are currently in the park.",
has description "Turnstile system shall track the number of people are currently in the park.",
has governs Turnstile.

14 changes: 4 additions & 10 deletions Turnstile-Ontology/02-Software/01-Requirements/CounterApplicationRequirementSpec.sadl
View file
Expand Up @@ -28,30 +28,30 @@ HlrDev1 is a SoftwareRequirementsDefinition

HLR-1 is a HighLevelRequirement,
has identifier "HLR-1",
has text "The Computer shall increment the counter when a inflow event is received and the counter is less than max int.",
has description "The Computer shall increment the counter when a inflow event is received and the counter is less than max int.",
has Rq:satisfies Sys-1,
has Rq:mitigates H-1.2,
has Rq:governs CounterApplication,
has createdBy HlrDev1.

HLR-2 is a HighLevelRequirement,
has identifier "HLR-2",
has text "The Computer shall decrement the counter when a outflow event is received and the counter is greater than 0.",
has description "The Computer shall decrement the counter when a outflow event is received and the counter is greater than 0.",
has Rq:satisfies Sys-2,
has Rq:mitigates H-1.1,
has Rq:governs CounterApplication,
has createdBy HlrDev1.

HLR-3 is a HighLevelRequirement,
has identifier "HLR-3",
has text "The Computer shall publish the counter at a 1 htz rate.",
has description "The Computer shall publish the counter at a 1 htz rate.",
has Rq:satisfies Sys-3,
has Rq:governs CounterApplication,
has createdBy HlrDev1.

inflowEvent is a DataDictionary,
has identifier "inflowEvent",
has text "Signal indicating that a person has passed through the ingate"
has description "Signal indicating that a person has passed through the ingate"
has providedBy inflow,
has consumedBy HLR-1,
has createdBy HlrDev1.
Expand All @@ -74,9 +74,3 @@ display is a DataDictionary,
has providedBy HLR-3,
has consumedBy census,
has createdBy HlrDev1.






34 changes: 17 additions & 17 deletions Turnstile-Ontology/02-Software/02-Design/CounterApplicationDesignDescription.sadl
View file
Expand Up @@ -49,81 +49,81 @@ SwDesign is a SoftwareDesign

EXE-LLR-1 is a LowLevelRequirement,
has identifier "EXE-LLR-1",
has text "Executive shall spawn Input Thread on powerup.",
has description "Executive shall spawn Input Thread on powerup.",
has governs ExecutiveThread,
has createdBy LlrDev1.


EXE-LLR-2 is a LowLevelRequirement,
has identifier "EXE-LLR-2",
has text "Executive shall spawn Output Thread on powerup.",
has description "Executive shall spawn Output Thread on powerup.",
has governs ExecutiveThread,
has createdBy LlrDev1.


EXE-LLR-3 is a LowLevelRequirement,
has identifier "EXE-LLR-3",
has text "Executive shall print a single '.' character to the console every second when running.",
has description "Executive shall print a single '.' character to the console every second when running.",
has governs ExecutiveThread,
has createdBy LlrDev1.


IN-LLR-1 is a LowLevelRequirement,
has identifier "IN-LLR-1",
has text "Input Thread shall initialize the park_count to 0 on powerup.",
has description "Input Thread shall initialize the park_count to 0 on powerup.",
has governs InputThread,
has createdBy LlrDev1.

IN-LLR-2 is a LowLevelRequirement,
has identifier "IN-LLR-2",
has text "Input Thread shall check for a incoming UDP message on port 62000.",
has description "Input Thread shall check for a incoming UDP message on port 62000.",
has Rq:satisfies HLR-1,
has Rq:satisfies HLR-2,
has governs InputThread,
has createdBy LlrDev1.

IN-LLR-3 is a LowLevelRequirement,
has identifier "IN-LLR-3",
has text "Input Thread shall add the delta value received by the UDP to the park_count and send the updated park_count to the Output Thread when a valid UDP message is received and the park_count range is not exceed.",
has description "Input Thread shall add the delta value received by the UDP to the park_count and send the updated park_count to the Output Thread when a valid UDP message is received and the park_count range is not exceed.",
has Rq:satisfies HLR-1,
has Rq:satisfies HLR-2,
has governs InputThread,
has createdBy LlrDev1.

IN-LLR-4 is a LowLevelRequirement,
has identifier "IN-LLR-4",
has text "Input Thread shall limit park_count to between 0 and 1500.",
has description "Input Thread shall limit park_count to between 0 and 1500.",
has governs InputThread,
has createdBy LlrDev1.

IN-LLR-5 is a LowLevelRequirement,
has identifier "IN-LLR-5",
has text "Input Thread shall print 'Invalid Message' to the console when a invalid UDP message is received.",
has description "Input Thread shall print 'Invalid Message' to the console when a invalid UDP message is received.",
has governs InputThread,
has createdBy LlrDev1.

IN-LLR-6 is a LowLevelRequirement,
has identifier "IN-LLR-6",
has text "Input Thread shall print 'Limit Exceeded'' to the console when a valid UDP message is received and the park_count range is exceed.",
has description "Input Thread shall print 'Limit Exceeded'' to the console when a valid UDP message is received and the park_count range is exceed.",
has governs InputThread,
has createdBy LlrDev1.

OUT-LLR-1 is a LowLevelRequirement,
has identifier "OUT-LLR-1",
has text "Output Thread shall initialize the park_count to 0 on powerup.",
has description "Output Thread shall initialize the park_count to 0 on powerup.",
has governs OutputThread,
has createdBy LlrDev1.

OUT-LLR-2 is a LowLevelRequirement,
has identifier "OUT-LLR-2",
has text "Output Thread shall broadcast a UDP message on port 62001 with the park_count every second.",
has description "Output Thread shall broadcast a UDP message on port 62001 with the park_count every second.",
has Rq:satisfies HLR-3,
has governs OutputThread,
has createdBy LlrDev1.

DCC-1 is a DataAndControlCouple,
has identifier "DCC-1",
has text "PowerUp",
has description "PowerUp",
has consumedBy EXE-LLR-1,
has consumedBy EXE-LLR-2,
has consumedBy IN-LLR-1,
Expand All @@ -132,7 +132,7 @@ SwDesign is a SoftwareDesign

DCC-2 is a DataAndControlCouple,
has identifier "DCC-2",
has text "incoming UDP message",
has description "incoming UDP message",
has consumedBy IN-LLR-2,
has consumedBy IN-LLR-3,
has consumedBy IN-LLR-5,
Expand All @@ -141,7 +141,7 @@ SwDesign is a SoftwareDesign

DCC-3 is a DataAndControlCouple,
has identifier "DCC-3",
has text "input_park_count",
has description "input_park_count",
has consumedBy IN-LLR-2,
has consumedBy IN-LLR-3,
has consumedBy IN-LLR-4,
Expand All @@ -153,21 +153,21 @@ SwDesign is a SoftwareDesign

DCC-4 is a DataAndControlCouple,
has identifier "DCC-4",
has text "output_park_count",
has description "output_park_count",
has consumedBy OUT-LLR-2,
has providedBy OUT-LLR-1,
has providedBy IN-LLR-3,
has createdBy LlrDev1.

DCC-5 is a DataAndControlCouple,
has identifier "DCC-5",
has text "outgoing UDP message",
has description "outgoing UDP message",
has providedBy OUT-LLR-2,
has createdBy LlrDev1.

DCC-6 is a DataAndControlCouple,
has identifier "DCC-6",
has text "console",
has description "console",
has providedBy EXE-LLR-3,
has providedBy IN-LLR-5,
has providedBy IN-LLR-6,
Expand Down
8 changes: 4 additions & 4 deletions Turnstile-Ontology/99-Utils/NodeGroups/Ingest-DataAndControlCouple.json
View file
Expand Up @@ -125,10 +125,10 @@
"isMarkedForDeletion": false
},
{
"KeyName": "text",
"KeyName": "description",
"ValueType": "string",
"relationship": "http://www.w3.org/2001/XMLSchema#string",
"UriRelationship": "http://arcos.rack/REQUIREMENTS#text",
"UriRelationship": "http://arcos.rack/PROV-S#description",
"Constraints": "",
"fullURIName": "",
"SparqlID": "?text_DataAndControlCouple",
Expand Down Expand Up @@ -338,7 +338,7 @@
]
},
{
"URIRelation": "http://arcos.rack/REQUIREMENTS#text",
"URIRelation": "http://arcos.rack/PROV-S#description",
"mapping": [
{
"colId": "col_4",
Expand All @@ -352,4 +352,4 @@
}
]
}
}
}
6 changes: 3 additions & 3 deletions Turnstile-Ontology/99-Utils/NodeGroups/Ingest-DataDictionary.json
View file
Expand Up @@ -184,7 +184,7 @@
"KeyName": "text",
"ValueType": "string",
"relationship": "http://www.w3.org/2001/XMLSchema#string",
"UriRelationship": "http://arcos.rack/REQUIREMENTS#text",
"UriRelationship": "http://arcos.rack/PROV-S#description",
"Constraints": "",
"fullURIName": "",
"SparqlID": "?text_DataDictionary",
Expand Down Expand Up @@ -454,7 +454,7 @@
]
},
{
"URIRelation": "http://arcos.rack/REQUIREMENTS#text",
"URIRelation": "http://arcos.rack/PROV-S#description",
"mapping": [
{
"colId": "col_6",
Expand All @@ -468,4 +468,4 @@
}
]
}
}
}

0 comments on commit 13ed266

Please sign in to comment.