iho-ohi / S-129-Product-Specification

IHO Repository to discuss technical issues of development of S-129 Product Specification.
9 stars 4 forks source link

Update Feature Catalogue and UML Diagrams for Enhanced Association and Enumeration Definitions #13

Closed KMOUSQA closed 4 months ago

KMOUSQA commented 5 months ago

Details of Changes:

1. Feature Catalogue Modifications:

Association Definition Define the roles "Component of" and "Consists of" used in our UML to specify the relationship between features (Feature Association). This will involve creating a list defining these roles and naming each association.

List Associations Further define the relationships between features by listing them. This list will help in visualizing the interactions and dependencies among features.

Multiplicity Definition Specify the multiplicity in relationships where a feature is defined in relation to another feature.

2. UML Diagram Modifications:

KakaoTalk_20240623_124820112

Enumeration Updates Document missing enumeration numbers in the Enumeration type to ensure consistency and completeness.

Association Removal Remove the existing associations between Enumeration, ComplexAttribute, and Feature as specified in the modifications of the Feature Catalogue.

Multiplicity Documentation Based on the updated Feature Catalogue, document the multiplicity of attributes to align with our model's structural requirements.

Additional Notes

Both the naming of associations in the Feature Catalogue and certain elements in the UML diagrams may require further modifications pending discussions in upcoming meetings.

Revised Feature Catalogue S-129_1_2_0_FC_240620.zip

jrhee01 commented 5 months ago

Thanks @KMOUSQA for raising this issue. I have committed the following changes on branch "13-update-feature-catalogue-and-uml-diagrams-for-enhanced-association-and-enumeration-definitions":

  1. @KMOUSQA's FC changes to as per issue raised
  2. Added constraints to "maximumDraught", "expectedPassingSpeed", and "distanceAboveUKCLimit" attributes (@KMOUSQA, I have taken the liberty of making this change, following our discussion, noting that "uom" had already been added to the FC).
  3. Corrected feature camelCases - first letter uppercase, consistent with IHO GI Registry's Data Dictionary Register
  4. Cleaned up indentation of rows corresponding to uom attribute
  5. Cleaned up FC filenames and version numbers/dates to improve visibility to version tracking
  6. Created GML schema based on the updated FC (ver. date 2024-06-25), using the Feature Catalogue Builder version 3.1.2.0
  7. (not related to this issue; changed test dataset file names to better conform to naming convention)

@rmalyankar, @KMOUSQA, much appreciated if you could review all the FC changes, as well as the resulting GML schema, committed on the branch. Please feel free to make updates/corrections as necessary

I will also work on updating the S-129 PS accordingly, as applicable.

jrhee01 commented 4 months ago

Updated UML diagrams - 2 veresions: 1 with UnderKeelClearancePlanArea, 1 without.

PlanArea WithoutPlanArea

jrhee01 commented 4 months ago

In summary, following changes have been made and merged into the main branch:

Additionally, following FC changes were made on this branch:

Some PC changes were also made on this branch: