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.

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

Interfaces as explicit elements. Typed interfaces, type checks for connections? #22

Open
DrMarkusVoss opened this issue Sep 30, 2021 · 0 comments
Labels
enhancement New feature or request
Milestone

Comments

@DrMarkusVoss
Copy link
Owner

Is your feature request related to a problem? Please describe.
Currently interfaces are just named bobbles. There is no "type" information behind (in a diagram you can of course model it with PlantUML), but incompatible interfaces could be connected.

Describe the solution you'd like
An interface type repository could host the interface types, that could be used as types of interface-ports (bobbles and half-circles). If they use the same type, they are compatible. The data would need to be in the model-repo, then an compatibility check could be done on whether the same type is behind the port. You could activate type checks, that could lead to an "error" or "warning" note instead of connecting. Connection only if valid.

This adds more semantics to the models. But especially if you want to have detailed information on your ports and want to be able to expose it easily in a re-usable way, than this makes sense.

Describe alternatives you've considered
Alternative is not considering types on ports. Keeps the tool smaller. But I think it is a useful feature, and I don't see how it could be done with plain PlantUML.

Additional context
Interfaces could be described with classes and then have a specially named relation to the ports.

@DrMarkusVoss DrMarkusVoss added the enhancement New feature or request label Sep 30, 2021
@DrMarkusVoss DrMarkusVoss added this to the v1.0 milestone Sep 30, 2021
DrMarkusVoss added a commit that referenced this issue Feb 23, 2023
…e for typed interfaces and ports. Tagged values can be applied to ports and interfaces.

TODO:
- extend python parser to read the typed interfaces and ports into the modelrepo, considering also their tagged values.
- adopt user's guide
- adopt modelling guideline with hints to typed interfaces and best practices for dealing with interface variance
- document layout problems of PlantUML for ports
- setup new examples for typed interfaces and ports
@DrMarkusVoss DrMarkusVoss modified the milestones: v1.0, v2.0 Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant