Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Reformulate Constraints for V3.0 #85

Merged
merged 16 commits into from
Jun 29, 2023
Merged

Reformulate Constraints for V3.0 #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
19401e4
Reformulate: AASd-006
Jun 7, 2023
9ea21ba
Reformulate: AASd-007
Jun 7, 2023
1a2d6c0
Reformulate: AASd-012
Jun 7, 2023
b6977ae
Reformulate: AASd-020
Jun 7, 2023
10adf3d
Reformulate: AASd-109
Jun 7, 2023
f0ea298
Reformulate: AASd-115
Jun 7, 2023
d64e50a
Reformulate: AASd-118
Jun 7, 2023
04f0d94
Reformulate: AASd-121
Jun 7, 2023
4d37ef2
Reformulate: AASd-122
Jun 7, 2023
a73d32a
Reformulate: AASd-123
Jun 7, 2023
e8b8336
Reformulate: AASd-124
Jun 7, 2023
b807c75
Reformulate: AASd-125
Jun 7, 2023
3bc192f
Reformulate: AASd-126
Jun 7, 2023
be6e9a2
Reformulate: AASd-127
Jun 7, 2023
f8e9331
Undo remove of WIP information in `constraint.rst`
Jun 27, 2023
0bfa749
Clean up all constraints
Jun 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 32 additions & 30 deletions basyx/aas/model/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -507,13 +507,10 @@ class Referable(HasExtension, metaclass=abc.ABCMeta):
<<abstract>>

*Constraint AASd-001:* In case of a referable element not being an identifiable element the
idShort is mandatory and used for referring to the element in its name space.

idShort is mandatory and used for referring to the element in its name space.
*Constraint AASd-002:* idShort shall only feature letters, digits, underscore ("_"); starting
mandatory with a letter.

mandatory with a letter.
*Constraint AASd-003:* idShort shall be matched case insensitive.

*Constraint AASd-004:* Add parent in case of non identifiable elements.

:ivar _id_short: Identifying string of the element within its name space
Expand Down Expand Up @@ -780,8 +777,8 @@ class Reference(metaclass=abc.ABCMeta):

<<abstract>>

*Constraint AASd-121:* For References the type of the first key of Reference/keys shall be one of
GloballyIdentifiables.
*Constraint AASd-121:* For References the value of Key/type of the first key of Reference/keys shall be one of
GloballyIdentifiables.

:ivar key: Ordered list of unique reference in its name space, each key referencing an element. The complete
list of keys may for example be concatenated to a path that then gives unique access to an element
Expand Down Expand Up @@ -824,10 +821,11 @@ class GlobalReference(Reference):
A reference is an ordered list of keys, each key referencing an element. The complete list of keys may for
example be concatenated to a path that then gives unique access to an element or entity.

*Constraint AASd-122:* For global references the type of the first key of Reference/keys shall be one of
GenericGloballyIdentifiables.
*Constraint AASd-124:* For global references the last key of Reference/keys shall be either one of
GenericGloballyIdentifiables or one of GenericFragmentKeys.
*Constraint AASd-122:* For external references, i.e. References with Reference/type = ExternalReference,
the value of Key/type of the first key of Reference/keys shall be one of GenericGloballyIdentifiables.
*Constraint AASd-124:* For external references, i.e. References with Reference/type = ExternalReference,
the last key of Reference/keys shall be either one of GenericGloballyIdentifiables
or one of GenericFragmentKeys.

:ivar key: Ordered list of unique reference in its name space, each key referencing an element. The complete
list of keys may for example be concatenated to a path that then gives unique access to an element
Expand Down Expand Up @@ -856,16 +854,18 @@ class ModelReference(Reference, Generic[_RT]):

This is a special construct of the implementation to allow typed references and de-referencing.

