DotAAS V3.0 Compatbility

[jkhsjdhjs]

Tracking issue for V3.0 release.

TODOs:

• finish Update the implementation to V3.0RC02 #18
• fix id_short attribute defaulting to the string literal NotSet (see discussion on Zulip)
• revert 8fee1c5
• make NamespaceSet immutable (inherit from FrozenSet) and rename the current NamespaceSet to MutableNamespaceSet, which inherits from the new immutable NamespaceSet -> for SubmodelElementCollection
• update JSON + XML schemata -> Check diff to improve/V30 schemata and adapt if necessary -> see below
• adapter.aasx: Wrong subdomain in AASX namespace #96
• adapter.aasx: resolution of file:// references #72 -> Problem of the spec

(s-heppner, 2023-10-19)
EDIT: Copied comment from below, so that not just me can edit. Furtheremore, I took the liberty to clean up this comment.

Since we're closing in to the last steps, here a summary of the Todos left before the v3.0 Release:

• Adapt the changes in the constraints
• adapter.aasx: Wrong subdomain in AASX namespace #96
• Adapt changes to model.ConceptDescription #117
• model._string_constraints: Add AASd-130 to strings #118
• Add case-sensitive matching for idShorts (AASd-003)
• Repair and finalize WIP: Add Constraints 131, 133, 134 #91
• Remove DataSpecification Physical Unit #136
• Check that the spec Part 3a was fully adapted (I saw a wrong type of unit at first glance)
• Implement Constraint AASd-133 #145
• Implement Constraint AASd-134 #146 @jkhsjdhjs
• Remove OperationVariable class #148 @jkhsjdhjs
• Double check the completeness of the JSON & XML schemata @jkhsjdhjs
  • I tried and found one mistake through the JSON, but sadly several problems with the XSD.
  • Make model.Entity.specific_asset_id a Set of model.SpecificAssetIds #144 @zrgt
• Document
  • Update the constraint-implementation table in sphinx @zrgt
  • Document that we don't implement the DataSpecification template class #112 -> EventPayload as well @zrgt
  • model.submodel: Implement AASd-129 and AASd-119 #119 @zrgt
  • Final check of the documentation
• merge main in improve/V30 (and maybe also improve/V30RC02)

[dxvidnrt]

TO-DO "Table 18 New, Changed or Removed Constraints":

• AASd-002
• AASd-003
• AASd-005
• AASd-006
• AASd-007
• AASd-012
• AASd-020
• AASd-022
• AASd-027
• AASd-077
• AASd-100
• AASd-109
• AASd-115
• AASd-117
• AASd-118
• AASd-119
• AASd-120
• AASd-121
• AASd-122
• AASd-123
• AASd-124
• AASd-125
• AASd-126
• AASd-127
• AASd-129
• AASd-130
• AASd-131
• AASd-133
• AASd-134
• AASd-051

[StenGruener]

Hi guys, any timeline here?

[s-heppner]

The timeline is that we first adapt the changes to the meta-model, based on our v3.0RC02 branch, before adapting the JSON and XML serialization. After that we're planning to implement the HTTP-API.
I'd guesstimate between 1-3 months until we're ready for a release of the meta-model and the adapters, depending on how difficult the changes are to implement.

[s-heppner]

TO-DO "Table 16 Changes":

• AdministrativeInformation
• AssetInformation/externalSubjectId
• AssetInformation/globalAssetId: aas.AssetInformation: Add new attribute asset_type of type base.Identifier and change type of global_asset_id to base.Identifier` #70
• AssetKind/Type
• AssetKind/Instance
• BasicEventElement
• BasicEventElement/messageTopic
• BasicEventElement/minInterval
• BasicEventElement/maxInterval
• BlobType: we are spec-compliant, but the type may still be changed: Which Python-Type should we use in BlobType? #57
• ContentType
• decimalBuildInTypes
• durationBuildInTypes
• @jkhsjdhjs DataSpecification/description: we don't implement the DataSpecification template class
• DataTypeDefRdf/langString: type changed from langSring to rdf:langString, we are still compliant
• DateTypeDefXsd/dateTimeStamp
• DataTypeDefXsd/dayTimeDuration
• DataTypeDefXsd/yearMonthDuration
• Direction: set to <<Experimental>>, we implement it anyway
• Entity/globalAssetId: aas.AssetInformation: Add new attribute asset_type of type base.Identifier and change type of global_asset_id to base.Identifier` #70
• Extension/name
• EventElement: set to <<Experimental>>, we implement it anyway
• EventElement/duration: error in the spec, EventElement doesn't has such an attribute @s-heppner
• EventPayload: There is Adding Event Payload #84 which implements EventPayload, but EventPayload is experimental and not referenced by any other DotAAS class, so even if we implemented it, it would be useless.
• EventPayload/payload
• EventPayload/source
• EventPayload/timestamp
• EventPayload/topic
• @s-heppner HasKind/kind: rename enum from ModelingKind to ModellingKind
• Identifier
• Key/value: revert wrapping many strings in model.Identifier() + add missing Identifier constraint to Key #93
• @jkhsjdhjs MultiLanguageProperty/value: feature: ConstrainedLangStringSets #113
• PathType
• PrimitiveTypes
• Qualifier/kind: set to <<Experimental>>, we implement it anyway
• QualifierType
• rdfBuildInTypes
• Referable/category: implemented, maybe add a DeprecationWarning here in the future
• Referable/checksum
• @jkhsjdhjs Referable/displayName: feature: ConstrainedLangStringSets #113
• @jkhsjdhjs Referable/description: feature: ConstrainedLangStringSets #113
• Referable/idShort
• @s-heppner ReferenceTypes/GlobalReference
• Resource
• StateOfEvent: set to <<Experimental>>, we implement it anyway
• SpecificAssetId/name
• @jkhsjdhjs SpecificAssetId/value -> str to Identifier: model.base: change type of SpecificAssetId.value to Identifier #114
• SubmodelElement/kind

TO-DO "Table 17 New Elements in Metamodel":

• @s-heppner AdministrativeInformation/creator: model.base: Add new attributes to class AdministrativeInformation #107
• @s-heppner AdministrativeInformation/templateId: model.base: Add new attributes to class AdministrativeInformation #107
• AssetInformation/assetType: aas.AssetInformation: Add new attribute asset_type of type base.Identifier and change type of global_asset_id to base.Identifier` #70
• AssetKind/NotApplicable
• LabelType
• MessageTopicType
• @jkhsjdhjs MultiLanguageNameType: feature: ConstrainedLangStringSets #113
• @jkhsjdhjs MultiLanguageTextType: feature: ConstrainedLangStringSets #113
• NameType
• @s-heppner ReferenceTypes/ExternalReference
• RevisionType
• @jkhsjdhjs ShortNameType: This should probably be called ShortNameTypeIec61360 or should be referenced differently in the spec.
  @s-heppner: This should be implemented as ShortNameTypeIEC61360.
  @jkhsjdhjs: Implemented as ShortNameType, since it isn't actually used for IEC61360, but for MultiLanguageNameType. The naming is extremely confusing though, should probably adjusted in the spec.
  feature: ConstrainedLangStringSets #113
• VersionType

[s-heppner]

Done with #174