OMGSysML v1.6 18 12 08
OMGSysML v1.6 18 12 08
OMGSysML v1.6 18 12 08
http://www.omg.org/spec/SysML/20181001/SysML.xmi
Non-normative:
http://www.omg.org/spec/SysML/20181001/SysMLDI.xmi
http://www.omg.org/spec/SysML/20181001/QUDV.xmi
http://www.omg.org/spec/SysML/20181001/ISO800000.xmi
Refer to the Roadmap located in the Preface for a list of documents that were generated as part of the
adoption, finalization, and revision process.
Copyright © 2003-2018, American Systems Corporation
Copyright © 2003-2018, PTC Inc.
Copyright © 2003-2018, BAE SYSTEMS
Copyright © 2003-2018, The Boeing Company
Copyright © 2003-2018, Ceira Technologies
Copyright © 2003-2018, Deere & Company
Copyright © 2003-2018, Airbus
Copyright © 2003-2018, EmbeddedPlus Engineering
Copyright © 2007-2018, European Aeronautic Defence and Space Company N.V.
Copyright © 2003-2018, Eurostep Group AB
Copyright © 2003-2018, Gentleware AG
Copyright © 2003-2018, I-Logix, Inc.
Copyright © 2003-2018, International Business Machines
Copyright © 2003-2018, International Council on Systems Engineering
Copyright © 2003-2018, Israel Aircraft Industries
Copyright © 2003-2018, Lockheed Martin Corporation
Copyright © 2003-2018, Mentor Graphics
Copyright © 2003-2018, Motorola, Inc.
Copyright © 2007-2018, National Aeronautics and Space Administration
Copyright © 2007-2018, No Magic, Inc.
Copyright © 2003-2018, Northrop Grumman
Copyright © 1997-2018 , Object Management Group
Copyright © 2003-2018, oose Innovative Informatik eG
Copyright © 2003-2018, PivotPoint Technology Corporation
Copyright © 2003-2018, Raytheon Company
Copyright © 2003-2018, Sparx Systems
Copyright © 2003-2018, Telelogic AB
Copyright © 2003-2018, THALES
PATENTS
The attention of adopters is directed to the possibility that compliance with or adoption of OMG specifications may
require use of an invention covered by patent rights. OMG shall not be responsible for identifying patents for which a
license may be required by any OMG specification, or for conducting legal inquiries into the legal validity or scope of
those patents that are brought to its attention. OMG specifications are prospective and advisory only. Prospective users
are responsible for protecting themselves against liability for infringement of patents.
DISCLAIMER OF WARRANTY
WHILE THIS PUBLICATION IS BELIEVED TO BE ACCURATE, IT IS PROVIDED "AS IS" AND MAY CONTAIN
ERRORS OR MISPRINTS. THE OBJECT MANAGEMENT GROUP AND THE COMPANIES LISTED ABOVE
MAKE NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH REGARD TO THIS PUBLICATION,
INCLUDING BUT NOT LIMITED TO ANY WARRANTY OF TITLE OR OWNERSHIP, IMPLIED WARRANTY OF
MERCHANTABILITY OR WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE OR USE. IN NO EVENT
SHALL THE OBJECT MANAGEMENT GROUP OR ANY OF THE COMPANIES LISTED ABOVE BE LIABLE
FOR ERRORS CONTAINED HEREIN OR FOR DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
CONSEQUENTIAL, RELIANCE OR COVER DAMAGES, INCLUDING LOSS OF PROFITS, REVENUE, DATA
OR USE, INCURRED BY ANY USER OR ANY THIRD PARTY IN CONNECTION WITH THE FURNISHING,
PERFORMANCE, OR USE OF THIS MATERIAL, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
The entire risk as to the quality and performance of software developed using this specification is borne by you. This
disclaimer of warranty constitutes an essential part of the license granted to you to use this specification.
TRADEMARKS
CORBA , CORBA logos , FIBO , Financial Industry Business Ontology®, FINANCIAL INSTRUMENT GLOBAL
® ® ®
IDENTIFIER®, IIOP®, IMM®, Model Driven Architecture®, MDA®, Object Management Group®, OMG®, OMG Logo®,
SoaML®, SOAML®, SysML®, UAF®, Unified Modeling Language®, UML®, UML Cube Logo®, VSIPL®, and XMI® are
registered trademarks of the Object Management Group, Inc.
For a complete list of trademarks, see: http://www.omg.org/legal/tm_list.htm. All other products or company names
mentioned are used for identification purposes only, and may be trademarks of their respective owners.
COMPLIANCE
The copyright holders listed above acknowledge that the Object Management Group (acting itself or through its
designees) is and shall at all times be the sole entity that may authorize developers, suppliers and sellers of computer
software to use certification marks, trademarks or other special designations to indicate compliance with these
materials.
Software developed under the terms of this license may claim compliance or conformance with this specification if and
only if the software compliance is of a nature fully matching the applicable compliance points as stated in the
specification. Software developed only partially matching the applicable compliance points may claim only that the
software was based on this specification, but may not claim compliance or conformance with this specification. In the
event that testing suites are implemented or approved by Object Management Group, Inc., software developed using
this specification may claim compliance or conformance with the specification only if the software satisfactorily
completes the testing suites.
All OMG specifications are subject to continuous review and improvement. As part of this process we encourage
readers to report any ambiguities, inconsistencies, or inaccuracies they may find by completing the Issue Reporting
Form listed on the main web page http://www.omg.org, under Documents, Report a Bug/Issue
(http://issues.omg.org/issues/create-new-issue).
OMG Specifications
As noted, OMG specifications address middleware, modeling and vertical domain frameworks. All OMG Specifications
are available from the OMG website at:
http://www.omg.org/spec
Specifications are organized by the following categories:
Middleware Specifications
• CORBA/IIOP
• Data Distribution Services
• Specialized CORBA
Modernization Specifications
Typographical Conventions
The type styles shown below are used in this document to distinguish programming statements from ordinary English.
However, these conventions are not used in tables or section headings where no distinction is necessary.
Times/Times New Roman/Liberation Serif – 10 pt.: Standard body text
Helvetica/Arial – 10 pt. Bold: OMG Interface Definition Language (OMG IDL) and syntax elements.
Courier – 10 pt. Bold: Programming language elements.
Helvetica/Arial – 10 pt: Exceptions
NOTE: Terms that appear in italics are defined in the glossary. Italic text also represents the name of a document,
specification, or other publication.
Issues
The reader is encouraged to report any technical or editing issues/problems with this specification via the report form
at:
http://issues.omg.org/issues/create-new-issue
The Finalization Task Force (FTF) process generated the following documents:
Beta 1: ptc/2006-05-04 (a.k.a. Final Adopted Specification)
Beta 2: ptc/2007-03-19 (FTF Report - full record of FTF votes and issue resolutions
ptc/2007-02-03, ptc/2007-03-04 (a.k.a. convenience document, with and without change bars)
ptc/2007-02-05 (XMI)
ptc/2007-03-09 (Annex E - Requirements Traceability)
Version 1.0 Formal Specification: formal/2007-09-01
The SysML 1.1 Revision Task Force (RTF) process generated the following documents:
ptc/2008-05-15 (RTF Report - full record of RTF votes and issue resolutions)
ptc/2008-05-16, ptc/2008-05-17 (a.k.a. convenience document, with and without change bars)
ptc/2008-05-18 (XMI)
Version 1.1 Formal Specification: formal/2008-11-01, formal/2008-11-02
Associated schema files for this specification, at http://www.omg.org/spec/SysML/20090501/, include the following
files:
SysML-profile.xmi XMI 2.1 serialization of the SysML Profile
Activities-model.xmi XMI 2.1 serialization of the Activities model library
Blocks-model.xmi XMI 2.1 serialization of the Blocks model library
UML4SysML-metamodel.xmi XMI 2.1 serialization of the merged UML4SysML subset of UML 2
(used to define the SysML Profile)
The SysML 1.2 Revision Task Force (RTF) process generated the following documents:
ptc/2008-05-15 (RTF Report - full record of RTF votes and issue resolutions)
ptc/2008-05-16, ptc/2008-05-17 (a.k.a. convenience document, with and without change bars)
ptc/2008-05-18 (XMI)
Version 1.2 Formal Specification: formal/2010-06-01, formal/2010-06-02
Associated schema file for this specification, at http://www.omg.org/spec/SysML/20100301, include the following files:
SysML-profile.uml XMI 2.1 serialization of the SysML Profile
The SysML 1.3 Revision Task Force (RTF) process generated the following documents:
ptc/2011-08-08 (RTF Report - full record of RTF votes and issue resolutions)
ptc/2011-08-07 (Submission inventory document)
ptc/2011-08-09, ptc/2011-08-10 (Beta “convenience document,” with and without change bars)
ptc/2011-08-11, ptc/2011-08-12 (Normative and non-normative XMI)
ptc/2012-04-07, ptc/2012-04-08 (Normative and non-normative XMI)
Version 1.3 Formal Specification: formal/2012-06-01, formal/2012-06-02
Associated schema files for this specification, at http://www.omg.org/spec/SysML/20120401/, include the following
files:
SysML.xmi (Normative)
ISO-80000-1-QUDV.xmi (Non-normative)
ISO-80000-1-SysML.xmi (Non-normative)
QUDV.xmi (Non-normative)
The SysML 1.4 Revision Task Force (RTF) process generated the following documents:
ptc/2013-12-08 (RTF Report - full record of RTF votes and issue resolutions)
ptc/2013-12-10, ptc/2013-12-09 (Beta “convenience document,” with and without change bars)
ptc/2013-12-11, ptc/2013-12-12 (Normative and non-normative XMI)
Version 1.4 Formal Specification: formal/2015-06-03, formal/2015-06-04
Associated schema files for this specification, at http://www.omg.org/spec/SysML/20131201/, include the following
files:
SysML.xmi (Normative)
SysMLDI.xmi (Normative)
ISO-80000-1-QUDV.xmi (Non-normative)
ISO-80000-1-SysML.xmi (Non-normative)
QUDV.xmi (Non-normative)
The SysML 1.5 Revision Task Force (RTF) process generated the following documents:
ptc/2016-11-01 (RTF Report - full record of RTF votes and issue resolutions)
ptc/2016-11-02, ptc/2016-11-03 (Beta “convenience document,” with and without change bars)
ptc/2016-11-05, ptc/2016-11-06, ptc/16-11-07, ptc/16-11-08 (Normative and non-normative XMI)
Associated schema files for this specification, at http://www.omg.org/spec/SysML/20161101/, include the following
files:
The SysML 1.6 Revision Task Force (RTF) process generated the following documents:
ptc/2018-10-01 (RTF Report - full record of RTF votes and issue resolutions)
ptc/2018-10-02, ptc/2018-10-03 (Beta “convenience document,” with and without change bars)
ptc/2018-10-04, ptc/2018-10-05, ptc/2018-10-06, ptc/2018-10-07, ptc/2018-10-08 (Normative and non-
normative XMI)
Associated schema files for this specification, at http://www.omg.org/spec/SysML/20161101/, include the following
files:
SysML.xmi (Normative)
ISO-80000-1-QUDV.xmi (Non-normative)
ISO-80000-1-SysML.xmi (Non-normative)
QUDV.xmi (Non-normative)
This International Standard defines a general-purpose language for systems engineering applications, called the OMG
Systems Modeling Language (OMG SysMLTM). Throughout the rest of this International Standard the language will
be referred to as SysML.
SysML supports the specification, analysis, design, verification, and validation of a broad range of complex systems.
These systems may include hardware, software, information, processes, personnel, and facilities.
It is common practice for engineers to use a wide range of modeling languages, tools, and techniques on large systems
projects. SysML is intended to unify diverse modeling languages used by systems engineers and can be used with a
wide variety of discipline- and domain-specific modeling languages.
3.2.1 Organization
This International Standard is organized as follows:
Preface
INTRODUCTION
1 Scope
2 Normative References
3 Additional Information - includes Relationships to Other Standards, How to Read this International Standard, and
Acknowledgments
4 Language Architecture - General Information, Design Principles, Architecture, and SsyML Diagrams
5 Conformance - General Information and Conformance Types
6 Language Formalism -
• Levels of Formalism
• Clause Structure
• Conventions and Typography
STRUCTURAL CONSTRUCTS
7 Model Elements - Refactors the kernel package from UML 2 and includes some extensions to provide some
foundation capabilities for model management.
ANNEXES
Annex A - Diagrams
Annex B - SysML Diagram Interchange
Annex C - Deprecated Elements
Annex D - Sample Problem
Annex E - Non-normative Extensions
Annex F - Requirements Traceability
Annex G - Model Interchange
3.3 Acknowledgments
The following companies and organizations submitted or supported parts of the original version of this International
Standard:
Industry
• American Systems Corporation
• BAE SYSTEMS
• Boeing
• Deere & Company
• EADS Astrium
Table 4.2: UML 2 metaclasses and datatypes included in the UML4SysML subset
4.3 Architecture
The relationship between SysML and UML 2 is shown in Figure 4.2. SysML extends UML 2’s StandardProfile (see
Clause 22 in the UML 2.5 specification) whose Trace and Refine stereotypes provide the basis for Requirement
traceability in SysML (see Clause 16, “Requirements” in this International Standard).
Although SysML indirectly imports the UML 2 PrimitiveTypes library (see Clause 21 in the UML 2.5 specification)
due to the transitivity of package import, SysML provides a PrimitiveValueTypes model library that systems engineers
can extend via SysML’s ValueType stereotype. In the remainder of this document, the unqualified references to
Boolean, Integer, Real, and String should be interpreted as follows:
In the context of the definition of a SysML Stereotype, the name refers to the definition of a UML::PrimitiveType in the
UML 2 PrimitiveTypes library.
• In the context of the definition of a SysML Stereotype, the name refers to the definition of a
UML::PrimitiveType in the UML 2 PrimitiveTypes library.
• Elsewhere, the name refers to the definition of a SysML::ValueType stereotype of UML::DataType in the
SysML PrimitiveValueTypes library.
6.2.1 Overview
This sub clause provides an overview of the SysML modeling constructs defined in the subject package, which are
usually associated with one or more SysML diagram types.
Comment UML4SysML::Comment
ConstraintNote UML4SysML::Constraint
ConstraintTextualNote UML4SysML::Constraint
ElementGroup SysML::ModelElements::Element
Group
Model UML4SysML::Model
PackageDiagram UML4SysML::Package
Element Name Concrete Syntax Example Abstract Syntax Reference
Subpackage2
Subpackage1 «import»
Package1
{uri=http://www.abc.com/models/Package1}
PackageWithNameInside UML4SysML::Package
Problem SysML::ModelElements::Problem
Rationale SysML::ModelElements::Rationale
Stakeholder SysML::ModelElements::Stakeholder
View SysML::ModelElements::View
Viewpoint SysML::ModelElements::Viewpoint
Conform UML4SysML::Conform
Expose SysML::ModelElements::Expose
Dependency UML4SysML::Dependency
Element Name Concrete Syntax Example Abstract Syntax Reference
PublicPackageImport UML4SysML::PackageImport
with
visibility = public
PrivatePackageImport UML4SysML::PackageImport
with visibility = private
PackageContainment UML4SysML::Package::ownedEl
ement
Realization UML4SysML::Realization
Refine UML4SysML::Refine
The notation for a “merge” dependency between packages, using a «merge» keyword on a dashed-line arrow, is
not included in SysML. UML uses package merge in the definition of its own metamodel, which SysML builds
on, but SysML does not support this capability for user-level models.
7.3.2 Stereotypes
Package ModelElements
7.3.2.1 Conform
Description
A Conform relationship is a dependency between a view and a viewpoint. The view conforms to the specified
rules and conventions detailed in the viewpoint. Conform is a specialization of the UML dependency, and as
with other dependencies the arrow direction points from the (client/source) to the (supplier/target).
Association Ends
• base_Generalization : Generalization [1]
Constraints
• 1_general_is_viewpoint
The general classifier shall be an element stereotyped by Viewpoint
Viewpoint.allInstances()->exists(v | v.base_Class =
self.base_Generalization.general)
• 2_specific_is_view
The specific classifier shall be an element that is stereotyped by View
View.allInstances()->exists(v | v.base_Class =
self.base_Generalization.specific)
7.3.2.2 ElementGroup
Description
The ElementGroup stereotype provides a lightweight mechanism for grouping various and possibly
heterogeneous model elements by extending the capability of comments to refer to multiple annotated elements.
For example, it can group elements that are associated with a particular release of the model, have a certain risk
level, or are associated with a legacy design. The semantics of ElementGroup is modeler-defined. In particular,
the body text is not restricted. It can describe the grouped elements as well as elements or values related to the
grouped elements.
Element groups are named using the name property. The criterion for membership in an element group is
specified by the body of the comment the stereotype is applied to. By grouping elements, the modeler asserts
that the criterion of the group applies to the member. Optionally, members of an element group can be ordered
using its orderedMember property.
ElementGroups appear in diagrams as comments, and properties of the stereotype appear in the notation for
stereotype properties. Grouped elements are the annotated elements of the comment to which the stereotype is
applied. This has several implications:
• Element groups do not own their elements and thus an element can participate in an unlimited number of
groups.
• The elements in a group are identified by the modeler, as opposed to being the result of a query, as in views.
• Element groups can be members of other element groups, but this does not imply that members of the first are
members of the second.
Elements related to the grouped elements are not included in the group, even though the body text can address
them. In particular, element groups annotating deeply nested properties or properties with bindings are grouping
only the properties, rather than their nesting or their bound properties.
Grouped elements are also limited to elements of models, rather than instances of values of those model
elements. In particular, element groups annotating blocks or properties are not grouping the instances of the
blocks or the values of the properties. However, since the semantics of ElementGroup is left to the modeler, the
body text can refer to related elements outside the group, such as instances and values of the grouped elements,
or to bound properties. The modeler is then responsible for writing body text that explains the implications for
the related elements. For instance:
• A group with the criterion: "Authored by John" could annotate any model element added in the model by
John. This body text does not address any related elements. For example, if the annotated element is a property
bound to another property, the group would not imply authorship of the second property.
• A group with the criterion: "Instances are manufactured in a foreign country" could annotate Blocks to
indicate that any instances of those Blocks are produced in a foreign country. This body text does not address
the Block itself, which is not necessarily "manufactured" in a foreign country.
• A group with criterion: "Values are manufactured in a foreign country" could annotate properties, including
part properties, to indicate the values of the property are produced in a foreign country. This body text does not
address the property itself, which is not necessarily "manufactured" in a foreign country. Since the text is about
values of the property, it is also about values of other properties that might be bound to the annotated property,
because the values of bound properties are the same.
7.3.2.3 Expose
Description
The expose relationship relates a view to one or more model elements. Each model element is an access point to
initiate the query. The view and the model elements related to the view are passed to the constructor when it is
invoked. The method describes how the exposed elements are navigated to extract the desired information.
Association Ends
• base_Dependency : Dependency [1]
Constraints
• 1_client_is_view
The client shall be an element stereotyped by View.
View.allInstances()->exists(v | v.base_Class = self.base_Dependency.client)
7.3.2.4 Problem
Description
A Problem documents a deficiency, limitation, or failure of one or more model elements to satisfy a requirement
or need, or other undesired outcome. It may be used to capture problems identified during analysis, design,
verification, or manufacture and associate the problem with the relevant model elements. Problem is a
stereotype of comment and may be attached to any other model element in the same manner as a comment.
Association Ends
• base_Comment : Comment [1]
7.3.2.5 Rationale
Description
A Rationale documents the justification for decisions and the requirements, design, and other decisions. A
Rationale can be attached to any model element including relationships. It allows the user, for example, to
specify a rationale that may reference more detailed documentation such as a trade study or analysis report.
Rationale is a stereotype of comment and may be attached to any other model element in the same manner as a
comment.
Association Ends
• base_Comment : Comment [1]
7.3.2.6 Stakeholder
Description
A stakeholder represents a role, group, or individual who has concerns that will be addressed by the View of the
model.
Attributes
• /concern : String [0..*]
(derived)
• concernList : Comment [0..*]
Association Ends
• base_Classifier : Classifier [1]
Constraints
• 1_not_association
A Stakeholder stereotype can only be applied to UML::Actor or UML::Class which are not a
UML::Association.
self.base_Classifier.oclIsKindOf(UML::Actor)
or
(self.base_Classifier.oclIsKindOf(UML::Class)
and
not self.base_Classifier.oclIsKindOf(UML::Association))
• not_association
The stakeholder stereotype can only be applied to UML::Actor or UML::Class which are not a
UML::Association
(self.base_Classifier.oclIsKindOf(UML::Actor) or
self.base_Classifier.oclIsKindOf(UML::Class))
and not self.base_Classifier.oclIsKindOf(UML::Association)
Description
A View is a model element that represents a real world artifact that can be presented to stakeholders. The view is
the result of querying one or more models that are defined by a viewpoint method. The view shall conform to
the viewpoint in terms of the viewpoint stakeholders, concerns, method, language, and presentation
requirements.
It is sometimes desirable to construct views from other views, and to establish an order for presenting the views.
Views may include one or more views as properties, each of which conforms to their viewpoint. The order of
the referenced views is reflected in the property order.
The information may be presented to the stakeholder in any format specified by the viewpoint, which may
include figures, tables, plots, entire documents, presentation slides, or video.
Attributes
• /stakeholder : Stakeholder [0..*]
The list of stakeholders is derived from the viewpoint the view conforms to.
(derived)
• /viewpoint : Viewpoint [1]
The viewpoint for this View is derived from the conform relationship.
(derived)
Association Ends
• base_Class : Class [1]
Constraints
• 1_single_viewpoint
A view shall only conform to a single viewpoint
Conform.allInstances()->select(base_Generalization.specific =
self.base_Class)->size() = 1
• 2_viewpoint_derived_from_conform
The derived value of the viewpoint shall be the classifier stereotyped by Viewpoint that is the general
classifier of the generalization relationship stereotyped by Conform for which the View is the specific
classifier
self.viewpoint = Viewpoint.allInstances()->any(base_Class =
Conform.allInstances()->any(base_Generalization.specific =
self.base_Class).base_Generalization.general)
• 3_stakeholder_derived_from_conform
The derived values of the stakeholder attribute shall be the classifiers stereotyped by Stakeholder that
are the values of the stakeholder attribute of the general classifier of the generalization relationship
stereotyped by Conform for which the View is the specific classifier.
self.stakeholder = Viewpoint.allInstances()->any(base_Class =
Conform.allInstances()->any(base_Generalization.specific =
self.base_Class).base_Generalization.general).stakeholder
7.3.2.8 Viewpoint
Description
A Viewpoint is a specification of the conventions and rules for constructing and using a view for the purpose of
addressing a set of stakeholder concerns. The languages and methods for specifying a view may reference
languages and methods in another viewpoint. They specify the elements expected to be represented in the view,
and may be formally or informally defined. For example, the security viewpoint may require the security
requirements, security functional and physical architecture, and security test cases.
Attributes
• /concern : String [0..*]
The interest of the stakeholders displayed as the body of the comments from concernList.
(derived)
• concernList : Comment [0..*]
The interests of the stakeholders addressed by this viewpoint.
• language : String [0..*]
The languages used to express the models that represent content which is represented by the view. The
language specification such as its metamodel, profile, or other language specification is referred to by
its URI.
• /method : Behavior [0..*]
The behavior is derived from the method of the operation with the Create stereotype.
(derived)
• presentation : String [0..*]
The specifications prescribed for formatting and styling the view.
• purpose : String [1]
The purpose addresses the stakeholder concerns.
• stakeholder : Stakeholder [0..*]
Set of stakeholders whose concerns are to be addressed by the viewpoint.
Association Ends
• base_Class : Class [1]
Constraints
• 1_method_derived_from_create_operations
The derived values of the method attribute shall be the names of the methods of the operations
stereotyped by the UML Create stereotype on the classifier stereotyped by Viewpoint.
self.method = self.base_Class.allFeatures()->select(f |
f.oclIsKindOf(UML::Operation))->select(o |
Standard::Create.allInstances().base_BehavioralFeature-
>includes(o)).oclAsType(UML::Operation).method
• 2_create_view_operation
The property ownedOperation shall include at least one operation named "View" with the UML Create
stereotype applied.
self.base_Class.ownedOperation->exists(o | o.name='View' and
Standard::Create.allInstances().base_BehavioralFeature->includes(o))
BlockDefinition SysML::Blocks::Block
Diagram
UML4SysML::Package
Block SysML::Blocks::Block
Actor UML4SysML::Actor
«actor»
ActorNam e
ActorNam e
Element Name Concrete Syntax Example Abstract Syntax Reference
ValueType SysML::Blocks::ValueType
«valueType»
ValueType1
operations
operation1(p1: Type1): Type2
operation2(q1: Type1): Type3 {redefines operation2}
op3(q1: Type1): Type2 {redefines ValueType0::op3}
properties
property1: Type3
property2: Type4 {subsets property0}
prop3: Type5 {redefines ValueType0::property00}
/prop6: Type6 {union}
^prop7: Type7
«valueType»
unit = UnitName
PropertySpecificType SysML::Blocks::
PropertySpecificType
{abs tract}
Name
Name
{abs tract}
StereotypeProperty UML4SysML::Stereotype
«stereotype1»
Compartment Block1
«stereotype1»
property1 = value
Behavior SysML::Blocks::Block
Block1
Compartment
classifier behavior
«stateMachine» MySM1 ()
owned behaviors
MySM2 (p1 : P2)
«activity» myActivity_1 (in x : Integer)
Namespace SysML::Blocks::Blocks
Compartment
Structure SysML::Blocks::Blocks
Compartment
BoundReference SysML::Blocks::Blocks,
SysML::Blocks::BoundReference,
SysML::Blocks::EndPathMultiplicity
Unit UML4SysML::InstanceSpecification
Element Name Concrete Syntax Example Abstract Syntax Reference
QuantityKind UML4SysML::InstanceSpecification
InstanceSpecification UML4SysML::InstanceSpecification
InstanceSpecification UML4SysML::InstanceSpecification
InstanceSpecification UML4SysML::InstanceSpecification
InstanceSpecification UML4SysML::InstanceSpecification
Namespace SysML::Blocks::Blocks
Compartment
Structure SysML::Blocks::Blocks
Compartment
BoundReference SysML::Blocks::Blocks,
SysML::Blocks::BoundReference,
SysML::Blocks::EndPathMultiplicity
Unit UML4SysML::InstanceSpecification
QuantityKind UML4SysML::InstanceSpecification
Element Name Concrete Syntax Example Abstract Syntax Reference
InstanceSpecification UML4SysML::InstanceSpecification
InstanceSpecification UML4SysML::InstanceSpecification
InstanceSpecification UML4SysML::InstanceSpecification
InstanceSpecification UML4SysML::InstanceSpecification
Dependency UML4SysML::Dependency
1 {ordered, 0..*
subsets Block0::property0}
property2 association1 property1
Generalization UML4SysML::Generalization
Multibranch UML4SysML:Generalization
Generalization
GeneralizationSet UML4SysML::
GeneralizationSet
{disjoint}
{overlapping}
BlockNamespace UML4SysML::Class::nestedClassifier
Containment
InternalBlockDiagram SysML::Blocks::Block
Property UML4SysML::Property
PropertySpecificType SysML::Blocks::
PropertySpecificType
BoundReference SysML::Blocks::BoundReference
InternalBlockDiagram UML4SysML::Dependency
BindingConnector UML4SysML::Connector
BidirectionalConnector UML4SysML::Connector
UnidirectionalConnector UML4SysML::Connector
A block definition diagram is based on the UML class diagram, with restrictions and extensions as defined by
SysML.
SysML defines a special form of compartment, with the label “constraints,” which may contain one or more
constraints owned by the block. A constraint owned by the block may be shown in this compartment using the
standard text-based notation for a constraint, consisting of a string enclosed in brace characters. The use of a
compartment to show constraints is optional. The note-based notation, with a constraint shown in a note box
outside the block and linked to it by a dashed line, may also be used to show a constraint owned by a block.
A constraints compartment may also contain declarations of constraint properties owned by the block. A
constraint property is a property of the block that is typed by a ConstraintBlock, as defined in Clause 10. Only
the declaration of the constraint property may be shown within the compartment, not the details of its
parameters or binding connectors that link them to other properties.
A compartment with the label “namespace” may appear as part of a block definition to show blocks that are
defined in the namespace of a containing block. This compartment may contain any of the graphical elements of
a block definition diagram. All blocks or other named elements defined in this compartment belong to the
namespace of the containing block.
Because this compartment contains graphical elements, a wider compartment than typically used for feature
definitions may be useful. Since the same block can appear more than once in the same diagram, it may be
useful to show this compartment as part of a separate definition box than a box that shows only feature
compartments. Both namespace and structure compartments, which may both need a wide compartment to hold
graphical elements, could also be shown within a common definition box.
A compartment with the label “structure” may appear as part of a block definition to show connectors and other
internal structure elements for the block being defined. This compartment may contain any of the graphical
elements of an internal block diagram.
Because this compartment contains graphical elements, a wider compartment than typically used for feature
definitions may be useful. Since the same block can appear more than once in the same diagram, it may be
useful to show this compartment as part of a separate definition box than a box that shows only feature
compartments. Both namespace and structure compartments, which may both need a wide compartment to hold
graphical elements, could also be shown within a common definition box.
8.3.1.1.8 BoundReference compartment
A compartment with the label “bound references” may appear as part of a block definition to show properties
with the BoundReference stereotype applied. The properties omit the “«boundReference»” prefix.
SysML defines defaults for multiplicities on the ends of specific types of associations. A part or shared
association has a default multiplicity of [0..1] on the black or white diamond end. A unidirectional association
has a default multiplicity of 1 on its target end. These multiplicities may be assumed if not shown on a diagram.
To avoid confusion, any multiplicity other than the default should always be shown on a diagram.
The notation for properties typed by a property-specific type shows the name of the most specific generalization
of the property-specific type that is not a property-specific type (or nothing if there is no generalization)
between parentheses after the name of the property-specific type (or after the colon if the property-specific type
has no name).
The keyword for PropertySpecificType is «pst».
Any ValueSpecification can optionally display the unit's symbol if it has a type which is a ValueType.
If ValueSpecification has no type and it is used as a value of a slot, then it takes the unit from defining feature
type.
If ValueSpecification has no type and it is used as a default value of a value property, it takes the unit from that
property type.
If no unit symbol is defined, then the unit name may be displayed.
<value> [" " <unitSymbol | unitName>]
e.g., distance:Length = 10 m
An internal block diagram is based on the UML composite structure diagram, with restrictions and extensions as
defined by SysML.
Four general categories of properties of blocks are recognized in SysML: parts, references, value properties, and
constraint properties. (See 8.3.2.4 for definitions of these property types.) A part or value property is always
shown on an internal block diagram with a solid-outline box. A reference property is shown by a dashed-outline
box, consistent with UML. Ports are special cases of properties, and have a variety of notations as defined in
Clause 9, “Ports and Flows.” Constraint properties and their parameters also have their own notations as defined
in Clause 10, “Constraint Blocks.”
The diagram heading name for an internal block diagram (the string contained in the tab in the upper-left-hand
corner of the diagram frame) shall identify the name of a SysML block as its modelElementName. (See Annex
A for the definition of a diagram heading name including the modelElementName component.) All the
properties and connectors that appear inside the internal block diagram belong to the block that is named in the
diagram heading name.
SysML permits any property shown on an internal block diagram to also show compartments within the
property box. These compartments may be given standard or user-customized labels just as on block definitions.
All features shown within these compartments shall match those of the block or value type that types the
property. An unlabeled compartment on an internal property box is by default a structure compartment. A
behavior compartment label and content shall match the corresponding behavior compartment of the block that
types the part. A compartment with the label “classifier behavior” or “owned behaviors” may contain the
classifier behavior or owned behaviors of the block that types the part which will then appear as specified in
8.3.1.1.4, Behavior compartment.
The label of any compartment shown on the property box that displays contents belonging to the type of the
property is shown with a colon character (“:”) preceding the compartment label. The compartment name is
otherwise the same as it would appear on the type on a block definition diagram.
SysML permits compartments to be shown across the entire width of the diagram frame on an internal block
diagram. These compartments shall always follow an initial compartment that always shows the internal
structure of a referenced block. These compartments may have all the same contents as could be shown on a
block definition diagram for the block defined at the top level of the diagram frame.
A property name shown inside or outside the property box may take the form of a multi-level name. This form
of name references a nested property accessible through a sequence of intermediate properties from a
referencing context. The name of the referenced property is built by a string of names separated by “.”, resulting
in a form of path name that identifies the property in its local context. A colon and the type name for the
property may optionally be shown following the dotted name string. If any of the properties named in the path
name string identifies a reference property, the property box is shown with a dashed-outline box, just as for any
reference property on an internal block diagram.
This notation is purely a notational shorthand for a property that could otherwise be shown within a structure of
nested property boxes, with the names in the dotted string taken from the name that would appear at each level
of nesting. In other words, the internal property shown with a path name in the left-hand side of Figure 8.1 is
equivalent to the innermost nested box shown at the right.
If the property has no name, the property’s type name can be used instead.
e.g., car:Engine:Cylinder:Piston.length
car.e.c.p.length
Connectors may be drawn that cross the boundaries of nested properties to connect to properties within them.
The connector is owned by the most immediate block that owns both ends of the connector. A
NestedConnectorEnd stereotype of a UML ConnectorEnd is automatically applied to any connector end that is
nested more than one level deep within a containing context.
Use of nested connector ends does not follow strict principles of encapsulation of the parts or other properties
that a connector line may cross. The need for nested connector ends can be avoided if additional properties can
be added to the block at each containing level. Nested connector ends are available for cases where the
introduction of these intermediate properties is not feasible or appropriate.
The ability to connect to nested properties within a containing block requires that multiple levels of
decomposition be shown on the same diagram.
The notation for properties typed by a property-specific type shows the name of the most specific generalization
of the property-specific type that is not a property-specific type (or nothing if there is no generalization)
between parentheses after the name of the property-specific type (or after the colon if the property-specific type
has no name).
A compartment with a label of “initialValues” may be used to show values of properties belonging to a
containing block. These values override any default values that may have been previously specified on these
properties on their originally defining block. Initial value compartments may be specified within nested
properties, which then apply only in the particular usage context defined by the outermost containing block.
Values are specified in an initialValues compartment by lines in the form <property-name> = <value-
specification> or <property-name> : <type> = <value-specification>, each line of which specifies the initial
SysML defines default multiplicities of 1 on each end of a connector. These multiplicities may be assumed if not
shown on a diagram. To avoid confusion, any multiplicity other than the default should always be shown on a
diagram.
8.3.1.3 UML Diagram Elements not Included in SysML Block Definition Diagrams
The supported variety of notations for associations and association annotations has been reduced to simplify the
burden of teaching, learning, and interpreting SysML diagrams for the systems engineering user. Notational and
metamodel support for n-ary associations and qualified associations has been excluded from SysML. The use
of navigation arrowheads on an association has been simplified by excluding the case of arrowheads on both
ends, and requiring that such an association always be shown without arrowheads on either end. An “X” on a
single end of an association to indicate that an end is not navigable has similarly been dropped, as has the use of
a small filled dot at the end of an association to indicate that the end is owned by the associated classifier.
UML allows representing owned attributes using an association-like notation (see UML 2.5 Figure 9-12). This
notation does not show any multiplicity on the opposite end since there is no corresponding property. In such a
case, the multiplicity on the opposite side of the association-like notation is the less constrained possible. That
is: "0..1" if the attribute has a composite aggregation and "0..*" otherwise. However, it is a common practice for
modelers to assume that, when not shown, the multiplicity of an association end is the default multiplicity (i.e.
"1..1"). This might create ambiguity because there is no practical way to distinguish between the association-
like notation and a "true" association. The association-like notation is excluded from SysML to avoid it.
The use of a «primitive» keyword on a value type definition (which in UML specifies the PrimitiveType
specialization of UML DataType) is not supported. Whether or not a value type definition has internal structure
can be determined from the value type itself.
8.3.1.4 UML Diagram Elements not Included in SysML Internal Block Diagrams
The UML Composite Structure diagram has many notations not included in the subset defined in this clause.
Other SysML clauses add some of these notations into the supported contents of an internal block diagram.
8.3.2 Stereotypes
«metaclass»
UML4SysML::Element
* 1..*
«stereotype» propertyPath «metaclass»
ElementPropertyPath {ordered, nonunique} UML4SysML::Property
«metaclass»
UML4SysML::
DirectedRelationship
*
*
«stereotype» * 0..1
DirectedRelationshipPropertyPath
sourceContext «metaclass»
* 0..1 UML4SysML::Classifier
targetContext
Figure 8.5: Abstract syntax extensions for SysML property paths
Figure 8.6: Abstract syntax extensions for SysML connector ends
«metaclass»
UML4SysML::Property
«stereotype»
EndPathMultiplicity
lower : Integer [0..1] = 0
upper : UnlimitedNatural [0..1] = unlimited
«stereotype»
BoundReference
boundEnd : ConnectorEnd
/bindingPath : Property [1..*] {ordered, nonunique}
Figure 8.8: Abstract syntax extensions for SysML bound references
8.3.2.2 AdjunctProperty
Description
The AdjunctProperty stereotype can be applied to properties to constrain their values to the values of connectors
typed by association blocks, call actions, object nodes, variables, parameters, interaction uses, and submachine
states. The values of connectors typed by association blocks are the instances of the association block typing a
connector in the block having the stereotyped property. The values of call actions are the executions of
behaviors invoked by the behavior having the call action and the stereotyped property (see 11.3.1.1 , Notation
for more about this use of the stereotype). The values of object nodes are the values of tokens in the object
nodes of the behavior having the stereotyped property (see 11.3.1.4.1 , Notation for more about this use of the
stereotype). The values of variables are those assigned by executions of activities that have the stereotyped
property. The values of parameters are those assigned by executions of behaviors that have the stereotyped
property. The keyword «adjunct» before a property name indicates the property is stereotyped by
AdjunctProperty.
Association Ends
• base_Property : Property [1]
• principal : Element [1]
Gives the element that determines the values of the property.
Constraints
• 10_multiplicity_same_or_less_restrictive
Properties with AdjunctProperty applied that have a Variable or Parameter as principal shall have a
lower multiplicity the same as or lower than the lower multiplicity of their principal, and an upper
multiplicity the same as or higher than the upper multiplicity of their principal
self.principal.oclIsKindOf(UML::MultiplicityElement) implies
self.base_Property.lower <=
self.principal.oclAsType(UML::MultiplicityElement).lower and
self.base_Property.upper >=
self.principal.oclAsType(UML::MultiplicityElement).upper
• 11_submachine_and_interactionuse_composite_and _compatible_type
Properties with AdjunctProperty applied that have an InteractionUse or submachine State as principal
shall be composite and be typed by the interaction or state machine invoked by the interaction use or
submachine State or one of their generalizations.
self.principal.oclIsKindOf(UML::InteractionUse) or
self.principal.oclIsKindOf(UML::State) implies let behavior: UML::Behavior =
if self.principal.oclIsKindOf(UML::InteractionUse) then
self.principal.oclAsType(UML::InteractionUse).refersTo else
self.principal.oclAsType(UML::State).submachine endif in if
behavior.oclIsUndefined() then self.base_Property.type->isEmpty() else
self.base_Property.type->notEmpty() and behavior->closure(generalization)-
>including(behavior)->includes(self.base_Property.type) endif
• 1_principal_kind
The principal of an applied AdjunctProperty shall be a Connector, CallAction, ObjectNode, Variable,
Parameter, submachine State, or InteractionUse.
self.principal.oclIsKindOf(UML::Connector) or
self.principal.oclIsKindOf(UML::CallAction) or
self.principal.oclIsKindOf(UML::ObjectNode) or
self.principal.oclIsKindOf(UML::Variable) or
self.principal.oclIsKindOf(UML::Parameter) or
self.principal.oclIsKindOf(UML::InteractionUse) or
(self.principal.oclIsKindOf(UML::State) and
self.principal.oclAsType(UML::State).isSubmachineState)
• 2_same_name
Properties to which AdjunctProperty applied shall have the same name as the principal, if the principal
is a NamedElement.
self.principal.oclIsKindOf(UML::NamedElement) implies self.base_Property.name
= self.principal.oclAsType(UML::NamedElement).name
• 3_connector_and_callaction_composite
Properties with AdjunctProperty applied that have a Connector or CallAction as principal shall be
composite.
self.principal.oclIsKindOf(UML::Connector) or
self.principal.oclIsKindOf(UML::CallAction) implies
self.base_Property.isComposite()
• 4_same_owner
Properties with AdjunctProperty applied shall be owned by an element that owns the principal, at least
indirectly, or one of that element's specializations.
let owners: Set(UML::Element) = self.principal->closure(owner) in let
specializations: Set(UML::Element) = UML::Classifier.allInstances()->select(c
| c->closure(general)->intersection(owners)->notEmpty()) in owners-
>union(specializations)->includes(self.base_Property.owner)
• 5_compatible_type
Properties with AdjunctProperty applied that have as principal a Connector, ObjectNode, Variable, or
Parameter shall have the same type as the principal or one of that type's generalizations.
self.principal.oclIsKindOf(UML::Connector) or
self.principal.oclIsKindOf(UML::Variable) or
self.principal.oclIsKindOf(UML::Parameter) implies let principal_type:
UML::Classifier = if self.principal.oclIsKindOf(UML::Connector) then
self.principal.oclAsType(UML::Connector).type else
self.principal.oclAsType(UML::TypedElement).type.oclAsType(UML::Classifier)
endif in principal_type->closure(general)->including(principal_type)-
>includes(self.base_Property.type)
• 6_connector_principal_associationblock
Connectors that are principals of an applied AdjunctProperty shall have association blocks as types
8.3.2.3 BindingConnector
Description
A Binding Connector is a connector which specifies that the properties at both ends of the connector have equal
values. If the properties at the ends of a binding connector are typed by a ValueType, the connector specifies
that the instances of the properties shall hold equal values, recursively through any nested properties within the
connected properties. If the properties at the ends of a binding connector are typed by a Block, the connector
specifies that the instances of the properties shall refer to the same block instance. As with any connector owned
by a SysML Block, the ends of a binding connector may be nested within a multi-level path of properties
accessible from the owning block. The NestedConnectorEnd stereotype is used to represent such nested ends
just as for nested ends of other SysML connectors.
Association Ends
• base_Connector : Connector [1]
Constraints
• 1_compatible_types
The two ends of a binding connector shall have either the same type or types that are compatible so
that equality of their values can be defined.
self.base_Connector.end->at(1).role.type.conformsTo(self.base_Connector.end-
>at(2).role.type) or self.base_Connector.end-
>at(2).role.type.conformsTo(self.base_Connector.end->at(1).role.type)
8.3.2.4 Block
Description
A Block is a modular unit that describes the structure of a system or element. It may include both structural and
behavioral features, such as properties and operations, that represent the state of the system and behavior that
the system may exhibit. Some of these properties may hold parts of a system, which can also be described by
blocks that type the properties. Properties without types do not restrict the instances that can be values of the
properties, as if they had the most general type possible. A block may include a structure of connectors between
its properties to indicate how its parts or other properties relate to one another.
SysML blocks provide a general-purpose capability to describe the architecture of a system. They provide the
ability to represent a system hierarchy, in which a system at one level is composed of systems at a more basic
level. They can describe not only the connectivity relationships between the systems at any level, but also
quantitative values or other information about a system.
SysML does not restrict the kind of system or system element that may be described by a block. Any reusable
form of description that may be applied to a system or a set of system characteristics may be described by a
block. Such reusable descriptions, for example, may be applied to purely conceptual aspects of a system design,
such as relationships that hold between parts or properties of a system.
Connectors owned by SysML blocks may be used to define relationships between parts or other properties of
the same containing block. Connectors can be typed by associations, which can specify more detail about the
links between parts or other properties of a system, along with the types of the connected properties.
Associations can also be blocks, and when used to type connectors give relationships their own interconnected
parts and other properties. Connectors without types do not restrict the way the connected properties are linked
together, as if they had the most general type possible. Connectors have both structural and behavioral
functions, which can be used together or separately. Connectors as structure specify links between parts or other
properties of a system. Connectors as behavior specify communication and item flow between parts or other
properties. Connected properties can be linked without specifying communication and item flow, or can specify
communication and item flow without specifying a particular kind of link, or both.
SysML excludes variations of associations in UML in which navigable ends can be owned directly by the
association. In SysML, navigation is equivalent to a named property owned directly by a block. The only form
of an association end that SysML allows an association to own directly is an unnamed end used to carry an
inverse multiplicity of a reference property. This unnamed end provides a metamodel element to record an
inverse multiplicity, to cover the specific case of a unidirectional reference that defines no named property for
navigation in the inverse direction. SysML enforces its equivalence of navigation and ownership by means of
constraints that the block stereotype enforces on the existing UML metamodel.
SysML establishes four basic classifications of properties belonging to a SysML Block or ValueType. A property
typed by a SysML Block that has composite aggregation is classified as a part property, except for the special
case of a constraint property. Constraint properties are further defined in clause 10 . A port is another category
of property, as further defined in Section 9 . A property typed by a Block that does not have composite
On a block definition diagram, a part property is shown by a black diamond symbol on an association. As in
UML, an instance of a block may be included in at most one instance of a block at a time, though possibly as a
value of more than one part property of the containing block. A part property holds instances that belong to a
larger whole. Typically, a part- whole relationship means that certain operations that apply to the whole also
apply to each of the parts. For example, if a whole represents a physical object, a change in position of the
whole could also change the position of each of the parts. A property of the whole such as its mass could also be
implied by its parts. Operations and relationships that apply to parts typically apply transitively across all parts
of these parts, through any number of levels. A particular application domain may establish its own
interpretation of part-whole relationships across the blocks defined in a particular model, including the
definition of operations that apply to the parts along with the whole. For software objects, a typical
interpretation is that delete, copy, and move operations apply across all parts of a composite object.
SysML also supports properties with shared aggregation, as shown by a white diamond symbol on an
association. Like UML, SysML defines no specific semantics or constraints for properties with shared
aggregation, but particular models or tools may interpret them in specific ways.
In addition to the form of default value specifications that SysML supports on properties of a block (with an
optional "=" <value-specification> string following the rest of a property definition), SysML supports an
additional form of value specification for properties using initialValue compartments on an internal block
diagram (see Internal Block Diagram on page 46). An entire tree of context-specific values can be specified on a
containing block to carry values of nested properties as shown on an internal block diagram.
Context-specific values are represented in the SysML metamodel by means of the InstanceValue subtype of
UML ValueSpecification. Selected slots of UML instance specifications referenced by these instance values
carry the individual values shown in initialValue compartments.
If a property belonging to a block has a specification of initial values for any of the properties belonging to its
type, then the default value of that property shall be a UML InstanceValue element. This element shall reference
a UML InstanceSpecification element created to hold the initial values of the individual properties within its
usage context.
Selected slots of the referenced instance specification shall contain value specifications for the individual
property values specified in a corresponding initialValues compartment. If a value of a property is shown by a
nested property box with its own initialValues compartment, then the slot of the instance specification for the
containing property shall hold a new InstanceValue element. Selected slots of the instance specification
referenced by this value shall contain value specifications for any nested initial values, recursively through any
number of levels of nesting. A tree of instance values referencing instance specifications, each of which may in
turn hold slots carrying instance values, shall exist until self- contained value specifications are reached at the
leaf level.
Attributes
• isEncapsulated : Boolean [0..1]
If true, then the block is treated as a black box; a part typed by this black box can only be connected
via its ports or directly to its outer boundary. If false, or if a value is not present, then connections can
be established to elements of its internal structure via deep-nested connector ends.
Association Ends
• base_Class : Class [1]
Constraints
• 1_associations_binary
For an association in which both ends are typed by blocks, the number of ends shall be exactly two
UML::Association.allInstances()->select(a| a.memberEnd->forAll(e| e.type-
>notEmpty() and Block.allInstances().base_Class->includes(e.type)))->forAll(a
| a.memberEnd->size()=2)
• 2_connectors_binary
The number of ends of a connector owned by a block shall be exactly two. (In SysML, a binding
connector is not typed by an association, so this constraint is not implied entirely by the preceding
constraint.)
self.base_Class.ownedConnector->forAll(c | c.end->size()=2 )
• 5_uml_connector_constraint_removed
The following constraint under 11.8, "Connector" in the UML 2 standard is removed by SysML: "The
ConnectableElements attached as roles to each ConnectorEnd owned by a Connector must be roles of
the Classifier that owned the Connector, or they must be ports of such roles
-- Cannot be expressed in OCL
• 6_valueproperties_composite
If a property owned by a SysML Block or SysML ValueType is typed by a SysML ValueType, then the
aggregation attribute of the property shall be "composite."
self.base_Class.ownedAttribute->select(a|
ValueType.allInstances().base_DataType->includes(a.type))->forAll(a|
a.isComposite())
• 7_composition_acyclic
Within an instance of a SysML Block, the values of any property with composite aggregation
(aggregation = composite) shall not contain the block in any of its own properties that also have
composite aggregation, or within any unbroken chain of properties that all have composite
aggregation. (Within an instance of a SysML Block, the instances of properties with composite
aggregation shall form an acyclic graph.)
self.base_Class->closure(part->select(p|
p.type.oclIsKindOf(UML::Class)).type.oclAsType(UML::Class))-
>excludes(self.base_Class)
• 8_specializations_are_blocks
Any classifier that specializes a Block shall also have the Block stereotype or one of its specializations
applied.
UML::Classifier.allInstances()->select(c | c.general-
>includes(self.base_Class))->forAll(c | Block.allInstances()->includes(c))
• 9_uml constraint_removed
The following constraint under 11.8,"ConnectorEnd" in the UML 2 standard is removed by SysML:
"[3] The property held in self.partWithPort must not be a Port."
8.3.2.5 BoundReference
Generalizations
EndPathMultiplicity (from Blocks)
Attributes
• /bindingPath : Property [1..*]
Gives the propertyPath of the NestedConnectorEnd applied, if any, to the boundEnd, appended to the
role of the boundEnd.
(derived)
• boundEnd : ConnectorEnd [1]
Gives a connector end of a binding connector opposite to the end linked to the stereotyped property, or
linked to a property that generalizes the stereotyped one through redefinition.
Constraints
• 1_bindingconnector_end
Properties to which BoundReference is applied shall be the role of a connector end of at least one
binding connector, or generalized by such a property through redefinition
BindingConnector.allInstances().base_Connector.end.role->exists(r |
r=self.base_Property or self.base_Property->closure(redefinedElement)-
>includes(r))
• 2_opposite_bindingconnector_end
The value of boundEnd shall be a connector end of a binding connector, as identified in constraint 1,
opposite the property, as identified in constraint 1.
let opposite: UML::ConnectorEnd =
BindingConnector.allInstances().base_Connector.end->any(e |
e.role=self.base_Property or self.base_Property->closure(redefinedElement)-
>includes(e.role)) in self.boundEnd =
opposite.owner.oclAsType(UML::Connector).end->any(e | e<>opposite)
• 3_navigable
The role of boundEnd shall be a property accessible by navigation from instances of the block owning
the property to which BoundReference is applied, but shall not be the property to which
BoundReference is applied, or one that it is related to by redefinition.
self.base_Property.association->notEmpty() and self.boundEnd.definingEnd-
>notEmpty() and self.base_Property.association.navigableOwnedEnd-
>includes(self.boundEnd.definingEnd)
• 4_propertypath_consistency
The last value of bindingPath shall be the role of boundEnd, and the other values shall be the
propertyPath of the NestedConnectorEnd applied to boundEnd, if any.
self.boundEnd = self.bindingPath->last() and (let nce: NestedConnectorEnd =
NestedConnectorEnd.allInstances()->any(n| n.base_ConnectorEnd=self.boundEnd)
in nce->oclIsUndefined() or self.bindingPath->subSequence(1, self.bindingPath-
>size()-1) = nce.propertyPath)
• 5_reference_or_valueproperty
Properties to which BoundReference is applied shall either be reference properties or value properties.
ValueType.allInstances().base_DataType->includes(self.base_Property.type) or
not self.base_Property.isComposite()
• 6_ordered_nonunique
Properties with BoundReference applied that have an upper multiplicity greater than one shall be
ordered and non-unique.
self.base_Property.upper > 1 implies self.base_Property.isOrdered and not
self.base_Property.isUnique
• 7_cannot_redefine_boundreference
BoundReferences shall not be applied to properties that are related by redefinition to other properties
with BoundReference applied.
self.base_Property.redefinedElement->notEmpty() implies
BoundReference.allInstances().base_Property-
>excludesAll(self.base_Property.redefinedElement)
• 8_notbounded_to_itslef
The binding connector identified in constraint 1 shall not have the same property on both ends, or
properties related by redefinition.
let e1: UML::ConnectorEnd = self.boundEnd.owner.oclAsType(UML::Connector).end-
>at(1) in let e2: UML::ConnectorEnd =
self.boundEnd.owner.oclAsType(UML::Connector).end->at(2) in e1.role <> e2.role
and (e1.role.oclIsKindOf(UML::Property) and e2.role.oclIsKindOf(UML::Property)
implies e1.role.oclAsType(UML::Property).redefinedElement->excludes(e2.role)
and e2.role.oclAsType(UML::Property).redefinedElement->excludes(e1.role))
8.3.2.6 ClassifierBehaviorProperty
Description
The ClassifierBehaviorProperty stereotype can be applied to properties to constrain their values to be the
executions of classifier behaviors. The value of properties with ClassifierBehaviorProperty applied are the
executions of classifier behaviors invoked by instantiation of the block that owns the stereotyped property or
one of its specializations.
Association Ends
• base_Property : Property [1]
Constraints
• 1_owner_classifierbehavior
ClassifierBehaviorProperty shall only be applied to properties owned (not inherited) by blocks that
have classifier behaviors.
Block.allInstances().base_Class->exists(c | c.ownedAttribute-
>includes(self.base_Property) and c.classifierBehavior->notEmpty())
• 2_composite
Properties to which ClassifierBehaviorProperty is applied shall be composite
self.base_Property.isComposite
• 3_typed_by_classifierbehavior
Properties to which ClassifierBehaviorProperty applied shall be typed by the classifier behavior of
their owning block or a generalization of the classifier behavior.
let clBehavior: UML::Behavior =
self.base_Property.owner.oclAsType(UML::Class).classifierBehavior in
self.base_Property.type->notEmpty() and clBehavior->closure(general)-
>including(clBehavior)->includes(self.base_Property.type)
Description
Connectors can be typed by association classes that are stereotyped by Block (association blocks, see
ParticipantProperty on page 60). These connectors specify instances of the association block created within the
instances of the block that owns the connector. The values of a connector property are instances of the
association block created due to the connector referred to by the connector property.
A connector property can optionally be shown in an internal block diagram with a dotted line from the
connector line to a rectangle notating the connector property. The keyword «connector» before a property name
indicates the property is stereotyped by ConnectorProperty.
Attributes
• connector : Connector [1]
A connector of the block owning the property on which the stereotype is applied.
Association Ends
• base_Property : Property [1]
Constraints
• 1_block_property
ConnectorProperty shall only be applied to properties of classes stereotyped by Block.
Block.allInstances().base_Class->exists(c | c.ownedAttribute-
>includes(self.base_Property))
• 2_owned_or_inherited
The connector attribute of the applied stereotype shall refer to a connector owned or inherited by a
block owning the property on which the stereotype is applied.
let owner: UML::Class = Block.allInstances().base_Class->any(c |
c.ownedAttribute->includes(self.base_Property)) in owner->closure(general)-
>select(oclIsKindOf(UML::Class)).oclAsType(UML::Class).ownedConnector-
>flatten()->includes(self.connector)
• 3_composite
The aggregation of a property stereotyped by ConnectorProperty shall be composite.
self.base_Property.isComposite
• 4_typed_by_associationblock
The type of the connector referred to by a connector attribute shall be an association class stereotyped
by Block.
Block.allInstances().base_Class->exists(c |
c.oclIsKindOf(UML::AssociationClass) and self.connector.type = c)
• 5_same_name
A property stereotyped by ConnectorProperty shall have the same name and type as the connector
referred to by the connector attribute.
self.base_Property.name = self.connector.name
8.3.2.8 DirectedRelationshipPropertyPath
Description
The DirectedRelationshipPropertyPath stereotype based on UML DirectedRelationship enables directed
relationships to identify their sources and targets by a multi-level path of properties accessible from context
blocks for the sources and targets. Context blocks are typically the owner of the first property in the path of
properties, but can be specializations of the owner to limit the scope of the relationship.
Association Ends
• base_DirectedRelationship : DirectedRelationship [1]
• sourceContext : Classifier [0..1]
Gives the context for sourcePropertyPath to begin from.
• sourcePropertyPath : Property [0..*]
A series of properties that identifies the source of the directed relationship in the context of the block
specified by the sourceContext property. The ordering of properties is from a property of the
sourceContext block, through a property of each intermediate block that types the preceding property,
ending in a property with a type that owns or inherits the source of the directed relationship. The
source is not included in the propertyPath list. The same property might appear more than once
because a block can own a property with the same or specialized block as a type.
• targetContext : Classifier [0..1]
Gives the context for targetPropertyPath to begin from.
• targetPropertyPath : Property [0..*]
A series of properties that identifies the target of the directed relationship in the context of the block
specified by the targetContext property. The ordering of properties is from a property of the
targetContext block, through a property of each intermediate block that types the preceding property,
ending in a property with a type that owns or inherits the target of the directed relationship. The target
is not included in the propertyPath list. The same property might appear more than once because a
block can own a property with the same or specialized block as a type.
Constraints
• 1_sourcecontext_iif_property
sourceContext shall have a value when source is a property, otherwise it shall not have a value
self.base_DirectedRelationship.source->exists(s |
s.oclIsKindOf(UML::Property)) xor self.sourceContext->isEmpty()
• 2_targetcontext_iif_property
targetContext shall have a value when target is a property, otherwise it shall not have a value.
self.base_DirectedRelationship.source->exists(s |
s.oclIsKindOf(UML::Property)) xor self.sourceContext->isEmpty()
• 3_sourcepropertypath_implies_property
source shall be a property when sourcePropertyPath has a value.
self.sourcePropertyPath->notEmpty() implies
self.base_DirectedRelationship.source->forAll(s |
s.oclIsKindOf(UML::Property))
• 4_targetpropertypath_implies_property
target shall be a property when targetPropertyPath has a value.
self.targetPropertyPath->notEmpty() implies
self.base_DirectedRelationship.target->forAll(s |
s.oclIsKindOf(UML::Property))
• 5_sourcecontext_owns_sourcepath_first
The property in the first position of the sourcePropertyPath list, if any, shall be owned by the
sourceContext or one of its generalizations
self.sourcePropertyPath->notEmpty() implies
self.sourceContext.allAttributes()->includes(self.sourcePropertyPath->first())
8.3.2.9 DistributedProperty
Description
DistributedProperty is a stereotype of Property used to apply a probability distribution to the values of the
property. Specific distributions should be defined as subclasses of the DistributedProperty stereotype with the
operands of the distributions represented by properties of those stereotype subclasses. A sample set of
probability distributions that could be applied to value properties is given in clause 22.7 .
Association Ends
• base_Property : Property [1]
Constraints
• 1_block_or_valuetype
The DistributedProperty stereotype shall only be applied to properties of classifiers stereotyped by
Block or ValueType.
Block.allInstances().base_Class.oclAsType(UML::Classifier)-
>union(ValueType.allInstances().base_DataType)-
>includes(self.base_Property.owner)
8.3.2.10 ElementPropertyPath
Description
The ElementPropertyPath stereotype based on UML Element enables elements to identify other elements by a
multi-level path of properties accessible from a context block. The context block is described in specializations
of ElementPropertyPath.
Association Ends
• base_Element : Element [1]
• propertyPath : Property [1..*]
A series of properties that identifies elements in the context of a block described in specializations of
ElementPropertyPath. The ordering of properties is from a property of the context block, through a
property of each intermediate block that types the preceding property, ending in a property with a type
that owns or inherits the fully nested property. The fully nested property is not included in the
propertyPath list, but is given by the element to which the ElementPropertyPath is applied in a way
described in specializations of ElementPropertyPath. The same property might appear more than once
because a block can own a property with the same or specialized block as a type.
Constraints
• 1_path_consistency
The property at each successive position of the propertyPath attribute, following the first position, shall
be owned by the Block or ValueType that types the property at the immediately preceding position, or
a generalization of the Block or ValueType.
self.propertyPath->size() >1 implies self.propertyPath->subSequence(2,
self.propertyPath->size())->forAll(p | let pp: UML::Property =
self.propertyPath->at(self.propertyPath->indexOf(p)-1) in let owners:
Set(UML::Classifier) = pp.type.oclAsType(UML::Classifier)-
>including(pp.type.oclAsType(UML::Classifier)) in owners->includes(p.owner))
8.3.2.11 EndPathMultiplicity
Description
The EndPathMultiplicity stereotype can be applied to properties that are related by redefinition to properties
that have BoundReference applied. The lower and upper properties of the stereotype give the minimum and
maximum number of values, respectively, of the property at the bound end of the related bound reference, for
each object reached by navigation along its binding path.
Attributes
• lower : Integer [0..1]
Gives the minimum number of values of the property at the end of the related bindingPath, for each
object reached by navigation along the bindingPath from an instance of the block owning the property
to which EndPathMultiplicity is applied
• upper : UnlimitedNatural [0..1]
Gives the maximum number of values of the property at the end of the related bindingPath, for each
object reached by navigation along the bindingPath from an instance of the block owning the property
to which EndPathMultiplicity is applied.
Association Ends
• base_Property : Property [1]
8.3.2.12 NestedConnectorEnd
Description
The NestedConnectorEnd stereotype of UML ConnectorEnd extends a UML ConnectorEnd so that the
connected property may be identified by a multi-level path of accessible properties from the block that owns the
connector. The propertyPath inherited from ElementPropertyPath gives a series of properties that identifies the
connected property in the context of the block that owns the connector. The ordering of properties is from a
property of the block that owns the connector, through a property of each intermediate block that types the
preceding property, ending in a property with a type that owns or inherits the property that is the role of the
connector end (the property that the connector graphically attaches to at that end). The property that is the role
of the connector end is not included in the propertyPath list.
Generalizations
ElementPropertyPath (from Blocks)
Association Ends
• base_ConnectorEnd : ConnectorEnd [1]
(redefines: ElementPropertyPath::base_Element)
Constraints
• 1_propertypath_first_owned_by_connector_owner
The first property in propertyPath shall be owned by the block that owns the connector, or one of the
block's generalizations.
let owningBlock: UML::Class =
self.base_ConnectorEnd.owner.oclAsType(UML::Connector).owner.oclAsType(UML::Cl
ass) in (not owningBlock.oclIsUndefined()) and owningBlock->closure(general)-
>including(owningBlock)->includes(self.propertyPath->first().owner)
• 2_propertypath_last_type_owns_role
The type of the property at the last position of the propertyPath list shall own or inherit the role
property of the stereotyped connector end
let type: UML::Classifier = self.propertyPath-
>last().type.oclAsType(UML::Classifier) in (not type.oclIsUndefined()) and
type.allFeatures()->includes(self.base_ConnectorEnd.role)
8.3.2.13 ParticipantProperty
Description
The Block stereotype extends Class, so it can be applied to any specialization of Class, including Association
Classes. These are informally called "association blocks." An association block can own properties and
connectors, like any other block. Each instance of an association block can link together instances of the end
classifiers of the association.
To refer to linked objects and values of an instance of an association block, it is necessary for the modeler to
specify which (participant) properties of the association block identify the instances being linked at which end
of the association. The value of a participant property on an instance (link) of the association block is the value
or object at the end of the link corresponding to this end of the association.
Participant properties can be the ends of connectors owned by an association block. The association block can
be the type of multiple other connectors to reuse the same internal structure for all the connectors. The keyword
«participant» before a property name indicates the property is stereotyped by ParticipantProperty. They are
always the same as the corresponding association end type.
Participant properties can be the ends of connectors owned by an association block. The association block can
be the type of multiple other connectors to reuse the same internal structure for all the connectors. The keyword
«participant» before a property name indicates the property is stereotyped by ParticipantProperty. They are
always the same as the corresponding association end type
Attributes
• end : Property [1]
A member end of the association block owning the property on which the stereotype is applied.
Association Ends
• base_Property : Property [1]
Constraints
• 1_associationblock
ParticipantProperty shall only be applied to properties of association classes stereotyped by Block.
self.base_Property.class.oclIsKindOf(UML::AssociationClass) and
Block.allInstances().base_Class->includes(self.base_Property.class)
• 2_memberend
ParticipantProperty shall not be applied to properties that are member ends of an association.
UML::Association.allInstances().memberEnd->flatten()-
>excludes(self.base_Property)
• 3_aggregationkind_none
The aggregation of a property stereotyped by ParticipantProperty shall be none.
self.base_Property.aggregation = UML::AggregationKind::none
• 4_end_owner
The end attribute of the applied stereotype shall refer to a member end of the association block owning
the property on which the stereotype is applied.
self.base_Property.association.memberEnd->includes(self.end)
• 5_same_type
A property stereotyped by ParticipantProperty shall have the same type as the property referred to by
the end attribute.
self.base_Property.type = self.end.type
• 6_multiplicity_1
A property to which the ParticipantProperty is applied shall have a multiplicity of 1.
self.base_Property.lower = 1 and self.base_Property.upper = 1
Description
The PropertySpecificType stereotype can be applied to classifiers that type exactly one property and that are
owned by the owner of that property. Classifiers with this stereotype applied shall be generalized by at most one
other classifier.
Instances of a property-specific type are exactly those that are values of the property it types, in all instances of
the property owner. Values are (de)classified under property-specific types as they are (removed from) added to
the property they type:
• Support more features than they would when they are not values of the property.
• Have redefined or constrained features only while they are values of the property.
Association Ends
• base_Classifier : Classifier [1]
Constraints
• 1_only_one_property
A classifier to which the PropertySpecificType stereotype is applied shall be referenced as the type of
one and only one property.
UML::Property.allInstances()->select(p | p.type = self.base_Classifier)-
>size() = 1
8.3.2.15 ValueType
Description
A ValueType defines types of values that may be used to express information about a system, but cannot be
identified as the target of any reference. Since a value cannot be identified except by means of the value itself,
each such value within a model is independent of any other, unless other forms of constraints are imposed.
Value types may be used to type properties, operation parameters, or potentially other elements within SysML.
SysML defines ValueType as a stereotype of UML DataType to establish a more neutral term for system values
that may never be given a concrete data representation. For example, the SysML "Real" ValueType expresses
the mathematical concept of a real number, but does not impose any restrictions on the precision or scale of a
fixed or floating-point representation that expresses this concept. More specific value types can define the
concrete data representations that a digital computer can process, such as conventional Float, Integer, or String
types.
SysML ValueType adds an ability to carry a unit of measure and quantity kind associated with the value. A
quantity kind is a kind of quantity that may be stated in terms of defined units, but does not restrict the selection
of a unit to state the value. A unit is a particular value in terms of which a quantity of the same quantity kind
may be expressed. A SysML ValueType and its quantityKind establishes, via UML typing, the associative
relationship between a particular "quantity" [VIM3-1.1] (modeled as a SysML value property typed by a
ValueType) and a "kind of quantity" [VIM3-1.2] (the ValueType::quantityKind of the SysML value property's
type). This UML/SysML associative relationship reflects the terminological distinction made in VIM3 between
the concepts of "quantity" [VIM3-1.1] and "kind-of-quantity" [VIM3- 1.2] that "cannot be in a generic or
partitive hierarchical relation to each other" [Dybkaer-2010].
A SysML ValueType may define its own properties and/or operations, just as for a UML DataType. See 8.3.2.4,
Block for property classifications that SysML defines for either a Block or ValueType.
Association Ends
• base_DataType : DataType [1]
• quantityKind : InstanceSpecification [0..1]
A ValueType defines types of values that may be used to express information about a system, but
cannot be identified as the target of any reference. Since a value cannot be identified except by means
of the value itself, each such value within a model is independent of any other, unless other forms of
constraints are imposed.
Value types may be used to type properties, operation parameters, or potentially other elements within
SysML. SysML defines ValueType as a stereotype of UML DataType to establish a more neutral term
for system values that may never be given a concrete data representation. For example, the SysML
"Real" ValueType expresses the mathematical concept of a real number, but does not impose any
restrictions on the precision or scale of a fixed or floating-point representation that expresses this
concept. More specific value types can define the concrete data representations that a digital computer
can process, such as conventional Float, Integer, or String types.
SysML ValueType adds an ability to carry a unit of measure and quantity kind associated with the
value. A quantity kind is a kind of quantity that may be stated in terms of defined units, but does not
restrict the selection of a unit to state the value. A unit is a particular value in terms of which a quantity
of the same quantity kind may be expressed. A SysML ValueType and its quantityKind establishes, via
UML typing, the associative relationship between a particular "quantity" [VIM3-1.1] (modeled as a
SysML value property typed by a ValueType) and a "kind of quantity" [VIM3-1.2] (the
ValueType::quantityKind of the SysML value property's type). This UML/SysML associative
relationship reflects the terminological distinction made in VIM3 between the concepts of "quantity"
[VIM3-1.1] and "kind-of-quantity" [VIM3- 1.2] that "cannot be in a generic or partitive hierarchical
relation to each other" [Dybkaer-2010].
A SysML ValueType may define its own properties and/or operations, just as for a UML DataType. See
8.3.2.4, Block for property classifications that SysML defines for either a Block or ValueType.
• unit : InstanceSpecification [0..1]
A quantity, represented by an InstanceSpecification classified by a kind of SysML Unit, in terms of
which the magnitudes of other quantities that have the same quantity kind can be stated.
Constraints
• 1_specializations_are_valuetypes
Any classifier that specializes a ValueType shall also have the ValueType stereotype applied.
UML::Classifier.allInstances()->forAll(c | c.general-
>includes(self.base_DataType) implies ValueType.allInstances().base_DataType-
>includes(c))
• 2_unit
The unit of a ValueType, if any, shall be an InstanceSpecification classified by SysML's Unit block in
the UnitAndQuantityKind model library or a specialization of it.
properties
8.3.3.1.1 Boolean
Description
A Boolean value type consists of the predefined values true and false.
8.3.3.1.2 Complex
Description
A Complex value type represents the mathematical concept of a complex number. A complex number consists
of a real part defined by a real number, and an imaginary part defined by a real number multiplied by the square
root of -1. Complex numbers are used to express solutions to various forms of mathematical equations.
Generalizations
Number (from PrimitiveValueTypes)
Attributes
• imaginaryPart : Real [1]
A real number used to express the imaginary part of a complex number.
• realPart : Real [1]
A real number used to express the real part of a complex number.
8.3.3.1.3 Integer
Description
An Integer value type represents the mathematical concept of an integer number. An Integer value type may be
used to type values that hold negative or positive integer quantities, without committing to a specific
representation such as a binary or decimal digits with fixed precision or scale.
Generalizations
Number (from PrimitiveValueTypes)
8.3.3.1.4 Number
Description
Number is an abstract value type from which other value types that express concepts of mathematical numbers
are specialized.
8.3.3.1.5 Real
Description
A Real value type represents the mathematical concept of a real number. A Real value type may be used to type
values that hold continuous quantities, without committing a specific representation such as a floating point data
type with restrictions on precision and scale.
Generalizations
Number (from PrimitiveValueTypes)
8.3.3.1.6 String
Description
A String value type consists of a sequence of characters in some suitable character set. Character sets may
include non-Roman alphabets and characters.
8.3.3.2.1 QuantityKind
Description
A QuantityKind is a kind of quantity that may be stated by means of defined units. For example, the quantity
kind of length may be measured by units of meters, kilometers, or feet. QuantityKind is defined as a non-
abstract SysML Block defined in the SysML UnitAndQuantityKind model library. QuantityKind, or a
specialization of it, classifies an InstanceSpecification to define a particular "kind-of-quantity" in the sense of an
Figure 8.14: Defining Value Types with units of measure from the International System of Units (SI)
nested connector ends, because they link inside the parts of the vehicle.
Figure 8.15: Vehicle Decomposition
9.1.1 Ports
Ports are points at which external entities can connect to and interact with a block in different or more limited
ways than connecting directly to the block itself. They are properties with a type that specifies features available
to the external entities via connectors to the ports. The features might be properties, including flow properties
and association ends, as well as operations and receptions. The remaining overview sub clauses introduce other
aspects of ports and flows.
9.1.2 Flow Properties, Provided and Required Features, and Nested Ports
SysML extends blocks to support flow properties and provided and required features. Blocks with ports can
type other ports (nested ports). Flow properties specify the kinds of items that might flow between a block and
its environment, whether it is data, material, or energy. The kind of items that flow is specified by typing flow
properties. For example, a block specifying a car’s automatic transmission could have a flow property for
Torque as an input, and another flow property for Torque as an output. Required and provided features are
operations, receptions, and non-flow properties that a block supports for other blocks to use, or requires other
blocks to support for its own use, or both. For example, a block might provide particular services to other
blocks as operations, or have a particular geometry accessible to other block, or it might require services and
geometries of other blocks. Ports nest other ports in the same way that blocks nest other blocks. The type of the
port is a block (or one of its specializations) that also has ports. For example, the ports supporting torque flows
in the transmission example might have nested ports for physical links to the engine or the driveshaft.
Port UML4SysML::Port
ProxyPort SysML::PortsAndFlows::ProxyPort
FullPort SysML::PortsAndFlows::FullPort
FlowProperty SysML::PortsAndFlows::FlowProperty
InterfaceBlock SysML::PortsAndFlows::InterfaceBlock
ItemFlow SysML::PortsAndFlows::ItemFlow
Interface UML4SysML::Interfaces::Interface
Port UML4SysML::Port
ProxyPort SysML::PortsAndFlows::ProxyPort
FullPort SysML::PortsAndFlows::ProxyPort
ItemFlow SysML::PortsAndFlows::ItemFlow
9.3.1.1 DirectedFeature
A DirectedFeature has the same notation as other non-flow properties and behavioral features with a feature
direction prefix (prov | reqd | provreqd), which corresponds to one the FeatureDirectionKind literals “provided,”
“required,” and “providedrequired,” respectively. Directed features can appear in compartments for the various
kinds of properties and behavioral features.
9.3.1.2 FlowProperty
A FlowProperty signifies a single flow element to/from a block. A flow property has the same notation as a
Property only with a direction prefix (in | out | inout). Flow properties are listed in a compartment labeled flow
properties.
9.3.1.3 FullPort
Full ports can appear in block compartments labeled full ports. The keyword «full» before a property name can
also indicate the property is stereotyped by FullPort.
9.3.1.4 InvocationOnNestedPortAction
The nested port path is notated with a string “‘via’ <port-name> [‘,’ <port-name>]+” in the name string of the
icon for the invocation action. It shows the values of the onNestedPort property in order, and the value of the
onPort property at the end.
9.3.1.5 ItemFlow
An ItemFlow describes the flow of items across a connector or an association. The notation of an item flow is a
black arrowhead on the connector or association. The arrowhead is towards the target element. For an item flow
with an item property, the label shows the name and type of the item property (in name: type format). Otherwise
the item flow is labeled with the name of the classifier of the conveyed items. When several item flows having
the same direction are represented, only one triangle is shown, and the list of item flows, separated by a comma
is presented.
9.3.1.6 Port
Ports are notated by rectangles overlapping the boundary of their owning blocks or properties (parts or ports)
typed by the owning block. Port labels appear in the same format as properties on the end of an association. Port
labels can appear inside port rectangles. Nested ports that are not on proxy ports can appear anywhere on the
boundary of the owning port rectangle that does not overlap the boundary of the rectangle the owning port
overlaps.
Port rectangles can have port rectangles overlapping their boundaries, to notate a port type that has ports (nested
ports).
Ports with types that have flow properties all in the same direction, either all in or all out, can have an arrow
inside them indicating the direction of the properties with respect to the owning block. (See FlowProperty on
9.3.1.7 ProxyPort
Proxy ports can appear in block compartments labeled proxy ports. The keyword «proxy» before a property
name can also indicate the property is stereotyped by ProxyPort. Nested ports on proxy ports can appear on the
portion of the boundary of the owning port rectangle that is outside the rectangle the owning port overlaps.
9.3.1.8 TriggerOnNestedPort
The nested port path is notated following a trigger signature with a string “‘«from» (’ <port-name> [‘,’ <port-
name>]+ ‘)’” in the name string of the icon for the trigger. It shows the values of the onNestedPort property in
order, and the value of the port property at the end.
9.3.2 Stereotypes
Package PortsAndFlows
Figure 9.1 - Port Stereotypes
9.3.2.1 AcceptChangeStructuralFeatureEventAction
Description
Accept change structural feature event actions handle change structural feature events (see clause 9.3.2.10). The
actions have exactly two output pins. The first output pin holds the values of the structural feature just after the
values changed, while the second pin holds the values just before the values changed. The action only accepts
events for structural features on the blocks owning the behavior containing the action, or on the behavior itself,
if the behavior is not owned by a block.
Association Ends
• base_AcceptEventAction : AcceptEventAction [1]
Constraints
• 1_one_trigger
The action has exactly one trigger, the event of which shall be a change structural feature event.
self.base_AcceptEventAction.trigger->size()=1 and let trigger: UML::Trigger =
self.base_AcceptEventAction.trigger->any(true) in
ChangeStructuralFeatureEvent.allInstances().base_ChangeEvent-
>includes(trigger.event)
• 2_two_resultpins
The action has two result pins with type and ordering the same as the type and ordering of the
structural feature of the trigger event, and multiplicity compatible with the multiplicity of the structural
feature.
let event: ChangeStructuralFeatureEvent =
ChangeStructuralFeatureEvent.allInstances()->any(e | e.base_ChangeEvent =
self.base_AcceptEventAction.trigger->any(true).event) in
self.base_AcceptEventAction.result->size() = 2 and
self.base_AcceptEventAction.result->forAll(r | r.type =
event.structuralFeature.type and r.isOrdered =
event.structuralFeature.isOrdered and r.lower <= event.structuralFeature.lower
and r.upper >= event.structuralFeature.upper)
• 3_context_owns_structuralfeature
The structural feature of the trigger event shall be owned by or inherited by the context of the behavior
containing the action. (The context of a behavior is either its owning block or itself if it is not owned
by a block. See definition in the UML 2 standard.)
let event: ChangeStructuralFeatureEvent =
ChangeStructuralFeatureEvent.allInstances()->any(e | e.base_ChangeEvent =
self.base_AcceptEventAction.trigger->any(true).event) in
self.base_AcceptEventAction._'context'->notEmpty() and
self.base_AcceptEventAction._'context'.allFeatures()-
>includes(event.structuralFeature)
• 4_can_access_structuralfeature
Visibility of the structural feature of the trigger event shall allow access to the object performing the
action.
let event: ChangeStructuralFeatureEvent =
ChangeStructuralFeatureEvent.allInstances()->any(e | e.base_ChangeEvent =
self.base_AcceptEventAction.trigger->any(true).event) in if
event.structuralFeature.visibility = UML::VisibilityKind::private then
self.base_AcceptEventAction._'context'.feature-
>includes(event.structuralFeature) else if event.structuralFeature.visibility
= UML::VisibilityKind::protected then
self.base_AcceptEventAction._'context'.allFeatures()-
>includes(event.structuralFeature) else if event.structuralFeature.visibility
= UML::VisibilityKind::_'package' then let thePackage: UML::Package =
event.structuralFeature.allNamespaces()->select(n |
n.oclIsKindOf(UML::Package))->first().oclAsType(UML::Package) in (not
thePackage.oclIsUndefined()) and ( let index: Integer =
event.structuralFeature.allNamespaces()->indexOf(thePackage) in
event.structuralFeature.allNamespaces()->subOrderedSet(1, index) ->iterate(n;
acc: Boolean=true | acc and not (n.visibility=UML::VisibilityKind::private or
n.visibility=UML::VisibilityKind::protected)) ) else true endif endif endif
• 5_uml_constraint_removed
The constraint under 11.3.2, "AcceptEventAction" in the UML 2 standard, "[2] There are no output
pins if the trigger events are only ChangeEvents," shall be removed for accept event actions that have
AcceptChangeStructuralFeatureEventAction applied.
9.3.2.2 AddFlowPropertyValueOnNestedPortAction
Description
This enables values added to a flow property to propagate out through a specified behavioral port of an object
executing the action, rather than all behavior ports exposing the flow property. It also enables values added to a
flow property to propagate into objects. Values flowing out of an object are added to an out or inout flow
property of the executing object. In this case, the applied stereotype specifies a (possibly nested) behavioral port
at the end of a (possibly multi-level) path of behavioral ports from a block that supports the flow property.
Values flowing into an object are added to an in or inout flow property of that object, specifying a (possibly
nested) port of that object.
Generalizations
ElementPropertyPath (from Blocks)
Attributes
• onNestedPort : Port [1..*]
Gives a series of ports that end in one supporting the flow property to which a value is being added.
The ordering of ports is from a port of the object of the stereotyped action, through a port of each
intermediate block that types the preceding port, ending in a port with a type that owns or inherits the
flow property. The same port might appear more than once because a block can own a port with the
same block as a type, or another block that has the same property.
(redefines: ElementPropertyPath::propertyPath)
Association Ends
• base_AddStructuralFeatureValueAction : AddStructuralFeatureValueAction [1]
Constraints
• 1_feature_flowproperty
The structural feature referred by actions with this stereotype applied must have FlowProperty applied.
FlowProperty.allInstances().base_Property-
>includes(self.base_AddStructuralFeatureValueAction.structuralFeature)
• 2_onnestedport_first_owned_by_target_type
The port at the first position in the onNestedPort list shall be owned by the block that types the object
pin of the stereotyped action, or one of that block's generalizations.
self.base_AddStructuralFeatureValueAction.object.type.oclAsType(UML::Classifie
r)->allFeatures()->includes(self.onNestedPort->first()))
• 3_path_consistency
The port at each successive position of the onNestedPort attribute, following the first position, shall be
owned by the Block that types the port at the immediately preceding position, or a generalization of
that Block
self.onNestedPort->size() >1 implies self.propertyPath->subSequence(2,
self.onNestedPort->size())->forAll(p |
let pp: UML::Property = self.onNestedPort->at(self.onNestedPort->indexOf(p)-1)
in
let owners: Set(UML::Classifier) = pp.type.oclAsType(UML::Classifier)-
>including(pp.type.oclAsType(UML::Classifier)) in
owners->includes(p.owner))
• 4_onnestedport_last_type_owns_invocation_onPort
The type of the port at the last position of the onNestedPort list shall own or inherit the flow property
that is the structural feature of the stereotyped action
self.onNestedPort->last().type.oclAsType(UML::Classifier).allFeatures()-
>includes(self.base_AddStructuralFeatureValueAction.structuralFeature)
9.3.2.3 Block
Description
Blocks (including specializations of Block) can own ports, including but not limited to proxy ports and full
ports. These blocks can be the type of ports (specifying nested ports), with some restrictions described in other
stereotypes in this sub clause. All links and interactions with a behavioral port (in the UML sense of standing in
for the owning object) are links and interactions with the owner, so the semantics of behavioral ports is the same
as if the value of the port as a property were always the owning block instance (the owning block instance for
behavioral ports on proxy ports is the value of the block usage the proxy port is standing in for, which might be
an internal part). Blocks loosen UML constraints on connectors to support nested ports. See Clause 8, “Blocks”
for further details of blocks.
9.3.2.4 ChangeStructuralFeatureEvent
Description
A ChangeStructuralFeatureEvent models changes in values of structural features.
Association Ends
• base_ChangeEvent : ChangeEvent [1]
• structuralFeature : StructuralFeature [1]
he event models occurrences of changes to values of this structural feature.
Constraints
• 1_not_static
The structural feature shall not be static
not self.structuralFeature.isStatic
• 2_one_featuringclassifier
The structural feature shall have exactly one featuringClassifier
self.structuralFeature.featuringClassifier->size()=1
9.3.2.5 DirectedFeature
Description
A DirectedFeature indicates whether the feature is supported by the owning block (provided), or is to be
supported by other blocks for the owning block to use (required), or both (the owning block for features on
types of proxy ports is the type of the block usage the proxy port is standing in for, which might be an internal
part). Using non-flow properties means to read or write them, and using behavioral features means to invoke
them. Provided non-flow properties are read and written on the owning block, while required non-flow
properties are read or written on an external block. Provided behavioral features are invoked with the owning
block as target, while required behavioral features are invoked with an external block as target (required).
Blocks owning or inheriting required behavioral features can have behaviors invoking the behavioral features
on instances of the block. This sends invocations out along connectors from usages of the block in internal
structures of other blocks, provided the behavioral features match on the other end of the connectors.
Invocations of provided behavioral features due to required behavioral features can only occur when the
features match. A single provided behavioral feature shall match each required one according to the following
Parameters without types are treated as if their type is more general than all other types.
• Provided parameter multiplicity has the same condition as type, where wider multiplicities are "more general"
than narrower ones.
• Provided parameter order (of each parameter separately) has the same condition as type, where unordered
parameters are "more general" than ordered ones.
• Provided parameter uniqueness (of each parameter separately) has the same condition as type, where non-
unique parameters are "more general" than unique ones.
• Provided operation preconditions are the same as or more general than required ones.
• Provided operation body conditions and postconditions are the same or more specialized than required ones.
If corresponding parameters in provided and required behavioral features both have defaults, the default value
specification of the required feature is used for in parameters, and the default value specification of the provided
feature is used for out and return parameters.
Reading or writing provided non-flow properties due to required non-flow properties can only occur when the
features match. Matching non-flow properties shall have the same name. For reading non-flow properties, the
types, multiplicities, uniqueness, and ordering shall match in the same way as out parameters for behavioral
features above. For writing non- flow properties, the types, multiplicities, uniqueness, and ordering shall match
in the same way as in parameters for behavioral features above. For both reading and writing non-flow
properties, the types, multiplicities, uniqueness, and ordering shall be the same. If provided and required non-
flow properties both have defaults, the default value specification of the required feature is used for writing and
the default specification of the provided feature is used for reading.
Attributes
• featureDirection : FeatureDirectionKind [1]
Specifies whether the feature is supported by the owning block (featureDirection="provided"), or is to
be supported by other blocks for the owning block to use (featureDirection="required"), or both
(featureDirection="providedrequired").
Association Ends
• base_Feature : Feature [1]
Constraints
• 1_behavioralfeature_or_not_flowproperty
DirectedFeature shall only be applied to behavioral features, or to properties that do not have
FlowProperty applied, including on subsetted or redefined features.
self.base_Feature.oclIsKindOf(UML::BehavioralFeature) or
(self.base_Feature.oclIsKindOf(UML::Property) and let property: UML::Property
= self.base_Feature.oclAsType(UML::Property) in
FlowProperty.allInstances().base_Property-
>excludesAll(property.redefinedProperty->union(property.subsettedProperty)-
>including(property)))
• 2_method_if_provided
A non-provided operation shall not be associated with a behavior as its method.
self.base_Feature.oclIsKindOf(UML::Operation) and
self.featureDirection=FeatureDirectionKind::required implies
self.base_Feature.oclAsType(UML::Operation).method->isEmpty()
9.3.2.6 FeatureDirectionKind
Description
FeatureDirectionKind is an enumeration type that defines literals used by directed features for specifying
whether they are supported by the owning block, or is to be supported by other blocks for the owning block to
use.
Literals
• provided
Indicates that the feature shall be supported by the owning block.
• providedRequired
Indicates that the feature shall be both provided and required.
• required
Indicates that the feature shall be supported by other blocks.
Constraints
• 2_specializations_are_constraintblocks
Any classifier that specializes a ConstraintBlock shall also have the ConstraintBlock stereotype
applied.
UML::Classifier.allInstances()->forAll(c | c.general-
>includes(self.base_Class) implies ConstraintBlock.allInstances().base_Class-
>includes(c))
9.3.2.7 FlowDirectionKind
Description
FlowDirectionKind is an enumeration type that defines literals used for specifying the direction that items can
flow to or from a block. FlowDirectionKind is used by flow properties to indicate the direction that its items can
flow to or from its owner. (See clause 9.3.2.13 for definition of owning block of proxy ports in this case.)
Literals
• in
Indicates that items of the flow property can flow into the owning block.
• inout
Indicates that items of the flow property can flow into or out of the owning block.
• out
Indicates that items of the flow property can flow out of the owning block.
Description
A FlowProperty signifies a single kind of flow element that can flow to/from its owning instance that is
specified by the block defining that flow property. A flow property's values are either received from or
transmitted to another instance. An "in" flow property value cannot be modified by the owning instance of that
flow property, or by parts of that instance. An "out" flow property can only be modified by the owning instance
of that flow property, or by parts of that instance. An "inout" flow property can be used as an "in" flow property
or an "out" flow property, and there is no restriction regarding the way it can be modified. (The owning block of
a proxy port in this case depends on how the port is nested in the internal structures of blocks, because the block
directly owning the port might be used to type ports or parts at different levels of nesting in multiple blocks, or
the same block. The owning block of a proxy port in the internal structure of a block is the block typing the
innermost full port or part under which the port is nested.)
Flow due to flow properties can only occur when flow properties match. Matching flow properties shall have
matching direction and types. Matching direction is defined below. Flow property types match when the target
flow property type has the same, or a generalization of, the source flow property type. (See 9.3.2.11, ItemFlow
for looser constraints on flow property types across connectors with item flows.) If multiple flow properties on
either end of a connector match by direction and type, then the names of the flow properties shall also be the
same for flow to occur. If multiple flow properties on either end match by direction, type, and name, which can
happen for unnamed flow properties, then no flow will occur.
Flow properties enable item flows across connectors between usages typed by blocks having the properties. For
Block and ValueType flow properties, setting an "out" or "inout" FlowProperty value of a block usage on one
end of a connector will result in assigning the same value of an "in" or "inout" FlowProperty of a block usage at
the other end of the connector, provided the flow properties are matched. It is not specified whether
send/receive signal events are generated when values are written to out/in flow properties typed by Signal
(implementations might choose to do this, but it is not required). This paragraph does not apply to internal
connectors of proxy ports, see next paragraph.
Items going to or from behavioral ports (UML isBehavior = true) are actually going to or from the owning
block. (See clause9.3.2.8 for definition of owning block of proxy ports in this case.) Items going to or from
non-behavioral ports (UML isBehavior = false) are actually going to the port itself (for full ports) or to internal
parts connected to the port (for proxy ports). Because of this, flow properties of a proxy port are the same as
flow properties on the owning block or internal parts, so the flow property directions shall be the same on the
proxy port and owning block or internal parts for items to flow. See Section 9.3.2.18 for the definition of
internal connectors and the semantics of proxy ports.
The flow property semantics above applies to each connector of a block usage, including when the block usage
has multiple connectors.
The binding of flow properties on ports to behavior parameters can be achieved in ways not dictated by SysML.
One approach is to perform name and type matching. Another approach is to explicitly use binding relationships
between the ports properties and behavior parameters or block properties.
Attributes
• direction : FlowDirectionKind [1]
Specifies if the property value is received from an external block (direction="in"), transmitted to an
external Block (direction="out") or both (direction="inout").
Association Ends
• base_Property : Property [1]
Constraints
• 1_restricted_types
A FlowProperty shall be typed by a ValueType, Block, or Signal.
Block.allInstances().base_Class->includes(self.base_Property.type) or
ValueType.allInstances().base_DataType->includes(self.base_Property.type) or
self.base_Property.oclIsKindOf(UML::Signal)
9.3.2.9 FullPort
Description
Full ports specify a separate element of the system from the owning block or its internal parts. They might have
their own internal parts, and behaviors to support interaction with the owning block, its internal parts, or
external blocks. They cannot be behavioral ports, or linked to internal parts by binding connectors, because
these constructs imply identity with the owning block or internal parts. However, full ports can be linked to
non-full ports by binding connectors, because this does not necessarily imply identity with other parts of the
system.
Association Ends
• base_Port : Port [1]
Constraints
• 1_not_proxy
Full ports shall not also be proxy ports. This applies even if some of the stereotypes are on subsetted or
redefined ports.
ProxyPort.allInstances()->excludes(self.base_Port)
• 2_not_bound_to_fullport
Binding connectors shall not link full ports (either directly or indirectly through other binding
connectors) to other composite properties of the block owning the full port (or that block's
generalizations or specializations), unless the composite properties are non-full ports.
let fullPorts: Set(UML::Port) = FullPort.allInstances().base_Port->asSet() in
BindingConnector.allInstances().base_Connector->select(c | c.end.role-
>includes(self.base_Port))->forAll(c | fullPorts->excludesAll(c.end.role-
>reject(r | r=self.base_Port)))
• 3_not_behavioral
Full ports shall not be behavioral (isBehavior=false).
not self.base_Port.isBehavior
9.3.2.10 InterfaceBlock
Description
Interface blocks cannot have behaviors, including classifier behaviors or methods, or internal parts.
Generalizations
Block (from Blocks)
Operations
• getConjugated () : InterfaceBlock [0..*]
bodyCondition:
~InterfaceBlock.allInstances()->any(ib | ib.original = self)
9.3.2.11 InvocationOnNestedPortAction
Description
This extends the capabilities of UML's onPort property of InvocationAction to support nested ports. It identifies
a nested port by a multi-level path of ports from the block that executes the action. Like UML's onPort property,
this extends invocation actions to send invocations out of ports of objects executing the actions, or to ports of
those objects or other objects. Invocations intended to go out of the object executing the action shall be sent to
the executing object on a proxy port. Invocations intended to go directly to a target object are sent to that object
on a port of that object.
Generalizations
ElementPropertyPath (from Blocks)
Association Ends
• base_InvocationAction : InvocationAction [1]
(redefines: ElementPropertyPath::base_Element)
• onNestedPort : Port [1..*]
Gives a series of ports that identifies the port receiving the invocation in the context of the target object
of the invocation. The ordering of ports is from a port of the target object, through a port of each
intermediate block that types the preceding port, ending in a port with a type that owns or inherits the
port given by the onPort property of the invocation action. The onPort port is not included in the
onNestedPort list. The same port might appear more than once because a block can own a port with the
same block as a type, or another block that has the same property.
(redefines: ElementPropertyPath::propertyPath)
Constraints
• 1_onPort_defined
The onPort property of an invocation action shall have a value when this stereotype is applied.
self.base_InvocationAction.onPort->notEmpty()
• 2_onnestedport_first_owned_by_target_type
The port at the first position in the onNestedPort list shall be owned (directly or via inheritance) by a
block that types the target pin of the invocation action, or one of the block's generalizations.
let target: UML::InputPin = if
self.base_InvocationAction.oclIsKindOf(UML::CallOperationAction) then
self.base_InvocationAction.oclAsType(UML::CallOperationAction).target
else if self.base_InvocationAction.oclIsKindOf(UML::SendSignalAction) then
self.base_InvocationAction.oclAsType(UML::SendSignalAction).target
else if self.base_InvocationAction.oclIsKindOf(UML::SendObjectAction) then
self.base_InvocationAction.oclAsType(UML::SendObjectAction).target
else
invalid
endif endif endif in
not target.oclIsUndefined() and (
let target_type: UML::Class = Block.allInstances()->any(b | b.base_Class =
target.type).base_Class in
not target_type.oclIsUndefined() and target_type.allFeatures()-
>includes(self.onNestedPort->first()))
• 3_path_consistency
The port at each successive position of the onNestedPort attribute, following the first position, shall be
owned by the Block that types the port at the immediately preceding position, or a generalization of
that Block.
self.onNestedPort->size() >1 implies self.propertyPath->subSequence(2,
self.onNestedPort->size())->forAll(p |
let pp: UML::Property = self.onNestedPort->at(self.onNestedPort->indexOf(p)-
1) in
let owners: Set(UML::Classifier) = pp.type.oclAsType(UML::Classifier)-
>including(pp.type.oclAsType(UML::Classifier)) in
owners->includes(p.owner))
• 4_onnestedport_last_type_owns_invocation_onPort
The type of the port at the last position of the onNestedPort list shall own or inherit the onPort port of
the stereotyped invocation action.
self.onNestedPort->last().type.oclAsType(UML::Classifier).allFeatures()-
>includes(self.base_InvocationAction.onPort)
9.3.2.12 ItemFlow
Description
An ItemFlow describes the flow of items across a connector or an association. It may constrain the item
exchange between blocks, block usages, or ports as specified by their flow properties. For example, a pump
connected to a tank: the pump has an "out" flow property of type Liquid and the tank has an "in" FlowProperty
of type Liquid. To signify that only water flows between the pump and the tank, we can specify an ItemFlow of
type Water on the connector.
One can label an ItemFlow with the classifiers of the items that may be conveyed. For example: a label Water
would imply that instances of Water might be transmitted over this ItemFlow. In addition, if the item flow
identifies an item property, then one can label the item flow with the item property. For example, a label of
"liquid: Water" means Water items might flow and these items are the values of the property "liquid," i.e., the
values of the "liquid" item property are the instances of Water flowing at any given time. Item properties are
owned by the common (possibly indirect) owner of the source and target of the item flow, rather than by the
source and target types, as flow properties are.
9.3.2.13 ProxyPort
Description
Proxy ports identify features of the owning block or its internal parts that are available to external blocks
through external connectors to the ports. They do not specify a separate element of the system from the owning
block or internal parts. Actions on features of a proxy port have the same effect as if they were acting on
features of the owning block or internal parts the port stands in for, and changes to features of the owning block
or internal parts that the proxy port makes available to external blocks are visible to those blocks via connectors
to the port. (This applies to provided features; for required features, see Section 9.3.2.10.) Proxy ports do not
specify their own behaviors or internal parts, and shall be typed by interface blocks. Their nested ports shall also
be proxy ports.
A completely specified proxy port shall describe how any interaction through the port is handled or initiated.
This can be achieved in several ways. For instance by making it behavioral, by binding it to a fully specified
internal part or by having all its properties individually bound to internal parts. However, blocks can be defined
with non-behavioral proxy ports that do not have internal connectors, with the expectation that these will be
added in specialized blocks. Internal connectors to ports are the ones inside the port's owner (specifically, they
are the ones that do not have a UML partwithPort on the connector end linked to the port, assuming
NestedConnectorEnd is not applied to that end, or if NestedConnectorEnd is applied to that end, they are the
connectors that have only ports in the property path of that end). The rest of the connectors linked to a port are
external.
Proxy ports can be connected to internal parts or ports on internal parts, identifying features on those parts or
ports that are available to external blocks. When a proxy port is connected to a single internal part, the
connector shall be a binding connector, or have the same semantics as a binding connector (the value of the
proxy port and the connected internal part are the same; links of associations typing the connector are between
all objects and themselves, and no others). When a proxy port is connected to multiple internal parts, the
connectors have the same semantics as a single binding connector to an aggregate of those parts, supporting all
their features, and treating flows and invocations from outside the aggregate as if they were to those parts, and
flows and invocations it receives from those parts as if they were to the outside. This aggregate is not a separate
element of the system, and only groups the internal parts for purposes of binding to the proxy port. Internal
connectors to proxy ports can be typed by association blocks, including when the connector is binding.
Association Ends
• base_Port : Port [1]
Constraints
• 1_not_fullport
Proxy ports shall not also be full ports. This applies even if some of the stereotypes are on subsetted or
redefined ports.
9.3.2.14 TriggerOnNestedPort
Description
This extends trigger to support nested ports. It identifies a nested port by a multi-level path of ports from the
object receiving the triggering events. It is not applicable to full ports.
Generalizations
ElementPropertyPath (from Blocks)
Association Ends
• base_Trigger : Trigger [1]
(redefines: ElementPropertyPath::base_Element)
• onNestedPort : Port [1..*]
Gives a series of ports that identifies a port on which the event is occurring, in the context of a block in
which the trigger is used. The ordering of ports is from a port of the receiving object, through a port of
each intermediate block that types the preceding port, ending in a property with a type that owns or
inherits the port given by the port property of the trigger. The port property is not included in the
onNestedPort list. The same port might appear more than once because a block can own a port with the
same block as a type, or another block that has the same property.
(redefines: ElementPropertyPath::propertyPath)
Constraints
• 1_single_proxyport
The port property of the stereotyped trigger shall have exactly one value, and the value cannot be a full
port.
self.base_Trigger.port->size()=1 and FullPort.allInstances().base_Port-
>excludes(self.base_Trigger.port)
• 2_no_fullport
The values of the onNestedPort property shall not be full ports.
FullPort.allInstances().base_Port->excludesAll(self.onNestedPort)
• 3_onnestedport_first_owned_by_context
The port at the first position in the onNestedPort list shall be owned by a block in which the trigger is
used, or one of the block's generalizations.
let theContext: UML::Classifier = if
self.base_Trigger.owner.oclIsKindOf(UML::Action) then
self.base_Trigger.owner.oclAsType(UML::Action)._'context'.oclAsType(UML::Class
) else
self.base_Trigger.owner.oclAsType(UML::Transition).containingStateMachine()._'
context'.oclAsType(UML::Class) endif in let owners: Set(UML::Classifier) =
theContext->closure(general)->including(theContext) in owners-
>includes(self.onNestedPort->first().owner)
• 4_path_consistency
The port at each successive position of the onNestedPort attribute, following the first position, shall be
owned by the Block that types the port at the immediately preceding position, or a generalization of the
Block.
self.onNestedPort->size() >1 implies self.onNestedPort->subSequence(2,
self.onNestedPort->size())->forAll(p |
let np: UML::Port = self.onNestedPort->at(self.onNestedPort->indexOf(p)-1) in
let owners: Set(UML::Classifier) = np.type.oclAsType(UML::Classifier)-
>including(np.type.oclAsType(UML::Classifier)) in
owners->includes(p.owner))
• 5_onnestedport_last_type_owns_trigger_port
The type of the port at the last position of the onNestedPort list must own or inherit the port of the
stereotyped trigger.
self.onNestedPort->last().type.oclAsType(UML::Classifier).allFeatures()-
>includes(self.base_Trigger.port)
9.3.2.15 ~InterfaceBlock
Description
The ~InterfaceBlock stereotype (shall be pronounced: "conjugated interface block") is a specialization of
InterfaceBlock that has the same features as its original InterfaceBlock except that its DirectedFeatures and
FlowProperties are reversed (conjugated), for example, in flow properties are conjugated as out flow properties
and provided features are conjugated as required features. Conjugation is specified by a constraint giving the
features of ~InterfaceBlocks according to those of their original InterfaceBlocks (see the Constraints subsection
below). It is expected that tools conforming to this specification automatically create features of
~InterfaceBlocks.
Generalizations
InterfaceBlock (from PortsAndFlows)
Attributes
• original : InterfaceBlock [1]
The InterfaceBlock that this is a conjugation of.
Operations
• areConjugated (in df1 : DirectedFeature, in df2 : DirectedFeature) : Boolean [1]
DirectedFeature overloaded version of the areConjugated query used for specifying the
inverted_feature invariant that checks whether one feature definition is the conjugated definition of the
other.
bodyCondition:
if (df1.oclIsUndefined()) then
(not df2.oclIsUndefined() and df2.featureDirection =
FeatureDirectionKind::required)
else if (df2.oclIsUndefined()) then
(not df1.oclIsUndefined() and df1.featureDirection =
FeatureDirectionKind::required)
else
(df1.featureDirection = FeatureDirectionKind::provided and
df2.featureDirection = FeatureDirectionKind::required)
or (df1.featureDirection = FeatureDirectionKind::required and
df2.featureDirection = FeatureDirectionKind::provided)
or (df1.featureDirection = FeatureDirectionKind::providedRequired and
df2.featureDirection = FeatureDirectionKind::providedRequired)
Constraints
• enforced_name
The name of an ~InterfaceBlock shall be the name of its original InterfaceBlock with a tilde ("~")
character prepended
self.base_Class.name = '~'+self.original.base_Class.name
• inverted_features
An ~InterfaceBlock has same features and owned rules than its original InterfaceBlock except that –
where applicable – both its DirectedFeatures and FlowProperties have inverted directions (i.e. are
"conjugated").
let allAttributes: Set(UML::Property) = self.base_Class.allFeatures()-
>select(oclIsKindOf(UML::Property)).oclAsType(UML::Property)->asSet() in
let allOperations: Set(UML::Operation) = self.base_Class.allFeatures()-
>select(oclIsKindOf(UML::Operation)).oclAsType(UML::Operation)->asSet() in
let allReceptions: Set(UML::Reception) = self.base_Class.allFeatures()-
>select(oclIsKindOf(UML::Reception)).oclAsType(UML::Reception)->asSet() in
let inheritedRules: Set(UML::Constraint) =
self.base_Class.inherit(self.base_Class.inheritedMember-
>select(oclIsKindOf(UML::Constraint))).oclAsType(UML::Constraint)->asSet() in
let allRules: Set(UML::Constraint) = self.base_Class.ownedRule-
>union(inheritedRules) in
let allOriginalAttributes: Set(UML::Property) =
self.original.base_Class.allFeatures()-
>select(oclIsKindOf(UML::Property)).oclAsType(UML::Property)->asSet() in
let allOriginalOperations: Set(UML::Operation) =
self.original.base_Class.allFeatures()-
>select(oclIsKindOf(UML::Operation)).oclAsType(UML::Operation)->asSet() in
let allOriginalReceptions: Set(UML::Reception) =
self.original.base_Class.allFeatures()-
>select(oclIsKindOf(UML::Reception)).oclAsType(UML::Reception)->asSet() in
let originalInheritedRules: Set(UML::Constraint) =
self.original.base_Class.inherit(self.original.base_Class.inheritedMember-
>select(oclIsKindOf(UML::Constraint))).oclAsType(UML::Constraint)->asSet() in
let allOrignalRules: Set(UML::Constraint) =
self.original.base_Class.ownedRule->union(originalInheritedRules) in
allAttributes->size() = allOriginalAttributes->size()
and allOperations->size() = allOriginalOperations->size()
and allReceptions->size() = allOriginalReceptions->size()
and (allAttributes->isEmpty() or allAttributes->forAll(a |
allOriginalAttributes->exists(oa | areConjugated(a, oa))))
and (allOperations->isEmpty() or allOperations->forAll(o |
allOriginalOperations->exists(oo | areConjugated(o, oo))))
and (allReceptions->isEmpty() or allReceptions->forAll(r |
allOriginalReceptions->exists(ro | areConjugated(r, ro))))
and areSameConstraintSets(allRules, allOrignalRules)
Figure 9.6 - Usage example of ports with provided and required features
Figure 9.14 - Water Delivery association block with internal Plumbing connector
ConstraintBlock SysML::ConstraintBlocks:
ConstraintBlock
ParametricDiagram SysML::ConstraintBlocks:
ConstraintBlock
SysML::Blocks::Block
The «constraint» keyword on a block definition states that the block is a constraint block. An expression that
specifies the constraint may appear in the constraints compartment of the block definition, using either formal
statements in some language, or informal statements using text. This expression can include a formal reference
to a language in braces as indicated in Table 10.1. Parameters of the constraint may be shown in a compartment
with the predefined compartment label “parameters.”
Constraint blocks support a special form of compartment, with the label “parameters,” which may contain
declarations for some or all of its constraint parameters. Properties of a constraint block should be shown either
in the constraints compartment, for nested constraint properties, or within the parameters compartment.
10.3.1.2 Parametric Diagram
A parametric diagram is defined as a restricted form of internal block diagram. A parametric diagram may
contain constraint properties and their parameters, along with other properties from within the internal block
context. All properties that appear, other than the constraints themselves, shall either be bound directly to a
constraint parameter, or contain a property that is bound to one (through any number of levels of containment).
A constraint property may be shown on a parametric diagram using a rectangle with rounded corners. This
graphical shape distinguishes a constraint property from all other properties and avoids the need to show an
explicit «constraint» keyword. Otherwise, this notation is equivalent to the standard form of an internal property
with a «constraint» keyword shown. Compartments and internal properties may be shown within the shape just
as for other types of internal properties.
A constraint property may be shown on a parametric diagram using a standard form of internal property
rectangle with the «constraint» keyword preceding its name. Parameters are shown within a constraint property
using the standard notations for internal properties.
A value property may optionally be shown by a small square box, with the name and other specifications
appearing in a text string close to the square box. The text string for such a value property may include all the
elements that could ordinarily be used to declare the property in a compartment of a block, including an
optional default value. The box may optionally be shown with one edge flush with the boundary of a containing
property. Placement of property boxes is purely for notational convenience, for example to enable simpler
connection from the outside, and has no semantic significance. If a connector is drawn to a region where an
internal property box is shown flush with the boundary of a containing property, the connector is always
assumed to connect to the innermost property.
10.3.2 Stereotypes
Description
A constraint block is a block that packages the statement of a constraint so it may be applied in a reusable way
to constrain properties of other blocks. A constraint block typically defines one or more constraint parameters,
which are bound to properties of other blocks in a surrounding context where the constraint is used. Binding
connectors, as defined in clause 8 are used to bind each parameter of the constraint block to a property in the
surrounding context. All properties of a constraint block are constraint parameters, with the exception of
constraint properties that hold internally nested usages of constraint blocks.
A constraint property is a property of any block that is typed by a constraint block. It holds a localized usage of
the constraint block. Binding connectors may be used to bind the parameters of this constraint block to other
properties of the block that contains the usage.
Generalizations
Block (from Blocks)
Constraints
• 1_constraintparameters_only
A constraint block shall not own any structural or behavioral elements beyond the properties that
define its constraint parameters, constraint properties that hold internal usages of constraint blocks,
binding connectors between its internally nested constraint parameters, constraint expressions that
define an interpretation for the constraint block, and general-purpose model management and
crosscutting elements.
-- Cannot be expressed in OCL
• 3_composite
Any property of a block that is typed by a ConstraintBlock shall have composite aggregation.
self.base_Class.ownedAttribute->forAll(p| p.isComposite)
11.1.3 Probability
SysML introduces probability into activities as follows (see Probability in Figure 11.8):
• Extension of edges with probabilities for the likelihood that a value leaving the decision node or object
node will traverse an edge.
• Extension of output parameter sets with probabilities for the likelihood that values will be output on a
parameter set.
11.1.4 Activities as Blocks
In UML, all behaviors including activities are classes, and their instances are executions. Behaviors can appear
on block definition diagrams, and participate in generalization and associations. SysML clarifies the semantics
of composition association between activities, and between activities and the type of object nodes in the
activities, and defines consistency rules between these diagrams and activity diagrams. See 11.3.1.1, Activity.
11.1.5 Timelines
The simple time model in UML can be used to represent timing and duration constraints on actions in an
activity model. These constraints can be notated as constraint notes in an activity diagram. Although the UML 2
timing diagram was not included in this version of SysML, it can complement SysML behavior diagrams to
notate this information. More sophisticated SysML modeling techniques can incorporate constraint blocks from
Clause 10, “Constraint Blocks” to specify resource and related constraints on the properties of the inputs,
outputs, and other system properties. (Note: refer to 11.3.1.4, ObjectNode, Variables, and Parameters for
constraining properties of object nodes).
ActivityFinal UML4SysML::ActivityFinalNode
ControlOperator SysML::Activities::ControlOperator
DecisionNode UML4SysML::DecisionNode
FlowFinal UML4SysML::FlowFinalNode
ForkNode UML4SysML::ForkNode
InitialNode UML4SysML::InitialNode
JoinNode UML4SysML::JoinNode
isControl UML4SysML::Pin.isControl
isStream UML4SysML::Parameter.isStream
MergeNode UML4SysML::MergeNode
NoBuffer SysML::Activities::NoBuffer
Notation Name Concrete Syntax Abstract Syntax Reference
Optional SysML::Activities::Optional
OverWrite SysML::Activities::Overwrite
ParameterSet SysML::Activities::ParameterSet
Portability SysML::Activities::Portability
Notation Name Concrete Syntax Abstract Syntax Reference
Rate SysML::Activities::Rate
SysML::Activities::Continuous,
SysML::Activities::Discrete
ControlFlow UML4SysML::ControlFlow
SysML::Activities::ControlFlow
ObjectFlow UML4SysML::ObjectFlow
Probability SysML::Activities::Probability
Rate SysML::Activities::Rate,
SysML::Activities::Continuous,
SysML::Activities::Discrete
Table 11.3: Other graphical elements included in activity diagrams
ActivityPartition UML4SysML::ActivityPartition
StructuredActivityNode UML4SysML::StructuredActivity
Node
11.3.1.1 Activity
11.3.1.1.1 Notation
In UML, all behaviors are classes, including activities, and their instances are executions of the activity. This
follows the general practice that classes define the constraints under which the instances must operate. Creating
an instance of an activity causes the activity to start executing, and vice versa. Destroying an instance of an
activity terminates the corresponding execution, and vice versa. Terminating an execution also terminates the
execution of any other activities that it invoked synchronously, that is, expecting a reply.
Activities as blocks can have associations between each other, including composition associations. Composition
means that destroying an instance at the whole end destroys instances at the part end. When composition is used
with activity blocks, the termination of execution of an activity on the whole end will terminate executions of
activities on the part end of the links.
Combining the two aspects above, when an activity invokes other activities, they can be associated by a
composition association, with the invoking activity on the whole end, and the invoked activity on the part end.
If an execution of an activity on the whole end is terminated, then the executions of the activities on the part end
are also terminated. The upper multiplicity on the part end restricts the number of concurrent synchronous
executions of the behavior that can be invoked by the containing activity. See Constraints below.
Activities in block definition diagrams appear as regular blocks, except the «activity» keyword may be used to
indicate the Block stereotype is applied to an activity, as shown in Figure 11.1. See example in 11.4, Usage
Examples. This provides a means for representing activity decomposition in a way that is similar to classical
functional decomposition hierarchies. Properties with AdjunctProperty applied, where the principal of the
AdjunctProperties are call actions, including call behavior actions, can be used as the part end of the
associations. See 8.3.2.2 for constraints when AdjunctProperty is used with call actions. Activities in block
definition diagrams can also appear with the same notation as CallBehaviorAction, except the rake notation can
be omitted, if desired. Also see use of activities in block definition diagrams that include ObjectNodes.
Activities as blocks can have properties of any kind, including value properties. Activity block properties have
all the capabilities of other properties, including that value properties can be bound to parameters in constraint
blocks by binding connectors.
11.3.1.2 CallBehaviorAction
Stereotypes applied to behaviors may appear on the notation for CallBehaviorAction when invoking those
11.3.1.3 ControlFlow
Control flow may be notated with a dashed line and stick arrowhead, as shown in Figure 11.4.
11.3.1.4.1 Notation
See 11.3.1.1, Activity with regard to activities appearing in block definition diagrams. Associations can be used
between activities and classifiers (blocks or value types) that are the type of object nodes, variables, or
parameters in the activity, as shown in Figure 11.5. This supports linking the execution of the activity with items
that are flowing through the activity or assigned to variables or parameters, and happen to be contained by an
object node or assigned to a variable or parameter at the time the link exists. Properties with AdjunctProperty
applied, where the principal of the AdjunctProperty is an object node, variable, or parameter, can be used as the
end of the associations toward the object node, variable, or parameter type. Like any association end or property
these can be the subject of parametric constraints, design values, units, and quantity kinds. The associations may
be composition if the intention is to delete instances of the classifier flowing the activity when the activity is
terminated. See example in 11.4, Usage Examples.
Figure 11.5 - Block definition diagram with activities as blocks associated with types of object nodes, variables,
and parameter
Object nodes in activity diagrams can optionally show the node name with the name of the type of the object
node as shown in Figure 11.6.
object nodes, and applies to all the pins notated by the object node.
Figure 11.7 - ObjectNode notation in activity diagrams
11.3.2 Stereotypes
The following abstract syntax defines the stereotypes in this clause and which metaclasses they extend. The
descriptions, attributes, and constraints for each stereotype are specified below.
11.3.2.1 Continuous
Description
Continuous rate is a special case of rate of flow (see Rate) where the increment of time between items
approaches zero. It is intended to represent continuous flows that may correspond to water flowing through a
pipe, a time continuous signal, or continuous energy flow. It is independent from UML streaming, see clause
11.3.2.8. A streaming parameter may or may not apply to continuous flow, and a continuous flow may or may
not apply to streaming parameters.
UML places no restriction on the rate at which tokens flow. In particular, the time between tokens can approach
as close to zero as needed, for example to simulate continuous flow. There is also no restriction in UML on the
kind of values that flow through an activity. In particular, the value may represent as small a number as needed,
for example to simulate continuous material or energy flow. Finally, the exact timing of token flow is not
completely prescribed in UML. In particular, token flow on different edges may be coordinated to occur in a
clocked fashion, as in time march algorithms for numerical solvers of ordinary differential equations, such as
Runge-Kutta.
Generalizations
Rate (from Activities)
11.3.2.2 ControlOperator
Description
A control operator is a behavior that is intended to represent an arbitrarily complex logical operator that can be
used to enable and disable other actions. When the «controlOperator» stereotype is applied to behaviors, the
behavior takes control values as inputs or provides them as outputs, that is, it treats control as data (see clause
11.3.3.1.1). When the «controlOperator» stereotype is not applied, the behavior may not have a parameter typed
by ControlValue. The «controlOperator» stereotype also applies to operations with the same semantics.
The control value inputs do not enable or disable the control operator execution based on their value, they only
enable based on their presence as data. Pins for control parameters are regular pins, not UML control pins. This
is so the control value can be passed into or out of the action and the invoked behavior, rather than control the
starting of the action, or indicating the ending of it.
Association Ends
• base_Behavior : Behavior [0..1]
• base_Operation : Operation [0..1]
Constraints
• 1_one_parameter_controlvalue
When the «controlOperator» stereotype is applied, the behavior or operation shall have at least one
parameter typed by ControlValue. If the stereotype is not applied, the behavior or operation may not
have any parameter typed by ControlValue.
UML::Behavior.allInstances()->forAll(b | not
(ControlOperator.allInstances().base_Behavior->includes(b) xor
b.ownedParameter->exists(p |
p.type=SysML::Libraries::ControlValues::ControlValue))) and
UML::Operation.allInstances()->forAll(o | not
(ControlOperator.allInstances().base_Operation->includes(o) xor
o.ownedParameter->exists(p |
p.type=SysML::Libraries::ControlValues::ControlValue)))
• 2_controloperator_operation_method
A behavior shall have the «controlOperator» stereotype applied if it is a method of an operation that
has the «controlOperator» stereotype applied.
(self.base_Operation->notEmpty() and self.base_Operation.method->notEmpty())
implies self.base_Operation.method->forAll(b |
ControlOperator.allInstances().base_Behavior->includes(b))
11.3.2.3 Discrete
Description
Discrete rate is a special case of rate of flow (see clause11.3.2.8) where the increment of time between items is a
non-zero. Examples include the production of assemblies in a factory and signals set at periodic time intervals.
Generalizations
Rate (from Activities)
Constraints
• 1_not_continuous
The «discrete» and «continuous» stereotypes shall not be applied to the same element at the same time.
(self.base_ActivityEdge->notEmpty() implies
Continuous.allInstances().base_ActivityEdge->excludes(self.base_ActivityEdge))
11.3.2.4 NoBuffer
Description
When the «nobuffer» stereotype is applied to object nodes, tokens arriving at the node are discarded if they are
refused by outgoing edges, or refused by actions for object nodes that are input pins. This is typically used with
fast or continuously flowing data values, to prevent buffer overrun, or to model transient values, such as
electrical signals. For object nodes that are the target of continuous flows, «nobuffer» and «overwrite» have the
same effect. The stereotype does not override UML token offering semantics; it just indicates what happens to
the token when it is accepted. When the stereotype is not applied, the semantics are as in UML, specifically,
tokens arriving at an object node that are refused by outgoing edges, or action for input pins, are held until they
can leave the object node.
Association Ends
• base_ObjectNode : ObjectNode [1]
Constraints
• 1_not_overwrite
The «nobuffer» and «overwrite» stereotypes cannot be applied to the same element at the same time.
Overwrite.allInstances().base_ObjectNode->excludes(self.base_ObjectNode)
11.3.2.5 Overwrite
Description
When the «overwrite» stereotype is applied to object nodes, a token arriving at a full object node removes one
that is already there before being added (a full object node has as many tokens as allowed by its upper bound).
This is typically used on an input pin with an upper bound of 1 to ensure that stale data is overridden at an input
pin. For upper bounds greater than one, the token removed is the one that has been in the object node the
longest. For FIFO ordering, this is the token that is next to be selected, for LIFO it is the token that would be
last to be selected. Tokens arriving at a full object node with the Overwrite stereotype applied take up their
positions in the ordering as normal, if any. The arriving tokens do not take the positions of the removed tokens.
A null token removes all the tokens already there. The number of tokens replaced is equal to the weight of the
incoming edge, which defaults to 1. For object nodes that are the target of continuous flows, «overwrite» and
«nobuffer» have the same effect. The stereotype does not override UML token offering semantics, just indicates
what happens to the token when it is accepted. When the stereotype is not applied, the semantics is as in UML,
specifically, tokens arriving at object nodes do not replace ones that are already there.
Association Ends
• base_ObjectNode : ObjectNode [1]
Constraints
• 1_not_nobuffer
The «overwrite» and «nobuffer» stereotypes cannot be applied to the same element at the same time.
NoBuffer.allInstances().base_ObjectNode->excludes(self.base_ObjectNode)
11.3.2.6 Optional
Description
When the «optional» stereotype is applied to parameters, the lower multiplicity shall be equal to zero. This
means the parameter is not required to have a value for the activity or any behavior to begin or end execution.
Otherwise, the lower multiplicity shall be greater than zero, which is called "required." The absence of this
stereotype indicates a constraint, see below.
Association Ends
• base_Parameter : Parameter [1]
Constraints
• 1_lower_is_0
A parameter with the «optional» stereotypes applied shall have multiplicity.lower equal to zero,
otherwise multiplicity.lower shall be greater than zero
UML::Parameter.allInstances()->forAll(p |
Optional.allInstances().base_Parameter->includes(p) xor p.lower > 0)
11.3.2.7 Probability
Description
When the «probability» stereotype is applied to edges coming out of decision nodes and object nodes, it
provides an expression for the probability that the edge will be traversed. These shall be between zero and one
inclusive, and add up to one for edges with same source at the time the probabilities are used.
When the «probability» stereotype is applied to output parameter sets, it gives the probability the parameter set
will be given values at runtime. These shall be between zero and one inclusive, and add up to one for output
parameter sets of the same behavior at the time the probabilities are used.
Attributes
• probability : ValueSpecification [1]
Value of the probability
Association Ends
• base_ActivityEdge : ActivityEdge [0..1]
• base_ParameterSet : ParameterSet [0..1]
Constraints
• 1_source_decisionnode_or_objectnode
The «probability» stereotype shall only be applied to activity edges that have decision nodes or object
nodes as sources, or to output parameter sets.
(self.base_ActivityEdge->notEmpty() implies
self.base_ActivityEdge.source.oclIsKindOf(UML::DecisionNode)) and
(self.base_ParameterSet->notEmpty() implies self.base_ParameterSet.parameter-
>forAll(p | p.direction=UML::ParameterDirectionKind::out))
• 2_all_outgoing_edges
When the «probability» stereotype is applied to an activity edge, then it shall be applied to all edges
coming out of the same source.
self.base_ActivityEdge->notEmpty() implies
Probability.allInstances().base_ActivityEdge-
>includesAll(self.base_ActivityEdge.target.incoming)
• 3_all_parametersets
When the «probability» stereotype is applied to an output parameter set, it shall be applied to all the
parameter sets of the behavior or operation owning the original parameter set.
self.base_ParameterSet->notEmpty() implies
Probability.allInstances().base_ParameterSet-
11.3.2.8 Rate
Description
When the «rate» stereotype is applied to an activity edge, it specifies the expected value of the number of
objects and values that traverse the edge per time interval, that is, the expected value rate at which they leave
the source node and arrive at the target node. It does not refer to the rate at which a value changes over time.
When the stereotype is applied to a parameter, the parameter shall be streaming, and the stereotype gives the
number of objects or values that flow in or out of the parameter per time interval while the behavior or
operation is executing. Streaming is a characteristic of UML behavior parameters that supports the input and
output of items while a behavior is executing, rather than only when the behavior starts and stops. The flow may
be continuous or discrete, see the specialized rates in clause 11.3.2.1 and clause 11.3.2.3. The «rate» stereotype
has a rate property of type InstanceSpecification. The values of this property shall be instances of classifiers
stereotyped by «valueType» or «distributionDefinition», see clause 8. In particular, the denominator for units
used in the rate property shall be time units.
Attributes
• rate : InstanceSpecification [1]
Value of the rate
Association Ends
• base_ActivityEdge : ActivityEdge [0..1]
• base_ObjectNode : ObjectNode [0..1]
• base_Parameter : Parameter [0..1]
Constraints
• 1_streaming
When the «rate» stereotype is applied to a parameter, the parameter shall be streaming.
self.base_Parameter->notEmpty() implies self.base_Parameter.isStream
• 2_edges_rates
The rate of a parameter shall be less than or equal to rates on edges that come into or go out from pins
and parameters nodes corresponding to the parameter.
self.base_Parameter->notEmpty() implies (
let nodes: Set(UML::ObjectNode) =
if self.base_Parameter.owner.oclIsKindOf(UML::Behavior) then
let pOwner: UML::Behavior =
self.base_Parameter.owner.oclAsType(UML::Behavior) in
UML::CallBehaviorAction.allInstances()->select(a | a.behavior = pOwner)
->collect(a | a.argument->at(pOwner.ownedParameter-
>indexOf(self.base_Parameter)))
->union(UML::StartObjectBehaviorAction.allInstances()->select(a |
a.behavior() = pOwner)
->collect(a | a.argument->at(pOwner.ownedParameter-
>indexOf(self.base_Parameter))))
->union(UML::ActivityParameterNode.allInstances()->select(n | n.parameter =
self.base_Parameter))->asSet()
else if self.base_Parameter.owner.oclIsKindOf(UML::Operation) then
let pOwner: UML::Operation =
self.base_Parameter.owner.oclAsType(UML::Operation) in
UML::CallOperationAction.allInstances()->select(a | a.operation = pOwner)
->collect(a | a.argument->at(pOwner.ownedParameter-
>indexOf(self.base_Parameter)))->asSet()
else
Set(UML::ObjectNode){}
endif endif in
nodes.incoming->flatten()->union(nodes.outgoing->flatten())
->forAll(e | let eRate: Rate = Rate.allInstances()->any(r |
r.base_ActivityEdge=e) in
(not eRate.oclIsUndefined() and self.rate.specification.realValue() <=
eRate.rate.specification.realValue())) )
11.3.3.1.1 ControlValueKind
Description
The ControlValueKind enumeration is a type for treating control values as data (see clause11.3.2.2) and for
UML control pins. It can be used as the type of behavior and operation parameters, object nodes, and attributes,
and so on. The possible runtime values are given as enumeration literals. Modelers can extend the enumeration
with additional literals, such as suspend, resume, with their own semantics.
The disable literal means a termination of an executing behavior that can only be started again from the
beginning (compare to suspend). The enable literal means to start a new execution of a behavior (compare to
resume).
Literals
• disable
The disable literal means a termination of an executing behavior that can only be started again from the
beginning (compare to suspend).
The activity diagram for Monitor Traction is shown in Figure 11.11. When Monitor Traction is enabled, it
begins listening for signals coming in from the wheel and accelerometer, as indicated by the signal receipt
symbols on the left, which begin listening automatically when the activity is enabled. A traction index is
calculated every 10 ms, which is the slower of the two signal rates. The accelerometer signals come in
continuously, which means the input to Calculate Traction does not buffer values. The result of Calculate
Traction is filtered by a decision node for a threshold value and Calculate Modulation Frequency determines the
output of the activity.
The activity diagram for the control operator Enable on Brake Pressure > 0 is shown in Figure 11.12. The
decision node and guards determine if the brake pressure is greater than zero, and flow is directed to value
Figure 11.13 shows a block definition diagram with composition associations between the activities and
AdjunctProperty applied to the part ends in Figures 11.10, 11.11, and 11.12, as an alternative way to show the
activity decomposition of Figures 11.10, 11.11, and 11.12. Each instance of Operating Car is an execution of
that behavior. It owns the executions of the behaviors it invokes synchronously, such as Driving. Like all
composition, if an instance of Operating Car is destroyed, terminating the execution, the executions it owns are
also terminated.
Figure 11.14 shows a block definition diagram with composition associations between the activity in Figure
11.10 and the types the object nodes in that activity, with AdjunctProperty applied to the object node type end.
In an instance of Operating Car, which is one execution of it, instances of Brake Pressure and Modulation
Frequency are linked to the execution instance when they are in the object nodes of the activity.
Figure 11.14 - Example block definition diagram for object node types
Lifeline UML4SysML::Lifeline
Notation Name Concrete Syntax Abstract Syntax Reference
InteractionUse UML4SysML::InteractionUse
An InteractionUse with just the <interaction-
name>.
An InteractionUse with <attribute - name>,
the value of arguments, the <return-value>,
etc.
CombinedFragment UML4SysML::CombinedFragment
A combined fragment is defined by an
interaction operator and corresponding
interaction operands.
Interaction Operators include:
seq - Weak Sequencing
alt – Alternatives
opt – Option
break – Break
par – Parallel
strict - Strict Sequencing
loop – Loop
critical - Critical Region
neg – Negative
assert – Assertion
ignore – Ignore
consider – Consider
CreationEvent UML4SysML::CreationEvent
DestructionEvent UML4SysML::DestructionEvent
Notation Name Concrete Syntax Abstract Syntax Reference
TimeConstraint UML4SysML::Interactions
TimeObservation
SequenceDiagram UML4SysML::Interaction
(advanced)
InteractionUse UML4SysML::InteractionUse
(advanced)
Message UML4SysML::Message
GeneralOrdering UML4SysML::GeneralOrdering
Communication diagrams and Interaction Overview diagrams are excluded from SysML. The other behavioral
diagram representations were considered to provide sufficient coverage without introducing these diagram
kinds. Timing diagrams are also excluded due to concerns about their maturity and suitability for systems
engineering needs.
12.3.1.2.1 Notation
In UML, all behaviors are classes, including interactions, and their instances are executions of the interaction.
Interactions as blocks and associations between interactions corresponding to interaction uses have an
analogous semantics to activities as blocks and associations between activities corresponding to call actions, see
11.3.1.1.1, Notation. Similarly, associations between interactions and classifiers (blocks or value types) have an
analogous semantics to associations between activities and blocks or value types, see 11.3.1.4.1, Notation.
Figure 12.1 - Block definition diagram with interactions as blocks associated with used interactions and types of
parameters
Action UML4SysML::Transition
Region UML4SysML::Region
Notation Name Concrete Syntax Abstract Syntax Reference
Transition UML4SysML::Transition
13.3.1.1.1 Notation
In UML, all behaviors are classes, including state machines, and their instances are executions of the state
machine. State machines as blocks and associations between state machines corresponding to submachine
states have an analogous semantics to activities as blocks and associations between activities corresponding to
call actions, see 11.3.1.1.1, Notation. Similarly, associations between state machines and classifiers (blocks or
value types) have an analogous semantics to associations between activities and blocks or value types, see
11.3.1.4.1, Notation.
State machines in block definition diagrams appear as regular blocks, except the «stateMachine» keyword may
be used to indicate the Block stereotype is applied to an state machine, as shown in Figure 13.1. Properties with
AdjunctProperty applied, where the principal of the AdjunctProperty is a submachine state, can be used as the
end of the associations towards the sub state machine. Properties with AdjunctProperty applied, where the
principal of the AdjunctProperty is a parameter of the state machine, can be used as the end of the associations
towards the parameter type. See 8.3.2.2, AdjunctProperty for constraints when AdjunctProperty is used with
submachine states and parameters. State machines in block definition diagrams can also appear with the same
notation as submachine states.
Actor UML4SysML::Actor
Include UML4SysML::include
Extend UML4SysML::Extend
Generalization UML4SysML::Kernel
In Figure D.6 the Extend relationship specifies that the behavior of a use case may be extended by the behavior
of another (usually supplementary) use case. The extension takes place at one or more specific extension points
defined in the extended use case. Note, however, that the extended use case is defined independently of the
extending use case and is meaningful independently of the extending use case. On the other hand, the extending
use case typically defines behavior that may not necessarily be meaningful by itself. Instead, the extending use
case defines a set of modular behavior increments that augment an execution of the extended use case under
specific conditions. The “Start the Vehicle” use case is modeled as an extension of “Drive the Vehicle.” This
means that there are conditions that may exist that require the execution of an instance of “Start the Vehicle”
before an instance of “Drive the Vehicle” is executed.
The use cases “Accelerate,” “Steer,” and “Brake” are modeled using the include relationship. Include is a
DirectedRelationship between two use cases, implying that the behavior of the included use case is inserted into
the behavior of the including use case. It is also a kind of NamedElement so that it can have a name in the
context of its owning use case. The including use case may only depend on the result (value) of the included use
case. This value is obtained as a result of the execution of the included use case. This means that “Accelerate,”
“Steer,” and “Brake” are all part of the normal process of executing an instance of “Drive the Car.”
In many situations, the use of the Include and Extend relationships is subjective and may be reversed, based on
the approach of an individual modeler.
15.3.1.1 Tables
Allocation relationships may be depicted in tables. A separate row is provided for each «allocate» dependency.
“from” is the client of the «allocate» dependency, and “to” is the supplier. Both ElementType and ElementName
for client and supplier appear in this table.
The “allocate” relationship is a dashed line with an open arrow head. The arrow points in the direction of the
allocation. In other words, the directed line points “from: the element being allocated “to” the element that is the
target of the allocation.
When the allocations of a model element are displayed in a compartment, a shorthand notation is used as shown
in Table 15.1. This shorthand groups and lists the elements allocated to that element together (in the “allocated
from” compartment), then the elements allocated from that element (in the “allocated to” compartment), per the
result of Allocate::getAllocatedFrom() and getAllocatedTo() respectively, called with that element as parameter.
When the allocation compartment is not used, a callout notation may be used. An allocation callout notation
uses the same shorthand notation as the allocation compartment. This notation is also shown in Table 15.1. For
brevity, the «elementType» portion of allocated-from or allocated-to elements may be elided from the diagram.
For brevity, the keyword used on an AllocatedActivityPartition is «allocate», rather than the stereotype name
(«allocateActivityPartition»). For brevity, the «elementType» portion of the allocatedFrom or allocatedTo
property may be elided from the diagram.
15.3.2 Stereotypes
Package Allocations
15.3.2.1 Allocate
Description
Allocate is a dependency based on UML::Abstraction. It is a mechanism for associating elements of different
types, or in different hierarchies, at an abstract level. Allocate is used for assessing user model consistency and
directing future design activity. It is expected that an «allocate» relationship between model elements is a
precursor to a more concrete relationship between the elements, their properties, operations, attributes, or sub-
classes.
The following paragraphs describe types of allocation that are typical in systems engineering.
Behavior allocation relates to the systems engineering concept segregating form from function. This concept
requires independent models of "function" (behavior) and "form" (structure), and a separate, deliberate mapping
between elements in each of these models. It is acknowledged that this concept does not support a standard
object-oriented paradigm, not is this always even desirable. Experience on large scale, complex systems
engineering problems have proven, however, that segregation of form and function is a valuable approach. In
addition, behavior allocation may also include the allocation of Behaviors to BehavioralFeatures of Blocks (e.g.,
Flow allocation specifically maps flows in functional system representations to flows in structural system
representations.
Flow between activities can either be control or object flow. The figures in the Usage Examples show concrete
syntax for how object flow is mapped to connectors on Activity Diagrams. Allocation of control flow is not
specifically addressed in SysML, but may be represented by relating an ItemFlow to the Control Flow using the
UML relationship InformationalFlow.realizingActivityEdge.
Note that allocation of ObjectFlow to Connector is an Allocation of Usage, and does NOT imply any relation
between any defining Blocks of ObjectFlows and any defining associations of connectors.
The figures in the Usage Examples illustrate an available mechanism for relating the objectNode from an
activity diagram to the ItemFlow on an internal block diagram. ItemFlow is discussed in clause 9 , "Ports and
Flows."
Structure allocation is associated with the concept of separate "logical" and "physical" representations of a
system. It is often necessary to construct separate depictions of a system and define mappings between them.
For example, a complete system hierarchy may be built and maintained at an abstract level. In turn, it shall then
be mapped to another complete assembly hierarchy at a more concrete level. The set of models supporting
complex systems development may include many of these levels of abstraction. This International Standard will
not define "logical" or "physical" in this context, except to acknowledge the stated need to capture allocation
relationships between separate system representations.
Generalizations
DirectedRelationshipPropertyPath (from Blocks)
Association Ends
• base_Abstraction : Abstraction [1]
(redefines: DirectedRelationshipPropertyPath::base_DirectedRelationship)
Operations
• getAllocatedFrom (in ref : NamedElement) : NamedElement [0..*]
bodyCondition:
getAllocatedFrom = Allocate.allInstances()->select(to = ref).from
• getAllocatedTo (in ref : NamedElement) : NamedElement [0..*]
bodyCondition:
getAllocatedFrom = Allocate.allInstances()->select(from = ref).to
Constraints
• 2_binary
A single «allocate» dependency shall have only one client (from) and one supplier (to).
self.base_Abstraction.source->size() = 1 and self.base_Abstraction.target-
>size() = 1
15.3.2.2 AllocateActivityPartition
Description
AllocateActivityPartition is used to depict an «allocate» relationship on an Activity diagram. The
AllocateActivityPartition is a standard UML::ActivityPartition, with modified constraints as stated below.
Association Ends
• base_ActivityPartition : ActivityPartition [1]
Constraints
• 1_actions_on_client_ends
An Action appearing in an "AllocateActivityPartition" shall be the /client (from) end of an "allocate"
dependency. The element that represents the "AllocateActivityPartition" shall be the /supplier (to) end
of the same "allocate" dependency. In the «AllocateActivityPartition» name field, Properties are
designated by the use of a fully qualified name (including colon, e.g., "part_name:Block_Name"), and
Classifiers are designated by a simple name (no colons, e.g., "Block_Name").
self.base_ActivityPartition.node->select(n|n.oclIsKindOf(UML::Action)) -
>forAll(a | let allocs: Set(UML::Abstraction) =
Allocate.allInstances().base_Abstraction->select(x |x.client->includes(a))-
>asSet() in allocs->exists(x | x.supplier-
>includes(self.base_ActivityPartition.represents)))
• 2_not_uml_semantics
The «AllocateActivityPartition» shall maintain the constraints, but not the semantics, of the
UML::ActivityPartition. Classifiers or Properties represented by an «AllocateActivityPartition» do not
have any direct responsibility for invoking behavior depicted within the partition boundaries. To depict
this kind of direct responsibility, the modeler is directed to the UML 2 standard, sub clause 12.3.10,
"ActivityPartition," Semantics topic.
-- Cannot be expressed in OCL
Systems engineers have frequent need to allocate structural model elements (e.g., blocks, parts, or connectors)
to other structural elements. For example, if a particular user model includes an abstract logical structure, it may
be important to show how these model elements are allocated to a more concrete physical structure. The need
also arise, when adding detail to a structural model, to allocate a connector (at a more abstract level) to a part (at
a more concrete level).
Example: consider the functions required to portion and deliver power for a hybrid SUV. The activities for
providing power are allocated to blocks within the Hybrid SUV, as shown in Figure D.38.
Figure D.39 shows an internal block diagram showing allocation for the HybridSUV Accelerate example.
Requirement SysML::Requirements::
Diagram
Requirement, SysML::
ModelElements::Package
Requirement SysML::Requirements::
«requirement»
Requirement
Requirement Name
derived
«requirement» Derived Reqt Name
derivedF rom
«requirement» DerivedFrom Reqt Name
mas ter
«requirement» Master Reqt Name
refinedB y
«namedElement» Element Name
satis fiedB y
«namedElement» Element Name
tracedT o
«namedElement» Element Name
verifiedB y
«namedElement» Element Name
Id = "62j32"
Text = "The system shall do..."
NamedElement UML4SysML::NamedElement
«namedElement»
Element Name
refines
«requirement» Requirement Name
satis fies
«requirement» Requirement Name
tracedF rom
«requirement» Requirement Name
verifies
«requirement» Requirement Name
Table 16.2: Graphical paths included in Requirement diagrams
Requirement UML4SysML::Nested
containment Classifier
relationship
MasterCallout SysML::Requirements::Copy
DeriveDependency SysML::Requirements::
DeriveReqt
DeriveCallout SysML::Requirements::
DeriveReqt
SatisfyDependency SysML::Requirements::Satisfy
SatisfyCallout SysML::Requirements::Satisfy
VerifyDependency SysML::Requirements::Verify
VerifyCallout SysML::Requirements::Verify
RefineDependency UML4SysML::Refine
Path Type Concrete Syntax Abstract Syntax Reference
RefineCallout UML4SysML::Refine
TraceDependency UML4SysML::Trace
TraceCallout UML4SysML::Trace
The Requirement Diagram can only display requirements, packages, other classifiers, test cases, and rationale.
The relationships for containment, deriveReqt, satisfy, verify, refine, copy, and trace can be shown on a
requirement diagram. The callout notation can also be used to reflect the relationship of other model elements to
a requirement.
The requirement is represented as shown in Table 16.1. The «requirement» compartment label for the stereotype
properties compartment (e.g., id and text) can be elided.
A callout notation can be used to represent derive, satisfy, verify, refine, copy, and trace relationships as
indicated in Table 16.2. For brevity, the «elementType» may be elided.
Requirements can also be represented on other diagrams to show their relationship to other model elements. The
compartment and callout notation described in 16.3.1.2, Requirement Notation and 16.3.1.3, Requirement
Property Callout Format can be used. The callouts represent the requirement that is attached to another model
element such as a design element.
The tabular format is used to represent the requirements, their properties and relationships, and may include:
Requirements with their properties in columns.
A column that includes the supplier for any of the dependency relationships (Derive, Verify, Refine,
Trace).
A column that includes the model elements that satisfy the requirement.
A column that represents the rationale for any of the above relationships, including reference to
analysis reports for trace rationale, trade studies for design rationale, or test procedures for verification
rationale.
The relationships between requirements and other objects can also be shown using a sparse matrix style that is
similar to the table used for allocations (15.4.3, Tabular Representation). The table should include the source
and target elements names (and optionally kinds) and the requirement dependency kind.
16.3.2 Stereotypes
Package Requirements
16.3.2.1 AbstractRequirement
Description
An AbstractRequirement establishes the attributes and relationships essential to any potential kind of
requirement. Any intended requirement kind should subclass AbstractRequirement. The only normative
stereotype based on AbstractRequirement is the Requirement stereotype, described in clause 16.3.2.5 .
Examples of additional non-normative stereotypes based on AbstractRequirement are included in clause 22.8 .
Attributes
• base_NamedElement : NamedElement [1]
• /derived : AbstractRequirement [0..*]
Derived from all requirements that are the client of a «deriveReqt» relationship for which this
16.3.2.2 Copy
Description
A Copy relationship is a dependency between a supplier requirement and a client requirement that specifies that
the text of the client requirement is a read-only copy of the text of the supplier requirement.
A Copy dependency created between two requirements maintains a master/slave relationship between the two
elements for the purpose of requirements re-use in different contexts. When a Copy dependency exists between
two requirements, the requirement text of the client requirement is a read-only copy of the requirement text
ofthe requirement at the supplier end of the dependency.
Generalizations
Trace (from Requirements)
Operations
• isCopy (in req1 : AbstractRequirement, in req2 : AbstractRequirement) : Boolean [1]
bodyCondition:
let subReq1: Set(AbstractRequirement) = AbstractRequirement.allInstances()
->select(r | req1.base_NamedElement.ownedElement-
>includes(r.base_NamedElement)) in
let subReq2: Set(AbstractRequirement) = AbstractRequirement.allInstances()
->select(r | req2.base_NamedElement.ownedElement-
>includes(r.base_NamedElement)) in
req1.text = req2.text and subReq1->size() = subReq2->size() and
subReq1->forAll(r1 | subReq2->exists(r2 | self.isCopy(r1, r2) ))
Constraints
• 1_source_and_taget_are_requirements
A Copy dependency may only be created between two NamedElements that have a subtype of the
abstractRequirement stereotype applied
AbstractRequirement.allInstances().base_NamedElement-
>includesAll(self.base_Abstraction.client) and
AbstractRequirement.allInstances().base_NamedElement-
>includesAll(self.base_Abstraction.supplier)
• 2_same_text
The text property of the client requirement is constrained to be a read-only copy of the text property of
the supplier requirement and this applies recursively to all subrequirements
let cltReq: AbstractRequirement = AbstractRequirement.allInstances()->any(r |
self.base_Abstraction.client->includes(r.base_NamedElement)) in let supReq:
16.3.2.3 DeriveReqt
Description
A DeriveReqt relationship is a dependency between two requirements in which a client requirement can be
derived from the supplier requirement. For example, a system requirement may be derived from a business
need, or lower-level requirements may be derived from a system requirement. As with other dependencies, the
arrow direction points from the derived (client) requirement to the (supplier) requirement from which it is
derived.
Generalizations
Trace (from Requirements)
Constraints
• 1_supplier_is_requirement
The supplier shall be an element stereotyped by a subtype of AbstractRequirement.
AbstractRequirement.allInstances().base_NamedElement-
>includesAll(self.base_Abstraction.client)
• 2_client_is_requirement
The client shall be an element stereotyped by a subtype of AbstractRequirement.
AbstractRequirement.allInstances().base_NamedElement-
>includesAll(self.base_Abstraction.supplier)
16.3.2.4 Refine
Description
The Refine stereotype specializes UML4SysML Refine and DirectedRelationshipPropertyPath to enable
refinements to identify their sources and targets by a multi-level path of accessible properties from context
blocks for the sources and targets.
Generalizations
DirectedRelationshipPropertyPath (from Blocks)
Association Ends
• base_Abstraction : Abstraction [1]
(redefines: DirectedRelationshipPropertyPath::base_DirectedRelationship)
Operations
• getRefines (in ref : NamedElement) : AbstractRequirement [0..*]
The query getRefines() gives all the requirements that are suppliers ("to"end of the concrete syntax) of
a «Refine» relationships whose client is the element in parameter. This is a static query.
bodyCondition:
Refine.allInstances()-
>select(base_Abstraction.client=ref).base_Abstraction.supplier
Constraints
• 2_binary
Abstractions with a Refine stereotype or one of its specializations applied shall have exactly one client
and one supplier.
self.base_Abstraction.client->size()=1 and self.base_Abstraction.supplier-
>size()=1
16.3.2.5 Requirement
Description
A requirement specifies a capability or condition that must (or should) be satisfied. A requirement may specify a
function that a system must perform or a performance condition that a system must satisfy. Requirements are
used to establish a contract between the customer (or other stakeholder) and those responsible for designing and
implementing the system.
A requirement is a stereotype of both Class and Abstract Requirement. Compound requirements can be created
by using the nesting capability of the class definition mechanism. The default interpretation of a compound
requirement, unless stated differently by the compound requirement itself, is that all its subrequirements shall be
satisfied for the compound requirement to be satisfied. Subrequirements shall be accessed through the
"nestedClassifier" property of a class. When a requirement has nested requirements, all the nested requirements
apply as part of the container requirement. Deleting the container requirement deleted the nested requirements,
a functionality inherited from UML.
Generalizations
AbstractRequirement (from Requirements)
Association Ends
• base_Class : Class [1]
(redefines: AbstractRequirement::base_NamedElement)
Constraints
• 1_no_operation
The property "ownedOperation" shall be empty.
self.base_Class.ownedOperation->isEmpty()
• 2_no_attribute
The property "ownedAttribute" shall be empty.
self.base_Class.ownedAttribute->isEmpty()
• 3_no_association
Classes stereotyped by «requirement» shall not participate in associations.
UML::Association.allInstances().memberEnd->flatten().type-
>excludes(self.base_Class)
• 4_no_generalization
Classes stereotyped by «requirement» shall not participate in generalizations.
UML::Classifier.allInstances().general->flatten()->excludes(self.base_Class)
• 5_nestedclassifiers_are_requirements
A nested classifier of a class stereotyped by Requirement or one of its specializations shall also be
stereotyped by Requirement or one of its specializations
self.base_Class.nestedClassifier->forAll(c |
Requirement.allInstances().base_Class->includes(c))
• 6_not_a_type
Classes stereotyped by «requirement» shall not be used to type any other model element.
UML::TypedElement.allInstances().type->excludes(self.base_Class)
Description
A test case is a method for verifying a requirement is satisfied.
Association Ends
• base_Behavior : Behavior [0..1]
• base_Operation : Operation [0..1]
Constraints
• 1_return_verdictkind
The type of return parameter of the stereotyped model element shall be VerdictKind. (note this is
consistent with the UML Testing Profile).
(self.base_Behavior->notEmpty() implies self.base_Behavior.ownedParameter-
>exists(p | p.direction=UML::ParameterDirectionKind::return and p.type =
VerdictKind )) and (self.base_Operation->notEmpty() implies
self.base_Operation.ownedParameter->exists(p |
p.direction=UML::ParameterDirectionKind::return and p.type = VerdictKind ))
16.3.2.7 Satisfy
Description
A Satisfy relationship is a dependency between a requirement and a model element that fulfills the requirement.
As with other dependencies, the arrow direction points from the satisfying (client) model element to the
(supplier) requirement that is satisfied.
Generalizations
Trace (from Requirements)
Operations
• getSatisfies (in ref : NamedElement) : AbstractRequirement [0..*]
bodyCondition:
Satisfy.allInstances()-
>select(base_Abstraction.client=ref).base_Abstraction.supplier
Constraints
• 1_supplier_is_requirement
The supplier shall be an element stereotyped by any subtype of «AbstractRequirement».
AbstractRequirement.allInstances().base_NamedElement-
>includes(self.base_Abstraction.supplier)
16.3.2.8 Trace
Description
The Trace stereotype specializes UML4SysML Trace and DirectedRelationshipPropertyPath to enable traces to
identify their sources and targets by a multi-level path of accessible properties from context blocks for the
sources and targets.
Generalizations
DirectedRelationshipPropertyPath (from Blocks)
Association Ends
• base_Abstraction : Abstraction [1]
(redefines: DirectedRelationshipPropertyPath::base_DirectedRelationship)
Operations
• getTracedFrom (in ref : NamedElement) : AbstractRequirement [0..*]
The query getTracedFrom() gives all the requirements that are clients ("from" end of the concrete
syntax) of a «Trace» relationship whose supplier is the element in parameter. This is a static query.
bodyCondition:
AbstractRequirement.allInstances()->select(tracedTo->includes(ref))
Constraints
• 2_binary
Abstractions with a Trace stereotype or one of its specializations applied shall have exactly one client
and one supplier.
self.base_Abstraction.client->size()=1 and self.base_Abstraction.supplier-
>size()=1
16.3.2.9 Verify
Description
A Verify relationship is a dependency between a requirement and a test case or other model element that can
determine whether a system fulfills the requirement. As with other dependencies, the arrow direction points
from the (client) element to the (supplier) requirement.
Generalizations
Trace (from Requirements)
Operations
• getVerifies (in ref : NamedElement) : AbstractRequirement [0..*]
The query getVerifies() gives all the requirements that are suppliers ( "to" end of the concrete syntax )
of a «Verify» relationships whose client is the element in parameter. This is a static query.
bodyCondition:
Verify.allInstances()-
>select(base_Abstraction.client=ref).base_Abstraction.supplier
Constraints
• 1_supplier_is_requirement
The supplier shall be an element stereotyped by any subtype of «AbstractRequirement».
AbstractRequirement.allInstances().base_NamedElement-
>includes(self.base_Abstraction.supplier)
Decelerate Car
«rationale» «block»
body = “This design of the brake
BrakeSystem
«refine» assembly satisfies the federal safety
requirements.”
f: FrontBrake
«requirement» r: Rear Brake
Master Cylinder Efficacy l1: BrakeLine
l2: BrakeLine
id = “S5.4.1” «satisfy» m: MasterCylinder
text =”A master cylinder shall have a reservoir
compartment for each service brake activateBrake()
subsystem serviced by the master cylinder. releaseBrake()
Loss of fluid from one compartment
shall not result in a complete loss of
brake fluid from another compartment.”
id = “S5.4.1a” id = “S5.4.1b”
text =”Prevent complete loss of fluid” text = "Separate reservoir compartment”
SatisfiedBy
BrakeSystem::l1
BrakeSystem::l2
«rationale»
body = “The best-practice
SatisfiedBy solution consists in using a set of
BrakeSystem::m springs and pistons to confine the
loss to a single compartment”
Figure 16.7 - Linkage of a Test Case to a requirement: This figure shows the Test Case as a State Diagram
Stereotype UML4SysML::Stereotype
Metaclass UML4SysML::Class
Node Name Concrete Syntax Abstract Syntax Reference
Profil UML4SysML::Profile
Extension UML4SysML::Extension
Generalization UML4SysML::Generalization
ProfileApplication UML4SysML::Profile
Application
MetamodelReference UML4SysML::PackageImport;
UML4SysML::ElementImport
Unidirectional UML4SysML::Association
Association
NOTE: In the above table, boolean properties can be displayed alternatively as BooleanPropertyName=[True|
False].
17.2.1.1 Extension
In Figure 17.1, a simple stereotype Clock is defined to be applicable at will (dynamically) to instances of the
metaclass Class and describes a clock software component for an embedded software system. It has description
of the operating system version supported, an indication of whether it is compliant to the POSIX operating
system standard and a reference to the operation that starts the clock.
Figure 17.1 - Defining a stereotype
StereotypeNode UML4SysML::Element
StereotypeNode UML4SysML::Element
StereotypeInNode UML4SysML::Element
StereotypeInCompartmen UML4SysML::Element
tElement
StereotypeOnEdge UML4SysML::Element
StereotypeCompartment UML4SysML::Element
17.2.2.1 StereotypeInNode
Figure 17.2 shows how the stereotype Clock, as defined in Figure 17.1, is applied to a class called AlarmClock.
When two stereotypes, Clock and Creator, are applied to the same model element, as is shown in Figure 17.3,
the attribute values of each of the applied stereotypes can be shown in a comment symbol attached to the model
element.
Figure 17.3 - Other notational forms for showing values
17.2.2.3 StereotypeInCompartment
In this case, AlarmClock is valid for OS version 3.4, is POSIX-compliant and has a starting operation called
Start. Note that multiple stereotypes can be shown using multiple compartments.
In this example, the modeler has created a new profile called SE Toolkit, which imports the SysML profile, so
that it can build upon the stereotypes it contains. The set of metaclasses available to users of the SysML profile
is identified by a reference to a metamodel, in this case a subset of UML specific to SysML. The SE Toolkit can
extend those metaclasses from UML that the SysML profile references.
In SE Toolkit, both the mechanisms for adding new stereotypes are used. The first, exemplified by
configurationItem, is called an extension, shown by a line with a filled triangle; this relates a stereotype to a
reference (called base) class or classes, in this case NamedElement and DirectedRelationship from UML and
adds new properties that every NamedElement or DirectedRelationship stereotyped by configurationItem must
have. NamedElement and DirectedRelationship are abstract classes in UML so it is their subclasses that can
have the stereotype applied. The second mechanism is demonstrated by the system and context stereotypes
which are sub-stereotypes of an existing SysML stereotype, Block; sub-stereotypes inherit any properties of
their super-stereotype and also extend the same base class or classes. Note that TypedElements whose type is
extended by «system» do not display the «system» stereotype; this also applies to InstanceSpecifications. Any
notational conventions of this have to be explicitly specified in a diagram extension.
There is also an example of how stereotypes (in this case FunctionalRequirement) can have unidirectional
associations to metaclasses in the reference metamodel (in this case Behavior).
The model library SI Value Types imports a model library called SI Definitions, so it can use model elements
from them in its own definition. It defines value types having specific units which can be used when property
values are measured in SI units. SI Definitions is a separately published model library, containing definitions of
standard SI units and quantity kinds such as shown in Annex D, sub clause D.4. A further model library,
Physical, imports SI Value Types so it can define properties that have those types. One model element,
PhysicalObject, is shown, a block that can be used as a supertype for a physical object.
Figure 17.8 - A model with applied profile and imported model library
The HSUVModel is a systems engineering model that needs to use stereotypes from SysML. It therefore needs
to have the SysML profile applied to it. In order to use the predefined SI units, it also needs to import the SI
Definitions model library. Having done this, elements in HSUVModel can be extended by SysML stereotypes
and types like SIVolume can be used to type properties. Both the SI Definitions model library and HSUVModel
have applied the profile strictly, which means that only those metaclasses directly referenced by SysML can be
used in those models.
17.4.6 Using a Stereotype
Figure 17.9 - Using two stereotypes on a model element
Model library elements can be used just like any other model element of the same type. In this case, Shot is a
specialization of PhysicalObject from the Physical model library. It adds a new property, circumference, of type
SILength to measure the circumference of the (spherical) shot.
The frame is a rectangle that is required for SysML diagrams (Note: the frame is optional in UML). The frame
shall designate a model element that is the default namespace for the model elements enclosed in the frame. A
qualified name for the model element within the frame shall be provided if it is not contained within default
namespace associated with the frame. The following are some of the designated model elements associated with
the different diagram kinds.
• activity diagram - activity
• block definition diagram - block, package, or constraint block
• internal block diagram - block or constraint block
• package diagram - package or model
• parametric diagram - block or constraint block
• requirement diagram - package or requirement
• sequence diagram - interaction
• state machine diagram - state machine
• use case diagram - package
The frame may include border elements associated with the designated model element, like
• ports for blocks,
• entry/exit points on statemachines,
• gates on interactions,
• parameters for activities, and
• constraint parameters for constraint blocks.
The frame may sometimes be defined by the border of the diagram area provided by a tool.
The diagram contents area contains the graphical symbols. The diagram type and usage defines the type of
primary graphical symbols that are supported, e.g., a block definition diagram is a diagram where the primary
symbols in the contents area are blocks and association symbols along with their adornments.
The heading name is a string contained in a name tag (rectangle with cutoff corner) in the upper leftmost corner
of the rectangle, with the following syntax:
<diagramKind> [modelElementType] <modelElementName> [diagramName]
A space separates each of these entries. The diagramKind is bolded. The modelElementType and diagramName
are in brackets. The heading name should always contain the diagram kind and model element name, and
include the model element type and additional information to remove ambiguity. Ambiguity can occur if there is
more than one model element type for a given diagram kind, or where there is more than one diagram for the
same model element. If a model element type has a stereotype applied to the base model element, such as
“modelLibrary” applied to a package or “controlOperator” applied to an activity, then either the stereotype
name or the base model element may be used as the name for the model element type. In either case, the initial
character of the name is shown in lower case. For a stereotype name, guillemet characters (« and ») are not
shown. If more than one stereotype has been applied to the base model element, either the name of one of the
applied stereotypes or a comma-separated list of any or all of the applied stereotype names may be shown. If a
base model element name is used, this element is either a UML metaclass which SysML uses directly, such as
package or activity, or a stereotype which SysML defines on a UML metaclass, such as block or view.
SysML diagram kinds should have the following names or (abbreviations) as part of the heading:
• activity diagram (act)
• block definition diagram (bdd)
• internal block diagram (ibd)
• package diagram (pkg)
• parametric diagram (par)
• requirement diagram (req)
• sequence diagram (sd)
• state machine diagram (stm)
• use case diagram (uc)
The diagram description can be defined by a comment attached to a diagram frame as indicated in Figure A.2
that includes version, description, references to related information, a completeness field that describes the
extent to which the modeler asserts the diagram is complete, and other user defined fields. In addition, the
diagram description may identify the view associated with the diagram, and the corresponding viewpoint that
identifies the stakeholders and their concerns (refer to Model Elements clause). The diagram description can be
made more explicit by the tool implementation.
SysML also introduces the concept of a diagram usage. This represents a unique usage of a particular diagram
type, such as a context diagram as a usage of a block definition diagram, internal block diagram, or use case
diagram. The diagram usage can be identified in the header above the diagramKind as «diagramUsage». An
example of a diagram usage extension is shown in Figure A.3. For this example, the header in Figure A.2 would
replace diagram kind with “uc” and «diagramUsage» with «ContextDiagram». Applying a stereotype approach
to specify a diagram usage can allow a tool implementation to check that the diagram constraints defined by the
stereotype are satisfied.
Diagram usage can be represented by creating stereotypes that extend SysMLDiagram (see Annex B).
A.2 Guidelines
The following provides some general guidelines that apply to all diagram types.
• Decomposition of a model element can be represented by the rake symbol. This does not always mean
decomposition in a formal sense, but rather a reference to a more elaborated diagram of the model
element that includes the rake symbol. This notation adds to the existing decomposition notations
defined in UML (Composite state symbol for States that refer to StateMachines and rake symbol for
CallBehaviorActions that refer to Activities). In SysML, the rake on a model element may also include
the following:
o activity diagram - call behavior actions that can refer to another activity diagram.
o internal block diagram - parts that can refer to another internal block diagram.
o package diagram - package that can refer to another package diagrams.
o parametric diagram - constraint property that can refer to another parametric diagram.
o requirement diagram - requirement that can refer to another requirement diagram.
o sequence diagram - interaction fragments that can refer to another sequence diagram.
o state machine diagram - state that can refer to another state machine diagram.
o use case diagram - use case can that may be realized by other behavior diagrams (activity,
state, interactions).
• The primary mechanism for linking a text label outside of a symbol to the symbol is through proximity
of the label to its symbol. This applies to ports, item flows, pins, etc.
• Page connectors (on-page connectors and off-page connectors) can be used to reduce the clutter on
diagrams, but should be used sparingly since they are equivalent to go-to(s) in programming languages,
and can lead to “spaghetti diagrams.” Whenever practical, elaborate the model element designated by
the frame instead of using a page connector. A page connector is depicted as a circle with a label inside
(often a letter). The circle is shown at both ends of a line break and means that the two line end connect
at the circle.
• When two lines cross, the crossing optionally may be shown with a small semicircular jog to indicate
that the lines do not intersect (as in electrical circuit diagrams), as shown in Figure A.4.
• Diagram overlays are diagram elements that may be used on any diagram kind. An example of an
overlay may be a geographic map to provide a spatial context for the symbols.
• SysML diagrams including the enhancements described in this sub clause are intended to conform to
diagram definition and interchange standards to facilitate exchange of diagram and layout information.
• Tabular and matrix representation is an optional alternative notation that can be used in conjunction
with the graphical symbols as long as the information is consistent with the underlying metamodel.
Tabular and matrix representations are often used in systems engineering to represent detailed
information and other views of the model such as interface definitions, requirements traceability, and
allocation relationships between various types of model elements. They also can be convenient
mechanisms to represent property values for selected properties, and basic relationships such as
function and inputs/outputs in N2 charts. UML contains a tabular representation of a sequence diagram
in an interaction matrix (refer to UML Annex with interaction matrix). The implementations of tabular
and matrix representations are defined by the tool implementations and are not standardized in SysML
at this time. However, tabular or matrix representations may be included in a frame with the heading
designator «table» or «matrix» in bold.
• Graph and tree representations are also optional, alternative notations that can be used in conjunction
with graphical symbols as long as the information is consistent with the underlying metamodel. These
representations can be used for describing complex series of relationships that represent other views of
the model. One example is the browser window in many tools that depicts a hierarchical view of the
model. The implementations of graphs and trees are defined by the tool implementations and are not
standardized in SysML at this time. However, graph and tree representations may be included in a
frame with the heading designator «graph» or «tree» in bold.
B.2 Stereotypes
Figure B.2: Abstract Syntax Extension for SysMLDiagramElement
Attributes
• isControlFlowDashed : Boolean [1] = false
Specifies whether the control flows in the activity diagram are dashed (isControlFlowDashed=true) or
not (isControlFlowDashed=false).
Constraints
[1] A SysMLActivityDiagram shall have as a defaultNamespace an Activity.
Constraints
[1] SysMLBehaviorDiagram shall only be applied to a UMLBehaviorDiagram.
[2] SysMLActivityDiagram shall only be applied to a UMLActivityDiagram.The principal of an applied
AdjunctProperty shall be a Connector, CallAction, ObjectNode, Variable, Parameter, submachine State,
or InteractionUse.
B.2.3 SysMLBlockDefinitionDiagram
Description
A SysMLBlockDefinitionDiagram represents a block definition diagram. It extends UMLPackageDiagram.
Constraints
[1] A SysMLBlockDefinitionDiagram shall have as a defaultNamespace a Class with a Block stereotype or
one of its specializations applied or a Package.
B.2.4 SysMLDiagram
Description
SysMLDiagram is an abstract stereotype for all SysML diagrams. It extends UMLDiagram.
Attributes
• defaultNamespace : Namespace [1]
Specifies the default namespace of the SysML diagram.
Constraints
[3] A SysMLDiagram that stereotypes a UMLDiagram with a modelElement shall have this modelElement
as defaultNamespace.
B.2.5 SysMLDiagramElement
Description
SysMLDiagramElement is an abstract generalization of all the other SysML DI stereotypes.
Attributes
• isDecompositionSymbolShown : Boolean [1]
Display a decomposition symbol in a diagram element to indicate the corresponding model element is
decomposed in another diagram. Diagram elements that may have a decomposition symbol are listed in
Annex A.
Constraints
[1] A UMLDiagramWithAssociations stereotyped by a specialization of SysMLDiagramWithAssociations
shall have isAssociationDotShown=false.
B.2.7 SysMLInteractionDiagram
Description
A SysMLInteractionDiagram represents an interaction diagram. It extends UMLInteractionDiagram.
Constraints
[1] A SysMLInteractionDiagram shall have as a defaultNamespace an Interaction.
B.2.8 SysMLInternalBlockDiagram
Description
A SysMLInternalBlockDiagram represents an internal block diagram. It extends
UMLCompositeStructureDiagram.
Constraints
[1] A SysMLInternalBlockDiagram shall have as a defaultNamespace a Class with a Block stereotype or
one of its specializations applied.
B.2.9 SysMLPackageDiagram
Description
A SysMLPackageDiagram represents a package diagram. It extends UMLPackageDiagram.
Constraints
[1] A SysMLPackageDiagram shall have as a defaultNamespace a Package.
Description
A SysMLParametricDiagram represents a parametric diagram. It is a specialization of
SysMLInternalBlockDiagram.
Attributes
• isConstraintPropertyRounded: Boolean = false
Specifies whether the constraint properties in the parametric diagram have rounded corners
(isConstraintPropertyRounded=true) or not (isConstraintPropertyRounded=false).
Constraints
[1] A SysMLParametricDiagram shall have as a defaultNamespace a Class with a Block stereotype or one
of its specializations applied.
B.2.11 SysMLRequirementDiagram
Description
A SysMLRequirementDiagram represents a requirement diagram. It is based on the UML class diagram.
Constraints
[1] A SysMLRequirementDiagram shall have as a defaultNamespace a Package or a Class with a
Requirement stereotype or one of its specializations applied.
B.2.12 SysMLStateMachineDiagram
Description
A SysMLStateMachineDiagram represents a state machine diagram. It extends UMLStateMachineDiagram.
Constraints
[1] A SysMLStateMachineDiagram shall have as a defaultNamespace a StateMachine.
B.2.13 SysMLUseCaseDiagram
Description
A SysMLUseCaseDiagram represents a use case diagram. It extends UMLUseCaseDiagram.
Constraints
[1] A SysMLUseCaseDiagram shall have as a defaultNamespace a Package.
• Defines SysML elements that are deprecated, but included for backward compatibility (see Subannexes
C.1.1 and C.1.2).
• Provides guidlines for migrating elements to this version of SysML that are deprecated (see above) or
that changed significantly between versions of SysML (see Subannexes C.5 through C.7).
Conjugated Ports
FlowPort SysML::PortsAndFlows::FlowPort
FlowSpecification SysML::PortsAndFlows::
FlowSpecification
Port UML4SysML::Port
FlowPort SysML::PortsAndFlows::FlowPort
ItemFlow SysML::PortsAndFlows::ItemFlow
Conjugated ports have UML's Port::isConjugated property equal to true. Arrows in port rectangles indicated
flow property direction are reversed in conjugated ports. Conjugated ports in conjugated ports (nested
conjugated ports) behave as if they were not conjugated. Full ports also cannot be conjugated, because their
types can have behaviors and can be reused on non-conjugated ports. This would require the same behaviors to
use the directed features and flow properties in opposite directions at the same time.
The meaning of FlowProperty::direction is reversed for conjugated ports. On conjugated ports, flow properties
with direction "in" are out flow properties and those with direction "out" are in flow properties. Port conjugation
has no impact on "inout" flow properties. The meanings of the "in" and "out" literals in FlowDirection are
switched for conjugated ports. In these cases the actual flow direction is in the opposite direction than the one
specified by the enumeration literal.
C.3.1.2 FlowPort
A FlowPorts is an interaction point through which input and/or output of items such as data, material, or energy
may flow. The notation of flow port is a square on the boundary of the owning block or its usage. The label of
the flow port is in the format portName: portType. Atomic flow ports have an arrow inside them indicating the
direction of the port with respect to the owning Block. A nonatomic flow port has two open arrow heads facing
away from each other (i.e., < >). The fill color of the square is white and the line and text colors are black.
In addition, flow ports can be listed in a special compartment labeled “flow ports.” The format of each line is:
in | out | inout portName:portType [{conjugated}]
C.3.1.3 FlowSpecification
A FlowSpecification specifies inputs and outputs as a set of flow properties. It has a “flowProperties”
compartment that lists the flow properties.
C.3.2 Stereotypes
C.3.2.2 FlowPort
Description
A FlowPort is an interaction point through which input and/or output of items such as data, material, or energy
may flow. This enables the owning block to declare which items it may exchange with its environment and the
interaction points through which the exchange is made.
We distinguish between atomic flow port and a nonatomic flow port. Atomic flow ports relay items that are
classified by a single Block, ValueType, or Signal classifier. A nonatomic flow port relays items of several types
as specified by a FlowSpecification.
The binding of the flow properties on the ports to behavior parameters and/or block properties is a semantic
variation point. One approach is to perform name and type matching. Another approach is to explicitly use
binding relationships between the ports properties and behavior parameters or block properties.
Attributes
• /isAtomic : Boolean (derived)
This is a derived attribute (derived from the flow port’s type). For a flow port typed by a flow
specification the value of this attribute is False, otherwise the value is True.
• direction : FlowDirection
Indicates the direction in which an atomic flow port relays its items. If the direction is set to “in,” then
the items are relayed from an external connector via the flow port into the flow port’s owner
(or one of its parts). If the direction is set to “out,” then the items are relayed from the
flow port’s owner, via the flow port, through an external connector attached to the flow port.
If the direction is set to “inout,” then items can flow both ways. By default, the value is
inout.
Constraints
[1] A FlowPort shall be typed by a FlowSpecification, Block, Signal, or ValueType.
[2] If the FlowPort is atomic (by its type), then isAtomic=True, the direction shall be specified (has a
value), and isConjugated is not specified (has no value).
[3] If the FlowPort is nonatomic, and the FlowSpecification typing the port has flow properties with
direction “in,” the FlowPort direction shall be “in” (or “out” if isConjugated=true). If the flow properties are
all out, the FlowPort direction shall be out (or in if isConjugated=true). If flow properties are both in and
out, the direction shall be inout.
[4] A FlowPort can be connected (via connectors) to one or more flow ports that have matching flow
properties. The matching of flow properties shall be done in the following steps:
1. Type Matching: The type being sent shall be the same type or a subtype of the type being
received.
2. Direction Matching: If the connector connects two parts that are external to one another, then
the
direction of the flow properties shall be opposite, or at least one of the ends should be
inout. If the
connector is internal the owner of one of the flow ports, then the direction shall be the
same or at least
one of the ends shall be inout.
3. Name Matching: In case there is type and direction match to several flow properties at the
other end,
the property that has the same name at the other end shall be selected. If there is no
such property, then
the connection is ambiguous (ill-formed).
[5] If a flow port is not connected to an internal part, then isBehavior shall be set to true.
C.3.2.4 FlowSpecification
Description
A FlowSpecification specifies inputs and outputs as a set of flow properties. A flow specification is used by flow
ports to specify what items can flow via the port.
Constraints
[1] Flow specifications shall not own operations or receptions (they can only own FlowProperties).
[2] Every “ownedAttribute” of a FlowSpecification shall be a FlowProperty.
ItemFlows are not deprecated, but when used with atomic flows ports, have a deprecated modification of item
flow compatibility rules that treats types of source and target atomic ports as if they were types of flow
properties on types of those ports.
• Conform
o Replace v1.3 Conform with v1.4 Conform. The conform target in 1.3 becomes the general
classifier in 1.4.
• View
o Replace v1.3 View package with 1.4 View class
• Viewpoint
o For each Stakeholder string, create a stakeholder with the string as the name
o Update the stakeholder property on the new viewpoint with the created stakeholder
o For each method string of the 1.3 viewpoint, create the operation «create»View() and append
the string to the body of a comment that annotates the operation.
• Blocks defined as specializations of SysML 1.3 QUDV::Unit do not require changes in SysML 1.4.
• Blocks defined as specializations of SysML 1.3 QUDV::QuantityKind do not require changes in SysML
1.4 except for the following:
o Blocks defined specializations of QUDV::SpecializedQuantityKind in SysML 1.3 become
corresponding Blocks defined as specializations of QUDV::QuantityKind in SysML 1.4.
o Usages of SysML 1.3 QUDV::SpecializedQuantityKind::general property become
corresponding usages of QUDV::QuantityKind::general in SysML 1.4.
D.2 Scope
The scope of this example is to provide at least one diagram for each SysML diagram type. The intent is to
select simplified fragments of the problem to illustrate how the diagrams can be applied, and to demonstrate
some of the possible inter-relationships among the model elements in the different diagrams. The sample
problem does not highlight all of the features of the language. The reader should refer to the individual clauses
for more detailed features of the language. The diagrams selected for representing a particular aspect of the
model, and the ordering of the diagrams are intended to be representative of applying a typical systems
engineering process, but this will vary depending on the specific process and methodology that is used.
D.4 Diagrams
D.4.1 Package Overview (Structure of the Sample Model)
As shown in Figure D.1, the HSUVModel is a package that represents the user model. The SysML Profile shall
be applied to this package in order to include stereotypes from the profile. The HSUVModel may also require
model libraries, such as the SI Units Types model library. The model libraries shall be imported into the user
model as indicated.
Figure D.1: Establishing the User Model by importing and applying SysML Profile & Model Library (Package
Diagram)
Figure D.2 details the specification of units and valueTypes employed in this sample problem.
Figure D.2: Defining value Types and units to be used in the Sample Problam
The package diagram (Figure D.3) shows the structure of the model used to evaluate the sample problem.
Model elements are contained in packages, and relationships between packages (or specific model elements) are
shown on this diagram. The relationship between the views (OperationalView and PerformanceView) and the
rest of the user model are explicitly expressed using the «import» relationship. Note that the «view» models
contain no model elements of their own, and that changes to the model in other packages are automatically
updated in the Operational and Performance Views.
Figure D.3: Establishing Structure of the User Model using Packages and Views (Package Diagram)
The term “context diagram,” in Figure D.4, refers to a user-defined usage of an internal block diagram, which
depicts some of the top-level entities in the overall enterprise and their relationships. The diagram usage enables
the modeler or methodologist to specify a unique usage of a SysML diagram type using the extension
mechanism described in Annex A, “Diagrams.” The entities are conceptual in nature during the initial phase of
development, but will be refined as part of the development process. The «system» and «external» stereotypes
are user defined, not specified in SysML, but help the modeler to identify the system of interest relative to its
environment. Each model element depicted may include a graphical icon to help convey its intended meaning.
The spatial relationship of the entities on the diagram sometimes conveys understanding as well, although this is
not specifically captured in the semantics. Also, a background such as a map can be included to provide
additional context. The associations among the classes may represent abstract conceptual relationships among
the entities, which would be refined in subsequent diagrams. Note how the relationships in this diagram are also
reflected in the Automotive Domain Model Block Definition Diagram, Figure D.15.
Figure D.4: Establishing the Context of the Hybrid SUV System using a User-Defined Context Diagram.
(Internal Block Diagram) Completeness of Diagram Noted in Diagram Description
The use case diagram for “Drive Vehicle” in Figure D.5 depicts the drive vehicle usage of the vehicle system.
The subject (HybridSUV) and the actors (Driver, Registered Owner, Maintainer, Insurance Company, DMV)
interact to realize the use case.
Goal-level Use Cases associated with “Operate the Vehicle” are depicted in the following diagram. These use
cases help flesh out the specific kind of goals associated with driving and parking the vehicle. Maintenance,
registration, and insurance of the vehicle would be covered under a separate set of goal-oriented use cases.
Figure D.6: Establishing Operational Use Cases for “Drive the Vehicle” (Use Case Diagram)
Figure D.7 shows the interactions between driver and vehicle that are necessary for the “Drive the Vehicle” Use
Case. This diagram represents the “DriveBlackBox” interaction, with is owned by the AutomotiveDomain
block. “BlackBox” for the purpose of this example, refers to how the subject system (HybridSUV block)
interacts only with outside elements, without revealing any interior detail.
The conditions for each alternative in the alt controlSpeed sub clause are expressed in OCL, and relate to the
states of the HybridSUV block, as shown in Figure D.8.
Figure D.8 depicts the operational states of the HSUV block, via a State Machine named
“HSUVOperationalStates.” Note that this state machine was developed in conjunction with the DriveBlackBox
interaction in Figure D.7. Also note that this state machine refines the requirement “PowerSourceManagment,”
which will be elaborated in the requirements sub clause of this sample problem. This diagram expresses only the
nominal states. Exception states, like “acceleratorFailure,” are not expressed on this diagram.
Figure D.8: Finite State Machine Associated with “Drive the Vehicle” (State Machine Diagram)
D.4.3.3 Sequence Diagram - Start Vehicle Black Box & White Box
Figure D.9 shows a “black box” interaction, but references “StartVehicleWhiteBox” (Figure D.10), which will
decompose the lifelines within the context of the HybridSUV block.
Figure D.9: Black Box Interaction for “StartVehicle,” referencing White Box Interaction (Sequence Diagram)
The lifelines on Figure D.10 (“whitebox” sequence diagram) need to come from the Power System
decomposition. This now begins to consider parts contained in the HybridSUV block.
The vehicle system specification contains many text based requirements. A few requirements are highlighted in
Figure D.11, including the requirement for the vehicle to pass emissions standards, which is expanded for
illustration purposes. The containment (cross hair) relationship, for purposes of this example, refers to the
practice of decomposing a complex requirement into simpler, single requirements.
Figure D.11: Establishing HSUV Requirements Hierarchy (containment) - (Requirements Diagram)
Figure D.12 shows a set of requirements derived from the lowest tier requirements in the HSUV specification.
Derived requirements, for the purpose of this example, express the concepts of requirements in the
HSUVSpecification in a manner that specifically relates them to the HSUV system. Various other model
elements may be necessary to help develop a derived requirement, and these model element may be related by a
«refinedBy» relationship. Note how PowerSourceManagement is “RefinedBy” the HSUVOperationalStates
model (Figure D.8). Note also that rationale can be attached to the «deriveReqt» relationship. In this case,
rationale is provided by a referenced document “Hybrid Design Guidance.”
Figure D.12: Establishing Derived Requirements and Rationale from Lowest Tier of Requirements Hierarchy.
(Requirements Diagram)
Figure D.13 focuses on the Acceleration requirement, and relates it to other requirements and model elements.
The “refine” relation, introduced in Figure D.12, shows how the Acceleration requirement is refined by a
similarly named use case. The Power requirement is satisfied by the PowerSubsystem, and a Max Acceleration
test case verifies the Acceleration requirement.
Figure D.14 contains two diagrams that show requirement containment (decomposition), and requirements
derivation in tabular form. This is a more compact representation than the requirements diagrams shown
previously.
Figure D.14: Requirements Relationships Expressed in Tabular Format (Table)
Figure D.15 provides definition for the concepts previously shown in the context diagram. Note that the
interactions DriveBlackBox and Stac4rtVehicleBlackBox (described in D.4.3, Elaborating Behavior (Sequence
and State Machine Diagrams)) are depicted as owned by the AutomotiveDomain block.
Figure D.16 defines components of the HybridSUV block. Note that the BrakePedal and WheelHubAssembly
are used by, but not contained in, the PowerSubsystem block.
Figure D.16: Defining Structure of the Hybrid SUV System (Block Definition Diagram)
D.4.5.3 Internal Block Diagram - Hybrid SUV
Figure D.17 shows how the top level model elements in the above diagram are connected together in the
HybridSUV block.
WheelHubAs s embly
P owerS ubs ys tem 0..1
0..1
0..1
B rakeP edal B atteryP ac k P owerC ontrolUnit E lec tric alP owerC ontroller F rontWheel
A c c elerator F uelT ankA s s embly InternalC ombus tionE ngine E lec tric MotorG enerator Differential
0..1
fp fi 4 trsm
Figure D.19 shows how the parts of the PowerSubsystem block, as defined in the diagram above, are used. It
shows connectors between parts, ports, and connectors with item flows. The dashed borders on FrontWheel and
BrakePedal denote the “use-not-composition” relationship depicted elsewhere in Figure D.16 and Figure D.18.
The dashed borders on Fuel denote a store, which keeps track of the amount and mass of fuel in the
FuelTankAssy. This is also depicted in Figure D.18.
Figure D.19: Internal Structure of the Power Subsystem (Internal Block Diagram)
Figure D.20: Blocks Typing Ports in the Power Subsystem (Block Definition Diagram)
Figure D.20 provides definition of the block that types the ports linked by connector c1 in Figure D.19.
D.4.6 Defining Ports and Flows
<<~InterfaceBlock>>
<<InterfaceBlock>> ~FS_ICE
«signal»
FS_ICE {original=FS_ICE} ICEData
flow properties flow properties
out engineData: ICEData in engineData: ICEData rpm: Integer
in mixture: Real out mixture: Real temperature: Real
in throttlePosition: Real out throttlePosition: Real isKnocking: Boolean
Figure D.21: Initially Defining Port Types with Flow Properties for the CAN Bus (Block Definition Diagram)
Figure D.22 continues the refinement of this Controller Area Network (CAN) bus architecture using ports. The
explicit structural allocation between the original connectors of Figure D.19 and this new bus architecture is
shown in Figure D.39.
The ports on the FuelTankAssembly and InternalCombustionEngine (as shown in Figure D.19) are defined in
Figure D.23.
Figure D.24 is a parametric diagram showing how fuel flowrate is related to FuelDemand and FuelPressure
value properties.
Figure D.25 shows how the connectors fuelDelivery and fdist on Figure D.19 have been expanded to include
design detail. The fuelDelivery connector is actually two connectors, one carrying fuelSupply and the other
carrying fuelReturn. The fdist connector inside the InternalCombustionEngine block has been expanded into the
fuel regulator and fuel rail parts. These more detailed design elements are related to the original connectors
using the allocation relationship. The Fuel store represents a quantity of fuel in the FuelTankAssy, which is
drawn by the FuelPump for use in the engine, and is refreshed, to some degree, by fuel returning to the
FuelTankAssy via the FuelReturnLine.
Figure D.26 defines the various model elements that will be used to conduct analysis in this example. It depicts
each of the constraint blocks/equations that will be used for the analysis, and key relationships between them.
Figure D.26: Defining Analyses for Hybrid SUV Engineering Development (Block Definition Diagram)
Figure D.27 shows the user-defined Performance Viewpoint, and the elements that populate the HSUV specific
PerformanceView. The PerformanceView itself may contain a number of diagrams depicting the elements it
contains.
Figure D.28 shows the Requirements and VnV viewpoint definitions with relationships to stakeholders,
concerns and views. The stakeholder and viewpoint share the same concern via comments that are shown
textually as values of the concern property. The comments could be shown graphically with annotation
relationships to stakeholders and viewpoints, if needed. Note that the value of the stakeholder property is an
instance of the stereotype not the class to which the stereotype is applied.
Figure D.28: Defining Requirements and VnV viewpoints (Package Diagram)
Figure D.29 shows the Requirements and VnV views and the model elements they expose. Note that the expose
relationship relies on the viewpoint method to identify the entire set of elements that appear in the view.
Figure D.30 shows the Requirements and VnV views and the supporting views that complete the description of
Requirements and VnV respectively for the Hybrid SUV.
Figure D.30: The Requirements and VnV views with supporting views (Package Diagram)
Measure of Effectiveness is a user defined stereotype. Figure D.31 shows how the overall cost effectiveness of
the HSUV will be evaluated. It shows the particular measures of effectiveness for one particular alternative for
the HSUV design, and can be reused to evaluate other alternatives.
Since overall fuel economy is a key requirement on the HSUV design, this example applies significant detail in
assessing it. Figure D.32 shows the constraint blocks and properties necessary to evaluate fuel economy.
Figure D.32: Establishing Mathematical Relationships for Fuel Economy Calculations (Parametric Diagram)
The StraightLineVehicleDynamics constraint block from Figure D.32 has been expanded in Figure D.33.
ConstraintNotes are used, which identify each constraint using curly brackets {}. In addition, Rationale has
been used to explain the meaning of each constraint maintained.
Figure D.33: Straight Line Vehicle Dynamics Mathematical Model (Parametric Diagram)
The constraints and parameters in Figure D.33 are detailed in Figure D.34 in Block Definition Diagram format.
Timing diagrams, while included in UML 2, are not directly supported by SysML. For illustration purposes,
however, the interaction shown in Figure D.35 was generated based on the constraints and parameters of the
StraightLineVehicleDynamics constraintBlock, as described in the Figure D.33. It assumes a constant 100hp at
the drive wheels, 4000lb gross vehicle weight, and constant values for Cd and Cf.
Figure D.35: Results of Maximum Acceleration Analysis (Timing Diagram)
Figure D.36 shows the top level behavior of an activity representing acceleration of the HSUV. It is the intent of
the systems engineer in this example to allocate this behavior to parts of the PowerSubsystem. It is quickly
found, however, that the behavior as depicted cannot be allocated, and must be further decomposed. The
stereotypes on the object nodes between actions in the figure apply to parameters of the behaviors or operations
called by the actions (see the notation for object nodes described in 11.3.1.4, ObjectNode, Variables, and
Parameters).
Figure D.37 defines a decomposition of the activities and objectFlows from the activity diagram in Figure D.36.
Figure D.37: Decomposition of “Accelerate” Function (Block Definition diagram)
Figure D.38 shows the ProvidePower activity, which includes Actions invoking the decomposed Activities and
ObjectNodes from Figure D.37. It also uses AllocateActivityPartitions and an allocation callout to explicitly
allocate activities and an object flow to parts in the PowerSubsystem block.
Note that the incoming and outgoing object flows for the ProvidePower activity have been decomposed. This
was done to distinguish the flow of electrically generated mechanical power and gas generated mechanical
power, and to provide further insight into the specific vehicle conditions being monitored.
Figure D.38: Detailed Behavior Model for “Provide Power” (Activity Diagram)
Note hierarchical consistency with Figure D.36.
Figure D.39 depicts a subset of the PowerSubsystem, specifically showing the allocation relationships generated
in Figure D.38.
Figure D.40 shows the same allocation relationships shown in Figure D.39, but in a more compact tabular
representation.
D.4.8.6 Internal Block Diagram: Property Values - EPA Fuel Economy Test
bdd [Package] HSUV Behavior [Figure B.37 Tabular Representation of Allocation from"Accelerate" Behavior Model to Power Subsystem]
Figure D.40: Tabular Representation of Allocation from “Accelerate” Behavior Model to Power Subsystem (Table)
Figure D.41 shows a particular Hybrid SUV (VIN number) satisfying the EPA fuel economy test. Serial
numbers of specific relevant parts are indicated.
Figure D.41: Special Case of Internal Block Diagram Showing Reference to Specific Properties (serial numbers)
E.2.2 Stereotypes
Enhanced Functional Flow Block Diagrams (EFFBD) are a widely-used systems engineering diagram, also
called a behavior diagram. Most of its functionality is a constrained use of UML activities, as described below.
This extension does not address replication, resources, or kill branches. Kill branches can be translated to
activities using interruptible regions and join specifications.
«effbd» UML4SysML::Activity (or N/A See below. Specifies that the activity
subtype of «nonStreaming» conforms to the constraints
below) necessary for EFFBD.
When the «effbd» stereotype is applied to an activity, its contents shall conform to the following constraints:
[1] (On Activity) Activities shall not have partitions.
[2] (On Activity) All decisions, merges, joins, and forks shall be well-nested. In particular, each decision
and merge shall be matched one-to-one, as are forks and joins, accounting for the output parameter sets
acting as decisions, and input parameters and control acting as a join.
«streaming» UML4SysML::Activity N/A The activity has at Used for activities that can
least one accept inputs or provide
streaming outputs after they start and
parameter. before they finish.
«nonStreaming» UML4SysML::Activity N/A The activity has Used for activities that
no streaming accept inputs only when
parameters. they start, and provide
outputs only when they
finish.
E.2.3 Stereotype Examples
Figure E.1 shows an example activity diagram with the «effbd» stereotype applied, translated from [Long. J.,
“Relationships between common graphical representations in system engineering,” 2002]. The stereotype
applies the constraints specified in E.2.2, Stereotypes, for example, that the data outputs on all functions are
required and that queuing is FIF.
Figure E.2 shows an example activity diagram with the «streaming» and «nonStreaming» stereotypes applied,
adapted from [MathWorks, “Using Simulink,” 2004]. It is a numerical solution for the differential equation x'(t)
= -2x(t) + u(t). Item types are omitted brevity. The «streaming» and «nonStreaming» stereotypes indicate which
subactivities take inputs and produce outputs while they are executing. They are simpler to use than the
{stream} notation on streaming inputs and outputs.
The example assumes a default of zero for the lower input to Add, and that the entire activity is executed with
clocked token flow, to ensure that actions with multiple inputs receive as many of them as possible before
proceeding. See the article referenced in E.2.1, Overview.
Figure E.2: Example activity with «streaming» and «nonStreaming» stereotypes applied to subactivities
E.3.2 Stereotypes
This non-normative extension includes stereotypes for a simplified requirements taxonomy that is intended to
be further adapted as required to support the particular needs of the application or organization. The
requirements categories in this example include functional, interface, performance, physical requirements, and
design constraints as shown in Table E.3. As shown in the table, each category is represented as a stereotype of
the generic SysML «requirement». The table also includes a brief description of the category. The table does
not include any stereotype properties or constraints, although they can be added as deemed appropriate for the
application. For example, a constraint that could be applied to a functional requirement is that only SysML
activities and operations can satisfy this category of requirement. Other examples of requirements categories
may include operational, specialized requirements for reliability and maintainability, store requirements,
activation, deactivation, and a high level category for stakeholder needs.
Some general guidance for applying a requirements profile is as follows:
• The categories should be adapted for the specific application or organization and reflected in the table.
This includes agreement on the categories and their associated descriptions, stereotype properties, and
constraints. Additional categories can be added by further subclassing the categories in the table below,
or adding additional categories at the pier level of these categories.
• The default requirement category should be the generic «requirement».
• Apply the more specialized requirement stereotype (functional, interface, performance, physical, design
constraint) as applicable and ensure consistency with the description, stereotype properties, and
constraints.
• A specific text requirement can include the application of more than one requirement category, in which
case, each stereotype should be shown in guillemets.
Table E.4 provides the definition of the non-normative enumerations that are used to type properties of
“extendedRequirement” stereotype of Figure E.3.
E.4.2 Stereotypes
Table E.5: Stereotypes for Measures of Effectiveness
E.5.2.1 AffineConversionUnit
Description
An AffineConversionUnit is a ConversionBasedUnit that represents a measurement unit that is defined with
respect to another reference measurement unit through an affine conversion relationship with a conversion
factor and offset.
The unit conversion relationship is defined by the following equation:
valueRU = factor · valueCU + offset
where:
valueRU is the quantity value expressed in the referenceUnit, and,
valueCU is the quantity value expressed in the AffineConversionUnit.
For example, in the definition of the AffineConversionUnit for “degree Fahrenheit” with respect to the
referenceUnit “degree Celsius,” the factor would be 5/9 and the offset would be -160/9, because
T
Celsius = 5/9 · TFahrenheit - 160/9 which is equivalent with TFahrenheit = 9/5 · TCelsius + 32/1
Properties
• factor: Number
Number that specifies the factor in the unit conversion relationship.
• offset: Number
Number that specifies the offset in the unit conversion relationship.
Description
A ConversionBasedUnit is an abstract classifier that is a Unit that represents a measurement unit that is defined
with respect to another reference unit through an explicit conversion relationship.
Properties
• referenceUnit: Unit
Specifies the unit with respect to which the ConversionBasedUnit is defined.
• inInvertible: Boolean
Specifies whether the unit conversion relationship is invertible. For LinearConversionUnit and
AffineConversionUnit this is always true.
Operations
[1] A ConversionBasedUnit transitively depends on its referenceUnit and all of the Units that its
referenceUnit depends on.
dependsOnUnits() : Unit[0..*] {unique}
body: referenceUnit.dependsOnUnits()->including(referenceUnit)->asSet()
E.5.2.3 DerivedQuantityKind
Description
A DerivedQuantityKind is a QuantityKind that represents a kind of quantity that is defined as a product of
powers of one or more other kinds of quantity. A DerivedQuantityKind may also be used to define a synonym
kind of quantity for another kind of quantity.
For example “velocity” can be specified as the product of “length” to the power one times “time” to the power
minus one, and subsequently “speed” can be specified as “velocity” to the power one.
Properties
• factor: QuantityKindFactor [1..*]
Set of QuantityKindFactor that specifies the product of powers of other kind(s) of quantity that define
the DerivedQuantityKind.
Operations
[1] A DerivedQuantityKind transitively depends on its factors' QuantityKinds and all of the QuantityKinds
that its factors' QuantityKinds depend on.
dependsOnQuantityKinds() : QuantityKind[0..*] {unique}
body: factor.quantityKind.dependsOnQuantityKinds()->flatten()->asSet()
->union(factor.quantityKind->flatten()->asSet())->asSet()
E.5.2.4 DerivedUnit
Description
A DerivedUnit is a Unit that represents a measurement unit that is defined as a product of powers of one or
more other measurement units.
For example the measurement unit “metre per second” for “velocity” is specified as the product of “metre” to
the power one times “second” to the power minus one.
Properties
• factor: UnitFactor [1..*]
Set of UnitFactor that specifies the product of powers of other measurement units that define the
DerivedUnit.
• hasReducedFactors : Boolean[1] = true
If true, the UnitFactors specifying the product of powers of other measurement units that define the
DerivedUnit cannot be simplified. If false, the DerivedUnit is non-reduced; some UnitFactors can be
simplified. A non-reduced DerivedUnit can have as a general unit other DerivedUnits defined in terms
of simplified UnitFactors, possibly in reduced form.
Operations
[1] A DerivedUnit transitively depends on its factors' Units and all of the Units that its factors' Units
depend on.
dependsOnUnits() : Unit[0..*] {unique}
body: factor.unit.dependsOnUnits()->flatten()->asSet()->union(factor.unit-
>flatten()
->asSet())->asSet()
[1] The query accessibleQuantityKinds() gives all the QuantityKinds directly defined in the
SystemOfQuantities or transitively in any included or used SystemOfQuantities.
allAccessibleQuantityKinds() : QuantityKind[0..*] {unique}
body: allAccessibleSystemOfQuantities()->collect(quantityKind)->flatten()-
>asSet()
inv SoU3_3:
getEffectiveSystemOfQuantities() = null or let aqk : Set(QuantityKind) =
getEffectiveSystemOfQuantities().allQuantityKinds() in ->allUnits()
->forAll(u | aqk>includesAll
(getKindOfQuantitiesForMeasurementUnit(u)))
E.5.2.5Dimension
A Dimension represents the [VIM] concept of “quantity dimension” that is defined as “expression of the
dependence of a quantity on the base quantities of a system of quantities as a product of powers of factors
corresponding to the base quantities, omitting any numerical factor.”
For example in the ISQ the quantity dimension of “force” is denoted by dim F = L·M·T-2, where “F” is the
symbol for “force,” and “L,” “M,” and “T” are the symbols for the ISQ base quantities “length,” “mass,” and
“time” respectively.
The Dimension of any QuantityKind can be derived through the algorithm that is defined in E.5.2.15,
SystemOfQuantities with SystemOfQuantities. The actual Dimension for a given QuantityKind depends on the
choice of baseQuantityKind specified in a SystemOfQuantities.
Properties
• symbolicExpression: String [0..1]
Symbolic expression of the quantity dimension's product of powers, in terms of symbols of the kinds of
quantity that represent the base kinds of quantity and their exponents. In tool implementations, the
symbolicExpression may automatically derived from the associated factor set.
E.5.2.6 GeneralConversionUnit
Description
A GeneralConversionUnit is a ConversionBasedUnit that represents a measurement unit that is defined with
respect to another reference measurement unit through a conversion relationship expressed in some syntax
through a general mathematical expression.
The unit conversion relationship is defined by the following equation:
valueRU / valueCU = f(valueRU, valueCU)
where:
valueRU is the quantity value expressed in the referenceUnit and
valueCU is the quantity value expressed in the GeneralConversionUnit and
f(valueRU, valueCU) is a mathematical expression that includes valueRU and valueCU
Properties
• expression: String
Specifies the unit conversion relationship in some expression syntax.
• expressionLanguageURI: String [0..1]
URI that specifies the language for the expression syntax.
E.5.2.7 LinearConversionUnit
Description
A LinearConversionUnit is a ConversionBasedUnit that represents a measurement unit that is defined with
respect to another measurement reference unit through a linear conversion relationship with a conversion factor.
The unit conversion relationship is defined by the following equation:
valueRU = factor · valueCU
where:
valueRU is the quantity value expressed in the referenceUnit, and,
valueCU is the quantity value expressed in the LinearConversionUnit.
For example, in the definition of the LinearConversionUnit for “inch” with respect to the referenceUnit
“metre,” the factor would be 254/10000, because 0.0254 metre = 1 inch.
Properties
• factor: Number
Number that specifies the factor in the unit conversion relationship.
E.5.2.8 Prefix
Description
A Prefix represents a named multiple or submultiple multiplication factor used in the specification of a
PrefixedUnit. A SystemOfUnits may specify a set of prefixes.
Properties
• symbol: String [0..1]
Short symbolic name of the prefix.
• factor: Rational [1]
Specifies the multiple or submultiple multiplication factor.
E.5.2.9 PrefixedUnit
Description
A PrefixedUnit is a ConversionBasedUnit that represents a measurement unit that is defined with respect to
another measurement reference unit through a linear conversion relationship with a named prefix that represents
a multiple or submultiple of a unit.
[VIM] defines “multiple of a unit” as “measurement obtained by multiplying a given measurement unit by an
integer greater than one” and “submultiple of a unit” as “measurement unit obtained by dividing a given
measurement unit by an integer greater than one.”
The unit conversion relationship is defined by the following equation:
valueRU = factor · valueCU
where:
valueRU is the quantity value expressed in the referenceUnit and
valueCU is the quantity value expressed in the PrefixedUnit.
For example, in the definition of the PrefixedUnit for “megabyte” with respect to the referenceUnit “byte,” the
prefix would be the Prefix for “mega” with a factor 106, because 106 byte = 1 megabyte.
See [VIM] for all decimal and binary multiples and decimal submultiples defined in SI.
Properties
• prefix: Prefix
Specifies the prefix that defines the name, symbol, and factor of the multiple or submultiple.
Constraints
[1] The referenceUnit shall not be a PrefixedUnit, i.e., it is not allowed to prefix an already prefixed
measurement unit. In general the referenceUnit should be a SimpleUnit.
package QUDV
context PrefixedUnit
inv: not referenceUnit.oclIsTypeOf(PrefixedUnit)
endpackage
Description
In QUDV, the concept of QuantityKind is an abstract specialization of SysML QuantityKind to support
designating a primary QuantityKind for a given Unit within the scope of a system of units and quantities and to
support a richer vocabulary for defining QuantityKinds.
Properties
• /dependsOnQuantityKinds : QuantityKind[0..*] {readOnly, unique}
The set of all QuantityKinds that this QuantityKind directly or indirectly depends on according to its
definition.
• general: QuantityKind[0..*] {unique}
A quantity can be defined to represent a combination of specific characteristics from one or more
aspects defined by general QuantityKinds (see ISO 80000-1, 3.2).
• isNumberOfEntities: Boolean = false
If true, indicates that the QuantityKind represents a number of entities (see ISO 80000-1, 3.8, Note 4).
•isQuantityOfDimensionOne: Boolean = false
If true, indicates that the QuantityKind has dimension one (see ISO 80000-1, 3.8).
Constraints
[1] A QuantityKind cannot be defined in terms of itself. This follows from the quantity calculus used for
expressing a derived QuantityKind in terms of base QuantityKinds chosen for a SystemOfQuantities by
means of non- contradictory equations (See ISO 80000-1, 4.3).
inv acyclic_quantity_kind_dependencies:
dependsOnQuantityKinds()->excludes(self)
Operations
[1] Abstract operation specified in SimpleQuantityKind and DerivedQuantityKind to calculate the value of
the derived property QuantityKind:/dependsOnQuantityKinds.
dependsOnQuantityKinds() : QuantityKind[0..*] {unique}
E.5.2.11 QuantityKindFactor
Description
A QuantityKindFactor represents a factor in the product of powers that defines a DerivedQuantityKind.
Properties
• exponent: Rational
Rational number that specifies the exponent of the power to which the quantityKind is raised.
• QuantityKind: QuantityKind
Reference to the QuantityKind that participates in the factor.
E.5.2.12 Rational
Description
A Rational value type represents the mathematical concept of a number that can be expressed as a quotient of
two integers. It may be used to express the exact value of such values, without issues of rounding or other
approximations if the result of the division were used instead.
Properties
• numerator: Integer
An integer number used to express the numerator of a rational number.
•denominator: Integer
An integer number used to express the denominator of a rational number.
Operations
package QUDV
context Rational
def: plus(r : Rational[1]) : Rational[1]
= result.numerator = self.numerator * r.demonimator
+ r.numerator * self.denominator
and result.denominator = self.denominator * r.denominator
context Rational
def: equivalent(r : Rational[1]) : Boolean[1]
= result = ( self.numerator * r.demonimator
= r.numerator * self.denominator)
context Rational
def: times(r : Rational[1]) : Rational[1]
= result.numerator = self.numerator * r.numerator
and result.denominator = self.denominator * r.denominator
endpackage
Constraints
[1] The denominator of a rational number shall not be zero.
package QUDV
context Rational
inv: denominator <> 0
endpackage
E.5.2.13 SimpleQuantityKind
Description
A SimpleQuantityKind is a QuantityKind that represents a kind of quantity that does not depend on any other
QuantityKind. Typically a base quantity would be specified as a SimpleQuantityKind.
Operations
[1] A SimpleQuantityKind does not depend on any other QuantityKind.
dependsOnQuantityKinds() : QuantityKind[0..*] {unique}
body: Set{}
Description
A SimpleUnit is a Unit that represents a measurement unit that does not depend on any other Unit. Typically a
base unit would be specified as a SimpleUnit.
Operations
[1] A SimpleUnit is a Unit that represents a measurement unit that does not depend on any other Unit.
Typically a base unit would be specified as a SimpleUnit.
dependsOnUnits() : Unit[0..*] {unique}
body: Set{}
E.5.2.15 SystemOfQuantities
Description
A SystemOfQuantities represents the [VIM] concept of “system of quantities” that is defined as a “set of
quantities together with a set of non-contradictory equations relating those quantities.” It collects a list of
QuantityKind that specifies the kinds of quantity that are known in the system.
The International System of Quantities (ISQ) is an example of a SystemOfQuantities, defined in [ISO31] and
[ISO/IEC80000].
Properties
• symbol: String [0..1]
Short symbolic name of the system of quantities.
• description: String [0..1]
Textual description of the system of quantities.
• definitionURI: String [0..1]
URI that references an external definition of the system of quantities. Note that as part of
[ISO/IEC80000] normative URIs for each of the ISQ quantities and SI units are being defined.
• quantityKind: QuantityKind [0..*] {ordered}
Ordered set of QuantityKind that specifies the kinds of quantity that are known in the system.
• baseQuantityKind: QuantityKind [0..*] {ordered, subsets quantityKind}
Ordered set of QuantityKind that specifies the base quantities of the system of quantities. This is a
subset of the complete quantityKind list. The base quantities define the basis for the quantity dimension
of a kind of quantity.
• /dimension: Dimension [0..*] {ordered, readOnly, nonunique}
Derived ordered set of Dimension. The actual dimension of a QuantityKind depends on the list of
baseQuantityKind that are specified in an actual SystemOfQuantities, see the
DerivedDimensions constraint.
• includedSystemOfQuantities: SystemOfQuantities[0..*] {unique}
Including a SystemOfQuantities means including all of the QuantityKind it defines and includes from
other SystemOfQuantities.
-- get the set of units, if any, that a given unit directly or indirectly depends
on
context Unit
def: allUnitDependencies : Set(Unit)
= self->closure(directUnitDependencies)
context Unit
inv acyclic_unit_dependencies
: not allUnitDependencies->excludes(self)
-- get the set of quantityKinds, if any, that a given quantityKind directly depends
on
context QuantityKind
def: directQKindDependencies : Set(QuantityKind)
= if oclIsKindOf(DerivedQuantityKind)
then oclAsType(DerivedQuantityKind).factor
->collect(quantityKind)->asSet()
else
if oclIsKindOf(SpecializedQuantityKind)
context QuantityKind
def: allQuantityKindDependencies : Set(QuantityKind)
= self->closure(directQKindDependencies)
context QuantityKind
inv acyclic_quantity_kind_dependencies
: allQuantityKindDependencies->excludes(self)
--context SystemOfQuantities::deriveQuantityKindDimensions() :
--post: quantityKind->forAll(qK|qK.hasProperDimension(self))
-- The derived dimension of a simple quantity kind must
-- have exactly one factor
-- whose numerator and denominator are equal to 1.
context SimpleQuantityKind
def: hasProperDimension(sq:SystemOfQuantities) : Boolean
= let d:Dimension=sq.getDimension(self)
in d.factor->size()=1
and d.factor->forAll(exponent->forAll(numerator=1 and denominator=1))
[2] For a QuantityKind to have a provenance to a single SystemOfQuantities, all included systems of
quantities
shall be transitively disjoint with all used systems of quantities.
[3] The set of all QuantityKinds in a given SystemOfQuantities shall be partitioned into two disjoint,
covering subsets: the set of base QuantityKinds (typically chosen to be mutually independent) and its
complement, the
set of derived QuantityKinds, each of which can be expressed in terms of the base QuantityKinds (See
ISO
80000-1, 4.3).
inv allBaseQuantitiesAreQuantities:
allQuantityKinds()->includesAll(allBaseQuantityKinds())
[4] Every QuantityKind shall be defined in only one SystemOfQuantities but it can be in the scope of
several SystemOfQuantities. A given QuantityKind is in scope of a SystemOfQuantities either because it is
defined or used in a SystemOfQuantities or because it is included from the scope of another
SystemOfQuantities.
inv singleProvenance:
includedSystemOfQuantities->collect(allQuantityKinds())
->intersection(quantityKind)->isEmpty()
[5] For a QuantityKind to have a provenance to a single SystemOfQuantities, the use and includes
relationships among SystemOfQuantities shall be acyclic.
inv acyclicProvenance:
allAccessibleSystemOfQuantities()->excludes(self)
Operations
[1] The query accessibleQuantityKinds() gives all the QuantityKinds directly defined in the
SystemOfQuantities or transitively in any included or used SystemOfQuantities.
allAccessibleQuantityKinds() : QuantityKind[0..*] {unique}
body: allAccessibleSystemOfQuantities()->collect(quantityKind)->flatten()-
>asSet()
[2] The query allAccessibleSystemOfQuantities() gives all the SystemOfQuantities directly or transitively
included or used.
allAccessibleSystemOfQuantities() : SystemOfQuantities[0..*] {unique}
body: self->closure(includedSystemOfQuantities-
>union(usedSystemOfQuantities))
->asSet()
[3] The query allBaseQuantityKinds() gives all the QuantityKinds directly adopted or transitively adopted
from any included SystemOfQuantities as base QuantityKinds.
allBaseQuantityKinds(): QuantityKind[0..*] {unique}
body: allIncludedSystemOfQuantities()->collect(baseQuantityKind)->flatten()-
>asSet()
->union(baseQuantityKind)->asSet()
[4] The query allIncludedSystemOfQuantities() gives all the SystemOfQuantities directly or transitively
included.
allIncludedSystemOfQuantities () : SystemOfQuantities[0..*] {unique}
body: self->closure(includedSystemOfQuantities)->asSet()
[5] The query allQuantityKinds() gives all the QuantityKinds in scope of a SystemOfQuantities; that is,
each QuantityKind is either directly defined in the SystemOfQuantities, selectively used from another
SystemOfQuantities or part of the scope of all the QuantityKinds included from another
SystemOfQuantities.
allQuantityKinds(): QuantityKind[0..*] {unique}
body: allIncludedSystemOfQuantities()->collect(quantityKind)->flatten()-
>asSet()
->union(quantityKind)->asSet())
E.5.2.16 SystemOfUnits
Description
A SystemOfUnits represents the [VIM] concept of “system of units” that is defined as “set of base units and
derived units, together with their multiples and submultiples, defined in accordance with given rules, for a given
system of quantities.” It collects a list of Units that are known in the system. A QUDV SystemOfUnits only
optionally defines multiples and submultiples.
Properties
• symbol: String [0..1]
Short symbolic name of the system of units.
• description: String [0..1]
Textual description of the system of units.
• definitionURI: String [0..1]
A URI that references an external definition of the system of units. Note that as part of [ISO/IEC80000]
normative URIs for each of the quantities in the ISQ and units in the SI are being defined.
• unit: Unit [0..*] {ordered}
Ordered set of Unit that specifies the units that are known in the system.
package QUDV
context SystemOfUnits
def: isCoherent() : Boolean =
baseUnit->size() = systemOfQuantities.baseQuantityKind->size()
and baseUnit
->forAll(bU|systemOfQuantities.baseQuantityKind
->one(bQK|bU.primaryQuantityKind=bQK))
and systemOfQuantities.baseQuantityKind
->forAll(bQK|baseUnit->one(bU|bQK=bU.primaryQuantityKind))
endpackage
[2] A coherent derived unit shall be a derived unit that, for a given system of quantities and for a chosen
set of base units, is a product of powers of base units with no other proportionality factor than one.
package QUDV
context SystemOfUnits
def: isCoherent(du : DerivedUnit) : Boolean =
baseUnit->includesAll(du.factor->collect(unit))
and du.factor->collect(exponent)
->forAll(numerator=1 and denominator=1)
endpackage
[3] In a well-formed SystemOfUnits, all of the prefixes of PrefixedUnits shall be defined in the
SystemOfUnits.
inv SoU3_1:
allPrefixes()->includesAll(allUnits()->select(oclIsTypeOf(PrefixedUnit))
->collect(oclAsType(PrefixedUnit).prefix))
[4] All the dependent Units of a SystemOfUnits shall be in the scope of that SystemOfUnits.
inv SoU3_2:
allUnits()->includesAll(allUnits()->collect(dependsOnUnits())->flatten()-
>asSet())
[5] All of the quantityKinds that are measurementUnits of Units in the SystemOfUnits shall be defined in
the systemOfQuantities of that SystemOfUnits.
inv SoU3_3:
getEffectiveSystemOfQuantities() = null or let aqk : Set(QuantityKind) =
getEffectiveSystemOfQuantities().allQuantityKinds() in ->allUnits()
->forAll(u | aqk
->includesAll(getKindOfQuantitiesForMeasurementUnit(u)))
[6] For a Unit to have a provenance to a single SystemOfUnits, all included systems of units shall be
transitively disjoint with all used systems of units.
inv includedSystemOfUnits_transitivelyDisjoint_usedSystemOfUnits:
allIncludedSystemOfUnits()->intersection(self.oclAsSet()
->closure(usedSystemOfUnits))->isEmpty()
[7] The set of all Units in a given SystemOfUnits shall be capable of being partitioned into two disjoint,
covering subsets: the set of base Units (typically chosen to be mutually independent) and all its
complement, the set of derived Units, each of which can be expressed in terms of the base Units (See ISO
80000-1, 6.4).
inv allBaseUnitsAreUnits:
allUnits()->includesAll(allBaseUnits())
inv singleProvenance:
includedSystemOfUnits->collect(allUnits())->intersection(unit)->isEmpty())
[9] For a Unit to have a provenance to a single SystemOfUnits, the use and includes relationships among
SystemOfUnits shall be acyclic.
inv acyclicProvenance:
allAccessibleSystemOfUnits()->excludes(self)
Operations
[1] The query accessibleQuantityKinds() gives all the QuantityKinds directly defined in the
SystemOfQuantities or transitively in any included or used SystemOfQuantities.
[2] The query allAccessibleSystemOfUnits() gives all the SystemOfUnits directly or transitively included
or used.
[3] The query accessibleUnits () gives all the units directly defined in a system of units or transitively in
any included or used system of units.
allAccessibleUnits(): Unit[0..*] {unique}
body: allAccessibleSystemOfUnits()->collect(unit)->flatten()->asSet()
[4] The query allBaseQuantityKinds() gives all the QuantityKinds directly adopted or transitively adopted
from any included SystemOfQuantities as base QuantityKinds in the effective SystemOfQuantities
associated to a SystemOfUnits.
[5] The query allBaseUnits() gives all the Units directly adopted or transitively adopted from any included
SystemOfUnits as base Units.
[6] The query allIncludedSystemOfUnits() gives all the SystemOfUnits directly or transitively included.
allMeasurementUnitsDefinedForSomeQuantityKind(): Boolean
body: allUnits()->select(quantityKind <> null)
[8] The query allPrefixes() gives all the Prefixes in scope of a SystemOfUnits; that is, each Prefix is either
directly defined in the SystemOfUnits or in any accessible SystemOfUnits.
getAdoptedQuantityKindForAdoptedBaseUnitOfMeasurementUnit (u : Unit) :
QuantityKind[0..1]
body: let bu : Unit = getAdoptedBaseUnitForMeasurementUnit(u) in
if (bu = null) then Set{}
else let qks : Set(QuantityKind) = getKindOfQuantitiesForMeasurementUnit(bu)
in
allBaseQuantityKinds()->intersection(qks)
endif
E.5.2.17 Unit
Description
In QUDV, the concept of Unit is an abstract specialization of SysML Unit to support designating a primary
QuantityKind for a given Unit within the scope of a system of units and quantities and to support a richer
vocabulary for defining Units.
Properties
• /dependsOnUnits : Unit[0..*] {readOnly, unique}
The set of all Units that this Unit directly or indirectly depends on according to its definition.
• general: Unit[0..*] {unique}
A Unit can be defined as a specialization of zero or more Units. This capability is important for
specifying the meaning of a unit for a quantity of dimension one (see ISO 80000-1, 3.8 and 3.10).
• isUnitCountOfEntities: Boolean = false
If true, indicates that the measurement unit represents a number of entities (see ISO 80000-1, 3.10,
Note 3).
•isUnitForQuantityOfDimensionOne: Boolean = false
If true, indicates that the corresponding QuantityKind has dimension one (see ISO 80000-1, 3.8).
Constraints
[1] A Unit cannot be defined in terms of itself. This follows from the requirement that, in a coherent
SystemOfUnits, the Units of all derived QuantityKinds are expressed in terms of the base Units in
accordance with the equations in the SystemOfQuantities (see ISO 80000-1, 6.4).
inv acyclic_unit_dependencies:
dependsOnUnits()->excludes(self)
E.5.2.18 UnitFactor
Description
A UnitFactor represents a factor in the product of powers that defines a DerivedUnit.
Properties
• exponent: Rational
Rational number that specifies the exponent of the power to which the unit is raised.
• unit: Unit
Reference to the Unit that participates in the factor.
E.5.3 References
[VIM]
JCGM 200:2012, International vocabulary of metrology - Basic and general concepts and associated terms
(VIM), 3rd edition (JCGM 200:2008 with minor corrections), 2012, BIPM, Paris, France. http://www.bipm.org/
utils/common/documents/jcgm/JCGM_200_2012.pdf.
[ISO/IEC80000]
ISO/IEC 80000, Quantities and units. 15 parts, some published, some still in progress, harmonized replacement
of [ISO31] and [IEC60027], the new international system of quantities and units.
[ISO31]
ISO 31, Quantities and units (Third edition 1992-08-01). Specifies the international system of units - SI - in 14
parts.
[IEC60027]
IEC 60027-2:2005, Letter symbols to be used in electrical technology - Part 2: Telecommunications and
electronics (Third edition 2005-08).
[SI-Brochure]
Le Système international d'unités (SI) / The International System of Units (SI), 8th edition 2006, BIPM, (French
and English). Available for download in PDF format from http://www.bipm.org/en/si/si_brochure.
[NIST330]
The International System of Units (SI), NIST Special Publication 330, 2008 Edition. NOTE: U.S. version of the
English language text of [SI-Brochure].
Available for download in PDF format from http://physics.nist.gov/cuu/Units/bibliography.html.
[NIST822]
Guide for the Use of the International System of Units (SI), NIST Special Publication 811, 2008 Edition.
Available for download in PDF format from http://physics.nist.gov/cuu/Units/bibliography.html.
[Dybkaer-2010] Rene Dybkaer, “ISO terminological analysis of the VIM3 concepts of ‘quantity’ and ‘kind-of-
quantity’”, Metrologia 47, (2010) 127-143, http://dx.doi.org/10.1088/0026-1394/47/3/003. See also:
http://www.bipm.org/en/publications/guides/rationale_vim3.html.
Figure E.8 shows an approach for defining base units of the System International of Units defined in
http://www.bipm.org/en/si/si_brochure/chapter2/2-1/ and http://physics.nist.gov/cuu/Units/units.html. This
approach involves instantiating the concrete classes of Unit shown in Figure E.6.
Figure E.9 diagram shows the definition of “newton” as a DerivedUnit (E.5.2.4) corresponding to the “force”
DerivedQuantityKind (E.5.2.3). Derived units and quantity kinds are defined as products of factors on other
units and quantity kinds respectively. In the QUDV, the product factors of a DerivedUnit (resp.
DerivedQuantityKind) are all of the UnitFactor (resp. DerivedUnitFactor) at the “factor” ends of association
link instances.
bdd [package] ISO-80000-1-QUDV Diagram [ Example of QUDV definitions for base units and quantities from ISO 80000-1 Quantities and Units Part 1 ]
unit primaryQuantityKind
kilogram : PrefixedUnit mass : SimpleQuantityKind quantityKind
kilo : Prefix
factor = 1.0E3
prefix prefix referenceUnit
name = "kilo" quantityKind
symbol = "k" gram : SimpleUnit
name = "gram"
unit symbol = "g"
Figure E.8: Base Unit and Quantity Kinds of the SI and ISQ respectively
newton : DerivedUnit
unit unit unit
name = "newton"
metre : SimpleUnit kilogram : PrefixedUnit second : SimpleUnit
symbol = "N"
name = "metre" name = "kilogram" name = "second"
symbol = "m" prefix = kilo symbol = "s"
referenceUnit = gram
symbol = "kg"
Figure E.10 shows a simple model of the length of a spring defined as the linear distance between the linear
position of its two flange ends. QUDV supports defining arbitrary systems of units and quantities. Although this
example uses only one unit, “metre” and one quantity kind, “lengthQK;” this example illustrates specialized
value types to make additional distinctions such as “LinearPosition” vs. “LinearDistance,” two distinct
quantities that have the same unit and quantity kind. This example illustrates an instance of a spring and uses the
dot pathname property notation defined for IBDs (8.3.1.2, Internal Block Diagram) to clearly indicate the role
of each instance specification.
bdd [package] SpringExample [ Spring Length Example ]
«block»
«ValueType» «block»
Spring
spring1.a.pos : LinearPosition spring1.a : Flange
constraints
value = 8.0 position = spring1.a.pos {unit = metre} springLength : SpringLength
parts
a : Flange
«ValueType» «block» b : Flange
spring1.b.pos : LinearPosition spring1.b : Flange values
value = 50.0 position = spring1.b.pos {unit = metre} length : LinearDistance{unit = metre}
«ValueType» «constraint»
spring1.length : LinearDistance «block» SpringLength
spring1 : Spring constraints
value = 42.0
a = spring1.a {length.value = | a.position.value - b.position.value |}
b = spring1.b parameters
«constraint» length = spring1.length {unit = metre} a : Flange
springLength = spring1.springLength b : Flange
spring1.springLength : SpringLength length : LinearDistance
E.6 Model Library of SysML Quantity Kinds and Units for ISO
8000
E.6.1 Overview
This non-normative extension defines a model library of SysML QuantityKind and Unit definitions for a subset
of quantities and units defined by the International System of Quantities (ISQ) and the International System of
Units (SI). The specific quantities and units in this library are defined by ISO 80000-1 Quantities and units -
Part1: General. ISO/IEC 80000 currently has fourteen parts that define many quantities and units for use within
various fields of science and technology. Part 1 defines base quantities and units used by other parts as well as a
starting set of derived quantities and units with special names and symbols.
Figure E.11: Model libraries of SysML Quantity Kinds and Units for the covered content of ISO 80000 parts
3,4,5,6,7,9,10 and 13
pkg [Package] ISO80000 [SysML Quantity Kinds and Units for the covered content of ISO 8000]
Figure E.12: Organization of the definitions of units and quantities from the normative parts of ISO 80000
covered in SysML 1.4, which includes all the normative content of parts 3,4,5,6; the subset of parts 7,9,10
corresponding to the content from SysML 1.3 and the subset of part 13 pertaining to commonly used units of
Figure E.13: Content relationships for the systems of units and quantities in from the different parts of ISO 80000
in relation to ISO 80000 as a whole and to the International System of Units (SI) and quantities (ISQ)
bdd [Package] ISO80000 [Table 1 (from ISO 80000-1) SI base units for the ISQ base quantities]
Figure E.14: Table 1 (from ISO 80000-1) SI base units for the ISQ base quantities
Figure E.15: Table 2 (from ISO 80000-1) ISQ derived quantities and SI derived units with special names (1)
bdd [Package] ISO80000 [Table 2b – SI derived units with special names and symbols]
Figure E.16: Table 2 (from ISO 80000-1) ISQ derived quantities and SI derived units with special names (2)
Figure E.17: Table 2 (from ISO 80000-1) ISQ derived quantities and SI derived units with special names (3)
bdd [Package] ISO80000 [Table – SI derived units with special names and symbols admitted for safeguarding human health]
Figure E.18: Table 3 (from the SI brochure) SI derived units with special names and symbols
Figure E.19: Constant numbers used throughout the SysML ISO 80000 library
Figure E.20: Example of value type definitions for a quantity and applicable units and prefixed units
All 25 entries (including sub-entries) in the normative contents of ISO 80000-3 are modeled as summarized
below.
radian per second ISO 80000-3, 3-10.a, rad/s ISO 80000-3, ISO 80000-3,
3-16.a 3-15.b, 3-16.b, 3-10 [5]
3-23.\a [4\]
number of turns per ISO 80000-3, 3-15.b s-1 ISO 80000-3, ISO 80000-3,
second 3-15.b, 3-16.b 3-15.2 [6]
time constant for an ISO 80000-3, 3-13 ISO 80000-3, 3-7 [5]
exponentially varying
quantity t ,( T )
group velocity ISO 80000-3, 3-20.2 cg, vg ISO 80000-3, 3-8.1 [5]
logarithmic decrement for ISO 80000-3, 3-24 Λ ISO 80000-3, 3-23 [6] VRAI
an exponentially varying
quantity
All 37 entries (including sub-entries) in the normative contents of ISO 80000-4 are modeled as summarized
below.
cubic metre ISO 80000-4, 4-16.a ISO 80000-4, ISO 80000-4, VRAI
strain factor 4-16.a [7] 4-16.3 [11]
metre strain factor ISO 80000-4, 4-16.a ISO 80000-4, ISO 80000-4, VRAI
4-16.a [7] 4-16.1 [11]
Table E.12: Normative units in ISO 80000-4 (2 of 2)
cubic metre strain ISO 80000-4, 4-19.a ISO 80000-4, ISO 80000-4,
factor per pascal -1 4-19.a [8] 4-19 [11]
Pa
metre per second ISO 80000-4, 4-23.a ISO 80000-3, ISO 80000-4, FAUX
per metre 3-15b, 3-16b, 4-23 [13]
3-23.a [4]
pascal second ISO 80000-4, 4-24.a m 2/s ISO 80000-4, ISO 80000-4,
kilogram per cubic 4-24.a [8] 4-24 [13]
metre
mass density of a ISO 80000-4, 4-2, 4-3 ISO 80000-4, 4-24 [10]
reference substance
r0
bending moment of force ISO 80000-4, 4-13.3 ISO 80000-4, 4-13.1 [10]
Mb
radial distance from a Q- ISO 80000-4, 4-20.1 ISO 80000-3, 3-1.6 [5]
axis in the plane of the
surface considered rQ
radial distance from a Q- ISO 80000-4, 4-20.2 ISO 80000-3, 3-1.6 [5]
axis perpendicular to the
plane of the surface rQ
considered
maximum radial distance ISO 80000-4, 4-21 ISO 80000-4, 4-20.1 [11]
from a Q-axis in the plane
of the surface considered I Q, max
contact force between two ISO 80000-4, 4-22 ISO 80000-4, 4-22 [12]
sliding bodies
contact force between two ISO 80000-4, 4-22 F ISO 80000-4, 4-9.1 [10]
bodies
normal component of the ISO 80000-4, 4-22 ISO 80000-4, 4-22 [13]
contact force between two
sliding bodies
maximum contact force ISO 80000-4, 4-22 ISO 80000-4, 4-22 [12]
between two bodies
Fmax
contact force between two ISO 80000-4, 4-22 ISO 80000-4, 4-22 [12]
bodies at rest
normal component of the ISO 80000-4, 4-22 ISO 80000-4, 4-22 [13]
contact force between two
bodies at rest
normal component of the ISO 80000-4, 4-22 ISO 80000-4, 4-22 [12]
contact force between two
bodies
ms , ( fs )
length of line element in a ISO 80000-4, 4-25 ISO 80000-3, 3-1.1 [5]
surface
Contact force between two bodies is an example of a taxonomy of specialized quantity kinds induced by
different measurement procedures.
All 33 entries (including sub-entries) in the normative contents of ISO 80000-5 are modeled as summarized
below.
pascal ratio per ISO 80000-5, 5-3.3 ISO 80000-5, ISO 80000-5,
kelvin -1 5-3.a [15] 5-3.1 [17]
K
cubic metre ratio ISO 80000-5, 5-5.a ISO 80000-4, ISO 80000-5,
per pascal -1 4-19.a [8] 5-5.1 [17]
Pa
watt square metre ISO 80000-5, 5-14.a ISO 80000-4, ISO 80000-5,
per joule 2 4-24.a [8] 5-14 [18]
W ×m / J
kelvin joule per ISO 80000-5, 5-20.a ISO 80000-4, ISO 80000-5, FAUX
kelvin 4-27.a, 4-34.a, 5-20.
J 4-36.a [8] [45]
[19]
pascal cubic metre ISO 80000-5, 5-20.a ISO 80000-4, ISO 80000-5,
3 4-27.a, 4-34.a, 5-20.3 [19]
Pa ×m 4-36.a [8]
kelvin joule per ISO 80000-5, 5-21.a ISO 80000-5, ISO 80000-5, FAUX
kelvin kilogram 5-21.a [16] 5-21.5 [20]
J/K
cT
cS
Quantity Kind Description Symbol General is dimension
name 1?
heat flow rate ISO 80000-5, 5-7 ISO 80000-4, 4-26 [13]
F
surface density of heat ISO 80000-5, 5-8 ISO 80000-5, 5-8 [18]
flow rate q,f
K , ( k)
G, ( H )
specific heat capacity at ISO 80000-5, 5-16.2 ISO 80000-5, 5-16.1 [18]
constant pressure
cp
specific heat capacity at ISO 80000-5, 5-16.3 cV ISO 80000-5, 5-16.1 [18]
constant volume
specific heat capacity at ISO 80000-5, 5-16.4 ISO 80000-5, 5-16.1 [18]
saturation csat
mass of water irrespective ISO 80000-5, 5-24 ISO 80000-4, 4-1 [10]
of the form of aggregation m
total volume of water and ISO 80000-5, 5-24 ISO 80000-3, 3-4 [5]
dry matter
V
mass of water vapour ISO 80000-5, 5-24 ISO 80000-5, 5-24 [20]
m
mass of water vapour at ISO 80000-5, 5-25 ISO 80000-5, 5-24 [20]
saturation
msat
mass of dry matter ISO 80000-5, 5-26 ISO 80000-4, 4-1 [10] VRAI
md
mass ratio of water to dry ISO 80000-5, 5-26 ISO 80000-5, 5-26 [20] VRAI
gas at saturation
usat
mass ratio of water ISO 80000-5, 5-27 ISO 80000-5, 5-26 [20] VRAI
vapour to dry gas w
mass ration of water ISO 80000-5, 5-27 ISO 80000-5, 5-27 [20] VRAI
vapour to dry gas at
saturation wsat
Table E.23: Normative quantity kinds in ISO 80000-5 (5 of 5)
mass of dry gas ISO 80000-5, 5-27 ISO 80000-5, 5-26 [20]
md
wH O
2
mass fraction of dry ISO 80000-5, 5-29 ISO 80000-5, 5-28 [21] VRAI
matter
wd
partial pressure of a gas ISO 80000-5, 5-30 ISO 80000-4, 4-15.1 [10]
in a mixture p
relative partial pressure of ISO 80000-5, 5-30 ISO 80000-5, 5-3.3 [17] VRAI
a gas
dew point thermodynamic ISO 80000-5, 5-33 ISO 80000-5, 5-33 [21]
temperature of humid air
Td
All 62 entries (including sub-entries) in the normative contents of ISO 80000-6 are modeled as summarized
below.
coulomb per square IEC 80000-6, 6-7.a IEC 80000-6, IEC 80000-6,
metre per second 6-8.a [22] 6-8 [27]
(
C / m ×s 2
)
coulomb per metre IEC 80000-6, 6-7.a IEC 80000-6, IEC 80000-6,
squared 2 6-4.a [22] 6-7 [27]
C/m
Unit name Description Symbol General units Quantity is unit for is
Kinds quantity of reduced
dimension form?
1?
coulomb per metre IEC 80000-6, 6-9.a IEC 80000-6, IEC 80000-6,
per second 6-25.a [23] 6-9 [27]
C / ( m ×s )
farad volt per metre IEC 80000-6, 6-12.a IEC 80000-6, IEC 80000-6,
squared 2 6-7.a [22] 6-12 [27]
F ×V / m
farad per metre IEC 80000-6, 6-14.a IEC 80000-6, IEC 80000-6,
6-14.a [22] 6-14.1 [27]
F/m
volt ampere per IEC 80000-6, 6-34.a ISO 80000-5, IEC 80000-6,
square metre 2 5-8.a [15] 6-34 [29]
N ×A / m
watt per volt per IEC 80000-6, 6-58.a IEC 80000-6, VRAI
ampere 6-58 [30]
second joule per IEC 80000-6, 6-62.a s.J/s ISO 80000-4, IEC 80000-6, FAUX
second 4-27.a, 4-34.a, 6-62 [31]
4-36.a [8]
electric current in a thin IEC 80000-6, 6-1 IEC 80000-6, 6-1 [27]
conducting loop n
In
Quantity Kind Description Symbol General is dimension
name 1?
r , rV
r A ,s
r l ,t
areic electric current IEC 80000-6, 6-8 IEC 80000-6, 6-8 [27]
J
Js
U ,U ab
U ,U ab
electric flux density IEC 80000-6, 6-12 IEC 80000-6, 6-7 [27]
D
electric flus density in IEC 80000-6, 6-12 IEC 80000-6, 6-12 [27]
vacuum
Quantity Kind Description Symbol General is dimension
name 1?
e0
er
ID
I tot ,I t
total current density IEC 80000-6, 6-20 IEC 80000-6, 6-8 [27]
J tot ,J t
linked flux in a loop IEC 80000-6, 6-22.2 IEC 80000-6, 6-22.2 [28]
caused by an electric
current in that loop c m,c
linked flux in a loop m IEC 80000-6, 6-22.2 IEC 80000-6, 6-22.2 [28]
caused by an electric c
current in another loop n
M,Hi
Quantity Kind Description Symbol General is dimension
name 1?
magnetic field strength in IEC 80000-6, 6-25 IEC 80000-6, 6-25 [28]
vacuum
H0
m0
mr
k ,( c m )
Jm
jm ,j
Hc,B
energy density of electric IEC 80000-6, 6-33 IEC 80000-6, 6-33 [29]
field
phase speed of light in IEC 80000-6, 6-35.2 IEC 80000-6, 6-35.1 [29]
vacuum
c0
Us
scalar magnetic potential IEC 80000-6, 6-37.1 IEC 80000-6, 6-1 [27]
Vm,f
Quantity Kind Description Symbol General is dimension
name 1?
Um
Fm
Rm,R
L,Lm
Lmn
initial phase of electric IEC 80000-6, 6-48 ISO 80000-3, 3-5 [5]
voltage
fu
initial phase of electric IEC 80000-6, 6-48 ISO 80000-3, 3-5 [5]
current
fi
electric current phasor IEC 80000-6, 6-49 IEC 80000-6, 6-1 [27]
I
loss angle IEC 80000-6, 6-55 ISO 80000-3, 3-5 [5] VRAI
d
The subset of the normative contents of ISO 80000-7 is identical to that of SysML 1.4 as summarized below.
speed of light in vacuum ISO 80000-7, 7-4.1 ISO 80000-3, 3-8.1 [5]
c0
phase speed of light in ISO 80000-7, 7-4.2 ISO 80000-3, 3-8.2 [5]
medium c
F v ,( F )
I v,( I )
Ev, ( E )
Lv, ( L )
The subset of the normative contents of ISO 80000-9 is identical to that of SysML 1.4 as summarized below.
The 3 units and 3 quantity kind definitions included were in the non-normative ISO 80000-10 library of SysML
1.3.
SysML 1.4 adds commonly used 3 units (bit, byte and octet) of information and 3 of their associated quantity
kinds.
E.7.2 Stereotypes
0 dry 0 0 wet 0
10 dry 4 10 wet 6
20 dry 17 20 wet 22
30 dry 38 30 wet 50
40 dry 67 40 wet 89
The input/output parameter relationship or constraint can be specified in equation form, such as in the following
example:
Stopping distance <= (1/(2*32.174* alpha)*(580*Initial Speed/3600^2)
State Speed = 0 ...100
alpha
dry 0,8
wet 0,6
More generally, the input and output parameter values may be complex functions of other parameters, and may
have probability distributions associated with them.
This annex addresses mechanisms and approaches for building SysML profiles to enable property-based
requirements. While examples of property-based requirement profiles are provided in this annex, these are not
to be considered normative or even authoritative. Instead, they are intended to be illustrative of the kind of
extensions that some users may find desirable. Ultimate responsibility for the compatibility of any property-
based requirement profile with a particular requirements management process or toolset rests fully with the user.
Figure E.24 shows use of both «abstractRequirement» and «constraintBlock» to define a new PBR stereotype,
named RequirementConstraintBlock in this example for clarity.
«stereotype»
A bs trac tRequiremen t
attributes
+Text : String [1]
+Id : String [1]
+/derived : AbstractRequirement [*] «stereotype»
+/derivedFrom : AbstractRequirement [*] C ons traintBloc k
+/satisfiedBy : NamedElement [*]
+/refinedBy : NamedElement [*]
+/tracedTo : NamedElement [*]
+/verifiedBy : NamedElement [*]
+/master : AbstractRequirement
«stereotype»
Requiremen tConstraintB loc k
Basing PBR on ConstraintBlock provides flexibility in expressing the name of required numerical values as
ConstraintParameters, which can be typed by ValueTypes and related to properites or parameters of other model
elements using binding connectors. Textual requirement statements may be restated as constraint expressions
The following example leverages the above PBR user profile based on ConstraintBlock to specify and evaluate
the weight of a vehicle.
The requirement is captured via a PBR (RequirementConstraintBlock), which includes a constraint expression
that reflects the textual requirements statement in terms of two defined parameters, actualMass and
requiredMass. Both of these parameters are typed by the kilogram value type from the SI value types library.
The required value for mass is expressed as a default value of the requiredMass parameter. Note that the
required value may have alternatively been expressed as a second constraint expression, e.g., {requiredMass =
1450}. The vehicle itself is represented in the model by a block with a value property for mass, also typed by
the kilogram SI value type.
As shown in Figure E.25, the context for evaluating if the requirement has been met is established using a
Requirement Context block. This method of context setting is a best practice that is not essential to this
example. Both the Vehicle and the Vehicle Mass Requirement are used in this Requirement Context.
«block» «block»
R equirement C ontext v01 V eh ic le
values
vehicleMass : mass[kilogram]
r1.01
«RequirementConstraintBlock»
Vehicle Mass R equirement
cons traints
{actualMass ≤ requiredMass}
Id = "1"
Text = "The vehicle mass shall be less than
or equal to 1450 kilograms"
parameters
actualMass : mass[kilogram]
requiredMass : mass[kilogram] = 1450
Figure E.25: Example of Requirement Evaluation Context Using PBR Based on Constraint Block
Figure E.26 shows a parametric diagram of the Requirement Context block, useful for establishing the method
of evaluating compliance of the vehicleMass value with the Vehicle Mass Requirement. As with any parametric
model, it does not actually perform the evaluation/analysis, but it does specify the key relationships so that an
evaluation tool may determine if the weight requirement has been met.
par [Block] Requirement Context [ vehicle mass evaluation ]
actualMass requiredMass
Default Value = 1450.0
Figure E.26: Example of Parametric Diagram Using PBR based on Constraint Block
Figure E.27 shows use of both «abstractRequirement» and «constraint» to define a new PBR stereotype, named
CbRequirement in this example.
Figure E.28 shows how requirements are specified on the model representing a specification. Note that, as
modeled here, the requirement represented by Constraint2 applies to any instance of the Vehicle block while the
one represented by Constraint1 applies to instances of Vehicle block which are “used” as defined by the
“vehicle” role of the Context block, such as the design weight of the vehicle on a bridge or vehicle transporter.
Figure E.29 shows a particular case where testedVehicle is an instance of the Vehicle block and AnalysisContext
an instance of the Context block, as specified above. A simple evaluation of model constraints using a classical
OCL evaluator would produce a report showing that Requirement/Constraint2 is met, while
Requirement/Constraint1 is violated.
Figure E.29: Establishing an Analysis Context for evaluating requirement compliance using PBR based on
Constraint
«stereotype» «stereotype»
A bs trac tR equirement B loc k
«comment» [NamedElement] [Class]
New in SysML attributes
1.5 id
text
«stereotype» «stereotype»
«comment» R equirement PB R «comment»
SysML 1.4 [Class] [Class] User defined
Property Based
Requirement
stereotype
Figure E.31 gives an example where a requirement element “Max Peak Power Requirement is created. It
defines “id,” “text,” and “maxPeakPwr.”
It also has additionally a constraint property “maxPower” which permits to define constraints for the value
properties. The requirement is contextualized in the block “System Specification.” The block “Verification
Context” contextualizes the block “System Design” which holds the as-designed “totalPower” value property. In
this context the as-designed value is bound to the requirement constraint for the purpose of analysis to verify
that the designed value satisfies the required value.
AP233 includes support for assigning program management information as well as system modeling
information to systems engineering data.
Program management capabilities include issue management, risk management and aspects of project
management such as project breakdown, project resource information, organization structure, schedule, and
work structure.
G.4.3 EXPRESS
AP233, like all STEP application protocols, is defined using the EXPRESS modeling language. EXPRESS is a
precise text-based information modeling language with a related graphical representation called EXPRESS-G.
An example of the text-based format follows:
SCHEMA Ap233_systems_engineering_arm_excerpt;
ENTITY Product;
id : STRING;
name : STRING;
description : OPTIONAL STRING;
END_ENTITY;
ENTITY Product_version;
id : STRING;
description : OPTIONAL STRING;
of_product : Product;
END_ENTITY;
ENTITY Product_view_definition;
id : OPTIONAL STRING;
name : OPTIONAL STRING;
additional_characterization : OPTIONAL STRING;
initial_context : View_definition_context;
additional_contexts : SET [0:?] OF View_definition_context;
defined_version : Product_version;
WHERE
WR1: NOT (initial_context IN additional_contexts);
WR2: EXISTS(id) OR (TYPEOF(SELF\Product_view_definition) <> TYPEOF(SELF));
END_ENTITY;
ENTITY View_definition_context;
application_domain : STRING;
life_cycle_stage : STRING;
description : OPTIONAL STRING;
WHERE
WR1: (SIZEOF (USEDIN(SELF, 'AP233_SYSTEMS_ENGINEERING_ARM_EXCERPT.' +
'PRODUCT_VIEW_DEFINITION.INITIAL_CONTEXT')) > 0) OR
(SIZEOF (USEDIN(SELF, 'AP233_SYSTEMS_ENGINEERING_ARM_EXCERPT.' +
'PRODUCT_VIEW_DEFINITION.ADDITIONAL_CONTEXTS')) > 0);
END_ENTITY;
ENTITY System
SUBTYPE OF (Product);
END_ENTITY;
ENTITY System_version
SUBTYPE OF (Product_version);
SELF\Product_version.of_product : System;
END_ENTITY;
END_SCHEMA;
EXPRESS expressions are similar in nature to OCL expressions and the two languages have similar
expressiveness. EXPRESS has also been approved as an OMG standard with a September 2009 publication of
Version 1.0 of the Reference Metamodel for the EXPRESS Information Modeling Language Specification. This
will enable the use of OMG Model Driven Architecture technologies against AP233 and other STEP models
written in EXPRESS.