*Constraint AASd-123:* For model references the type of the first key of Reference/keys shall be one of
AasIdentifiables.
*Constraint AASd-125:* For model references with more than one key in Reference/keys the type of the keys following
the first key of Reference/keys shall be one of FragmentKeyElements.
*Constraint AASd-126:* For model references with more than one key in Reference/keys the type of the last Key in
the reference key chain may be one of GenericFragments or no key at all shall have a value
out of GenericFragmentKeys.
*Constraint AASd-127:* For model references with more than one key in Reference/keys a key with type
FragmentReference shall be preceded by a key with type File or Blob. All other AAS fragments,
i.e. type values out of AasSubmodelElements, do not support fragments.
*Constraint AASd-123:* For model references, i.e. References with Reference/type = ModelReference,
the value of Key/type of the first key of Reference/keys shall be one of AasIdentifiables.
*Constraint AASd-125:* For model references, i.e. References with Reference/type = ModelReference with more than
one key in Reference/keys, the value of Key/type of each of the keys following the first key of Reference/keys
shall be one of FragmentKeys.
*Constraint AASd-126:* For model references, i.e. References with Reference/type = ModelReference with more than
one key in Reference/keys, the value of Key/type of the last Key in the reference key chain may be one of
GenericFragmentKeys, or no key at all shall have a value out of GenericFragmentKeys.
*Constraint AASd-127:* For model references, i.e. References with Reference/type = ModelReference with more than
one key in Reference/keys, a key with Key/type FragmentReference shall be preceded by a key with Key/type
File or Blob. All other AAS fragments, i.e. Key/type values out of AasSubmodelElements,
do not support fragments.
*Constraint AASd-128:* For model references the Key/value of a Key preceded by a Key with
Key/type=SubmodelElementList is an integer number denoting the position in the array of the
submodel element list.
Expand Down Expand Up @@ -1037,10 +1037,10 @@ class DataSpecificationContent:
the data specification template and meta information about the template itself.

*Constraint AASc-3a-050:* If the `Data_specification_IEC_61360` is used
for an element, the value of `Has_data_specification.embedded_data_specifications`
shall contain the global reference to the IRI of the corresponding data specification
template
https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0
for an element, the value of `Has_data_specification.embedded_data_specifications`
shall contain the global reference to the IRI of the corresponding data specification
template
https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0

"""
@abc.abstractmethod
Expand Down Expand Up @@ -1090,7 +1090,7 @@ class AdministrativeInformation(HasDataSpecification):
Administrative meta-information for an element like version information.

*Constraint AASd-005:* A revision requires a version. This means,
if there is no version there is no revision either.
if there is no version there is no revision either.

:ivar version: Version of the element.
:ivar revision: Revision of the element.
Expand Down Expand Up @@ -1279,8 +1279,8 @@ class HasSemantics(metaclass=abc.ABCMeta):

<<abstract>>

*Constraint AASd-118:* If there is a supplemental semantic ID (HasSemantics/supplementalSemanticId) defined,
then there shall be also a main semantic ID (HasSemantics/semanticId).
*Constraint AASd-118:* If a supplemental semantic ID (HasSemantics/supplementalSemanticId) is defined,
there shall also be a main semantic ID (HasSemantics/semanticId).

:ivar semantic_id: Identifier of the semantic definition of the element. It is called semantic id of the element.
The semantic id may either reference an external global id or it may reference a referable model
Expand Down Expand Up @@ -1474,8 +1474,10 @@ class Qualifier(HasSemantics):
"""
A qualifier is a type-value pair that makes additional statements w.r.t. the value of the element.

*Constraint AASd-006:* if both, the value and the valueId are present, then the value needs to be
identical to the value of the referenced coded value in Qualifier/valueId.
*Constraint AASd-006:* If both, the value and the valueId of a Qualifier are present, the value needs
to be identical to the value of the referenced coded value in Qualifier/valueId.
*Constraint AASd-020:* The value of Qualifier/value shall be consistent with the
data type as defined in Qualifier/valueType.

:ivar type: The type (:class:`~.QualifierType`) of the qualifier that is applied to the element.
:ivar value_type: Data type (:class:`~.DataTypeDefXsd`) of the qualifier value
Expand Down
29 changes: 15 additions & 14 deletions basyx/aas/model/submodel.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,8 +232,8 @@ class Property(DataElement):
"""
A property is a :class:`DataElement` that has a single value.

*Constraint AASd-007:* if both, the value and the valueId are present then the value needs to be
identical to the value of the referenced coded value in valueId
*Constraint AASd-007:* If both, the value and the valueId of a Qualifier are present,
the value needs to be identical to the value of the referenced coded value in Qualifier/valueId.

:ivar id_short: Identifying string of the element within its name space. (inherited from
:class:`~aas.model.base.Referable`)
Expand Down Expand Up @@ -305,8 +305,9 @@ class MultiLanguageProperty(DataElement):
"""
A multi language property is a :class:`~.DataElement` that has a multi language value.

*Constraint AASd-012*: if both, the value and the valueId are present then for each string in a
specific language the meaning must be the same as specified in valueId.
*Constraint AASd-012*: if both the MultiLanguageProperty/value and the MultiLanguageProperty/valueId are present,
the meaning must be the same for each string in a specific language,
as specified inMultiLanguageProperty/valueId.

:ivar id_short: Identifying string of the element within its name space. (inherited from
:class:`~aas.model.base.Referable`)
Expand Down Expand Up @@ -364,7 +365,7 @@ class Range(DataElement):
A range is a :class:`~.DataElement` that has a range value.

