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

Converting ByteStreamDriverModel into an interface #2252

Merged
merged 5 commits into from Aug 29, 2023
Merged

Converting ByteStreamDriverModel into an interface #2252

merged 5 commits into from Aug 29, 2023

Conversation

LeStarch
Copy link
Collaborator

Originating Project/Creator
Affected Component
Affected Architectures(s)
Related Issue(s)
Has Unit Tests (y/n)
Builds Without Errors (y/n)
Unit Tests Pass (y/n)
Documentation Included (y/n)

Change Description

Allows easier and cleaner implementations by making the ByteStreamDriverModel into an interface other components can leverage.

@LeStarch LeStarch force-pushed the update/stream-model-interface branch from dec6b5d to 00d9b13 Compare August 24, 2023 02:24
@LeStarch LeStarch force-pushed the update/stream-model-interface branch from 00d9b13 to 92b0a18 Compare August 24, 2023 02:25
thomas-bc
thomas-bc approved these changes Aug 25, 2023
View reviewed changes
Copy link
Collaborator

@thomas-bc thomas-bc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is really cool! LGTM.
Future work:

  • rename *ComponentImpl.(h|c)pp -> *.(h|c)pp
  • Revisit file hierarchy: where should port definitions be? (e.g. ByteStreamDriverPorts.fpp)

@bocchino bocchino self-requested a review August 28, 2023 18:29
bocchino
bocchino reviewed Aug 28, 2023
View reviewed changes
Copy link
Collaborator

@bocchino bocchino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

Just one comment: Why was ByteStreamDriverModel.fpp renamed to ByteStreamDriverPorts.fpp? It defines ports and enums (not just ports), and it's located in a directory called ByteStreamDriverModel. The old name seems better.

@bocchino bocchino mentioned this pull request Aug 28, 2023
Open
@LeStarch
Copy link
Collaborator Author

Fixed @bocchino's comment, will merge once CI passes!

bocchino
bocchino approved these changes Aug 28, 2023
View reviewed changes
Copy link
Collaborator

@bocchino bocchino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@LeStarch LeStarch merged commit a56426a into nasa:devel Aug 29, 2023
28 checks passed
@LeStarch LeStarch added the Update Instructions Needed Need to add instructions in the release notes for updates. label Aug 29, 2023
@iftahnaf iftahnaf mentioned this pull request Sep 2, 2023
Merged
This was referenced Oct 2, 2023
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bocchino bocchino bocchino approved these changes

@thomas-bc thomas-bc thomas-bc approved these changes

@timcanham timcanham Awaiting requested review from timcanham

Assignees
No one assigned
Labels
Update Instructions Needed Need to add instructions in the release notes for updates.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@LeStarch @bocchino @thomas-bc