-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Add F Prime terminology translation guide #3260
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
# F Prime Translation Guide: Software Engineering Terminology to F Prime Nomenclature | ||
|
||
This guide provides a mapping between common software engineering concepts and their equivalent implementations in the F´ framework. It serves as a reference for developers new to F´ development. | ||
|
||
## Data Structures & Containers | ||
|
||
| Software Concept | F Prime Equivalent | Notes | | ||
|-----------------|-------------------|--------| | ||
| String | Fw::String | Safe string implementation with size limits | | ||
| Buffer | [Fw::Buffer](../../Fw/Buffer/docs/sdd.md) | Memory buffer with size tracking | | ||
| Queue | Os::Queue | Thread-safe queue implementation | | ||
|
||
> [!NOTE] | ||
> `Os::Queue` is rarely used directly but rather is used via `async` port calls. | ||
|
||
## Communication & Synchronization | ||
|
||
| Software Concept | F Prime Equivalent | Notes | | ||
|-----------------|-------------------|--------| | ||
| Function Call | Synchronous Port | Direct component-to-component calls | | ||
| Message Queue | Async Port | Asynchronous component communication supported by a queue | | ||
| Event Loop | Active Component | Components with their own execution thread | | ||
| Mutex | Os::Mutex | Thread synchronization primitive | | ||
| Thread | Os::Task | OS task abstraction | | ||
|
||
|
||
> [!NOTE] | ||
> `Os::Task` is rarely used directly but rather is contained within `active` components. | ||
|
||
## Memory Management | ||
|
||
| Software Concept | F Prime Equivalent | Notes | | ||
|-----------------|-------------------|--------| | ||
| Stack Allocation | Local variables | Standard stack allocation | | ||
| Heap Allocation | Fw::MemAllocator | Managed heap allocation | | ||
| Memory Pooling | [Svc::BufferManager](../../Svc/BufferManager/docs/sdd.md) | Fixed-size buffer management | | ||
| Smart Pointer | [Fw::Buffer](../../Fw/Buffer/docs/sdd.md) | Buffer containing pointer, size, and context | | ||
|
||
## System Architecture | ||
|
||
| Software Concept | F Prime Equivalent | Notes | | ||
|-----------------|-------------------|--------| | ||
| Module | Component | Basic unit of functionality | | ||
| Interface | Port(s) | Component communication interface | | ||
| System Service | Service Component | Components providing system services | | ||
| Driver | Driver Component | Hardware abstraction components | | ||
| Runtime Configuration | Parameters | Component configuration management via ground-commanded parameters | | ||
|
||
## Error Handling | ||
|
||
| Software Concept | F Prime Equivalent | Notes | | ||
|-----------------|-------------------|--------| | ||
| Exception | Assert + Event | Assertion and event logging | | ||
| Error Code | Status Type | Enumerated status returns | | ||
| Logging | Events | System event logging framework | | ||
| Debug Print | Fw::Logger | Debug output facility | | ||
|
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.