*Constraint AASd-013:* In case of a range with `kind=Instance` either the min or the max value or both
need to be defined
need to be defined

:ivar id_short: Identifying string of the element within its name space. (inherited from
:class:`~aas.model.base.Referable`)
Expand Down Expand Up @@ -669,16 +670,16 @@ class SubmodelElementList(SubmodelElement, base.UniqueIdShortNamespace, Generic[
The numbering starts with Zero (0).

*Constraint AASd-107:* If a first level child element in a :class:`SubmodelElementList` has a semanticId it shall be
identical to SubmodelElementList/semanticIdListElement.
identical to SubmodelElementList/semanticIdListElement.
*Constraint AASd-114:* If two first level child elements in a :class:`SubmodelElementList` have a semanticId then
they shall be identical.
*Constraint AASd-115:* If a first level child element in a :class:`SubmodelElementList` does not specify
a semanticId then the value is assumed to be identical to SubmodelElementList/semanticIdListElement.
they shall be identical.
*Constraint AASd-115:* If a first level child element in a :class:`SubmodelElementList` does not specify a
semanticId, the value is assumed to be identical to SubmodelElementList/semanticIdListElement.
*Constraint AASd-108:* All first level child elements in a :class:`SubmodelElementList` shall have the same
submodel element type as specified in SubmodelElementList/typeValueListElement.
*Constraint AASd-109:* If SubmodelElementList/typeValueListElement equal to Property or Range
SubmodelElementList/valueTypeListElement shall be set and all first level child elements in the
:class:`SubmodelElementList` shall have the value type as specified in SubmodelElementList/valueTypeListElement.
submodel element type as specified in SubmodelElementList/typeValueListElement.
*Constraint AASd-109:* If SubmodelElementList/typeValueListElement is equal to Property or Range,
SubmodelElementList/valueTypeListElement shall be set and all first level child elements in the
:class:`SubmodelElementList` shall have the value type as specified in SubmodelElementList/valueTypeListElement.

:ivar id_short: Identifying string of the element within its name space. (inherited from
:class:`~aas.model.base.Referable`)
Expand Down Expand Up @@ -1055,7 +1056,7 @@ class Entity(SubmodelElement, base.UniqueIdShortNamespace):
An entity is a :class:`~.SubmodelElement` that is used to model entities

*Constraint AASd-014:* global_asset_id or specific_asset_id must be set if :attr:`~.entity_type` is set to
:attr:`~.EntityType.SELF_MANAGED_ENTITY`. They must be empty otherwise.
:attr:`~.EntityType.SELF_MANAGED_ENTITY`. They must be empty otherwise.

:ivar id_short: Identifying string of the element within its name space. (inherited from
:class:`~aas.model.base.Referable`)
Expand Down
44 changes: 15 additions & 29 deletions docs/source/constraints.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,38 +31,26 @@ AASd-005 A revision requires a version. ✅
This means, if there is no
version there is no
revision either.
AASd-006 if both, the value and the valueId ❌ Uncheckable, cannot check the value
of a Qualifier are of what value_id points to

present then the value needs to
be identical to the value of

the referenced coded
AASd-006 If both, the value and the valueId ❌ Uncheckable, cannot check the value
of a Qualifier are present, of what value_id points to
the value needs to be identical to
the value of the referenced coded
value in Qualifier/valueId.
AASd-007 If both, the value and the valueId ❌ Uncheckable, cannot check the value
of a Property are of what value_id points to

present then the value needs to
be identical to the value of

the referenced coded value in
Property/valueId.
of a Qualifier are present, the of what value_id points to
value needs to be identical to the
value of the referenced coded value
in Qualifier/valueId.
AASd-008 The submodel element value of an ✅
operation variable shall be

of kind=Template.
AASd-012 If both, the ❌ Uncheckable
AASd-012 if both the ❌ Uncheckable
MultiLanguageProperty/value and

the MultiLanguageProperty/valueId
are present then for

each string in a specific
language the meaning must be


the same as specified in

are present, the meaning must be
the same for each string in a
specific language, as specified in
MultiLanguageProperty/valueId.
AASd-014 Either the attribute globalAssetId ✅
or specificAssetId of an
Expand All @@ -73,11 +61,9 @@ AASd-014 Either the attribute globalAssetId ✅

“SelfManagedEntity”.
They are not existing otherwise.
AASd-020 The value of Qualifier/value tbd
shall be consistent to the

data type as defined in
Qualifier/valueType.
AASd-020 The value of Qualifier/value shall ✅
be consistent with the data type
as defined in Qualifier/valueType.
AASd-021 Every Qualifiable can only have WIP postponed
one qualifier with the same

Expand Down