Bugfix: docs/Architecture related guide materials #880
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The relationship between "SomeComponentBase" and "SomePorts" is
Composition-relationship here.
The "diamond block" should be closely placed to "SomeComponentBase" but
not "SomePorts".
As an example, the specific component base class "SendBuffComponentBase",
which is autogenrated based on
fprime-root-path/Ref/SendBuffApp/SendBuffComponentAi.xml.
The class "SendBuffComponentBase" pseudo-code:
class SendBuffComponentBase : public QueuedComponentBase{
// decalare some ports here
//! Input port SchedIn
Svc::InputSchedPort m_SchedIn_InputPort[NUM_SCHEDIN_INPUT_PORTS];
//... and so on
}
|
Good diagram catch. Could you just change the diagram to make the ports on the bottom as before? |
LeStarch
requested changes
Aug 3, 2021
|
Thank Tim. I have done.
|
timcanham
approved these changes
Aug 3, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change Description
The relationship between "SomeComponentBase" and "SomePorts" is Composition-relationship here.
The "diamond block" should be closely placed to "SomeComponentBase" but not "SomePorts".
As an example, the specific component base class "SendBuffComponentBase", which is autogenrated based on
fprime-root-path/Ref/SendBuffApp/SendBuffComponentAi.xml.
The class "SendBuffComponentBase" pseudo-code:
class SendBuffComponentBase : public QueuedComponentBase{
// decalare some ports here
//! Input port SchedIn
Svc::InputSchedPort m_SchedIn_InputPort[NUM_SCHEDIN_INPUT_PORTS];
//... and so on
}
Rationale
document enhancement
Testing/Review Recommendations
no related
Future Work
no related