Skip to content

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 4 commits into from
Feb 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,7 @@ nav:
- 'Porting F´ To a New Platform': docs/how-to/porting-guide.md
- Reference:
- docs/reference/index.md
- 'Software Engineering Terminology to F´ Nomenclature': docs/reference/fprime-translations.md
- 'C++ Documentation': docs/reference/api/cpp/html/index.html
- 'F´ Components SDDs': docs/reference/sdd.md
- 'FPP Language Specification': https://nasa.github.io/fpp/fpp-spec.html
Expand Down
57 changes: 57 additions & 0 deletions docs/reference/fprime-translations.md
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 |

Loading