You are not viewing the documentation for the latest release of F Prime. Click here to go to latest release.

F Prime

FlagsComponent

Initializing search

Home
Overview
Getting Started
Documentation
Support
Events
News

F Prime

Home
Overview
Getting Started
Getting Started
- Installation and Troubleshooting
Documentation
Documentation
- Tutorials
  Tutorials
- User Manual
  User Manual
  - Overview
    Overview
    
    Introduction To F´
    
    F´ Software Architecture
    
    Core Constructs: Ports, Components, and Topologies
    
    Data Constructs: Commands, Events, Channels, and Parameters
    
    Data Structures and Types
    
    F´ Development Process
    
    The F´ Ground Data System
    
    Projects and Deployments
    
    A Tour of the Source Tree
    
    Unit Testing in F´
  - Framework
    Framework
    
    Asserts in F
    
    F´ Autocoded Functions and Component Classes
    
    Constructing the F´ Topology
    
    Selecting Component, Port, and Command Kinds
    
    Configuring F´
    
    Data Products
    
    Ground Interface Architecture and Customization
    
    F´ Reference Projects
    
    F´ on Baremetal Systems
    
    F´ on Multi-Core Systems
    
    State Machines
    
    Supported Platforms
    
    Memory management
    
    Memory management
    
    Buffer Pools with Svc.BufferManager
    
    Memory Allocation with Fw::MemAllocator
  - FPP
  - GDS
    GDS
    
    The F´ GDS CLI
    
    The GDS Dashboard
    
    GDS Dashboard Component Reference
    
    GDS Developer's Guide
    
    GDS Integration Test API
    
    Reusable Integration Tests
    
    Sequencing In F´
  - Design Patterns
    Design Patterns
    
    Application-Manager-Driver Architecture
    
    Common Port Design Patterns
    
    Health Checking Pattern
    
    A Quick Look at the Hub Pattern
    
    The Manager/Worker Pattern
    
    Rate Groups and Timeliness
    
    Subtopologies
  - Build System
    Build System
    
    F´ CMake Build System
    
    CMake API Reference
    
    CMake Customization
    
    CMake Implementations
    
    F´ and CMake Platforms
    
    Targets
    
    CMake Toolchain Files
    
    CMake Build System Unit Tests
    
    settings.ini: Build Settings Configuration
  - Security
    Security
    
    Software Bill Of Materials Generation
- How To
  How To
  - Develop
    Develop
    
    Generate Data Products
    
    Define State Machines in F Prime
    
    Develop a Device Driver
    
    Develop an F´ Library
    
    Develop a Subtopology
    
    Implement a Radio Manager Component
    
    Develop Components in Python
  - Integrate
    Integrate
    
    Implement a Framing Protocol
    
    Implement an OS Abstraction Layer
    
    Integrate a Third-Party Library
    
    Porting to new platforms
  - Operate
    Operate
    
    Create Ground-Derived Channels in F Prime GDS
    
    Develop a GDS Plugin
    
    Load Parameters in Batch
  - Test
    Test
    
    Write Rule-Based Tests for F Prime Components
    
    Test-Driven Development in F Prime (F´)
- Reference
  Reference
  - APIs
    APIs
    
    C++
    
    CMake
    CMake
    
    API
    
    Config assembler
    
    FPrime
    
    FPrime Code
    
    FPrimeConfig
    
    Flags
    
    Fprime util
    
    Global interface
    
    Implementation
    
    Module
    
    Options
    
    Required
    
    Sanitizers
    
    Settings
    
    Utilities
    
    Autocoder
    Autocoder
    
    Autocoder
    
    Fpp
    
    Fpp ut
    
    Helpers
    
    Platform
    Platform
    
    Darwin
    
    Linux
    
    Platform
    
    Platform template
    
    Unix
    Unix
    
    Platform
    
    Settings
    Settings
    
    Ini
    
    Sub build
    Sub build
    
    Sub build
    
    Sub build config
    
    Target
    Target
    
    Build
    
    Dictionary
    
    Fprime install
    
    Install
    
    Refresh cache
    
    Sbom
    
    Target
    
    Ut
    
    Version
    
    Sub build
    Sub build
    
    Fpp depend
    
    Fpp locs
    
    Fpp to json
    
    Module info
    
    Test
    Test
    
    Data
    Data
    
    TestConfigConflictDeployment
    
    TestConfigDeployment
    
    TestDeployment
    
    TestFindPackageProject
    
    TestFlagsProject
    
    TestTargetTriple
    
    Cmake
    Cmake
    
    Autocoder
    Autocoder
    
    Test build autocoder
    
    Test chained autocoder
    
    Test header autocoder
    
    Test target autocoder
    
    Target
    Target
    
    Test autocoder
    
    Test chained autocoder
    
    Test recursion
    
    Test rerun autocoder
    
    TestConfigConflictDeployment
    TestConfigConflictDeployment
    
    Config
    
    TestConfigDeployment
    TestConfigDeployment
    
    Override
    Override
    
    Project
    
    TestDeployment
    TestDeployment
    
    TestBuildAutocoder
    
    TestChainedAutocoder
    
    TestHeaderAutocoder
    
    TestLinkDepends
    
    TestRelative
    
    TestTargetAutocoder
    
    TestFindPackageProject
    TestFindPackageProject
    
    Lib
    Lib
    
    Test platform library
    Test platform library
    
    Library
    
    Cmake
    Cmake
    
    Platform
    Platform
    
    Linux
    
    TestFlagsProject
    TestFlagsProject
    
    FlagsComponent
    
    Test config library
    Test config library
    
    ConfigLibrary
    
    Library
    
    ConfigLibrary
    ConfigLibrary
    
    Default
    Default
    
    Config
    
    Test fprime library
    Test fprime library
    
    Test fprime library
    
    Cmake
    Cmake
    
    Autocoder
    Autocoder
    
    Test
    
    Target
    Target
    
    Sub
    
    Test
    
    Toolchain
    Toolchain
    
    Generic native
    
    TestLibrary
    TestLibrary
    
    TestComponent
    
    Test fprime library2
    Test fprime library2
    
    Library
    
    TestLibrary2
    TestLibrary2
    
    TestComponent
    
    Test implementations
    Test implementations
    
    Deployment
    
    Deployment
    Deployment
    
    TestModule
    
    Test platforms
    Test platforms
    
    Library
    
    Cmake
    Cmake
    
    Platform
    Platform
    
    Darwin
    
    Linux
    
    Toolchain
    Toolchain
    
    Aarch64 clang linux
    
    Aarch64 linux
    
    Arm hf linux
    
    Arm sf linux
    
    Raspberrypi
    
    Toolchain template
    
    Helpers
    Helpers
    
    Arm linux base
  - Software Design Documents
    Software Design Documents
    
    Svc
    Svc
    
    Svc::ActivePhaser
    
    Svc::ActiveRateGroup Component
    
    Svc::ActiveTextLogger Component
    
    Svc::AssertFatalAdapter Component
    
    BufferAccumulator Component Dictionary
    
    Svc::BufferLogger
    
    Svc::BufferManager
    
    Svc::BufferRepeater: Buffer Repeater (Passive Component)
    
    Svc::Ccsds::AosDeframer
    
    Svc::Ccsds::AosFramer
    
    Svc::Ccsds::ApidManager
    
    Svc::Ccsds::CcsdsSdlsDeframer
    
    Svc::Ccsds::CcsdsSdlsFramer
    
    Ccsds::CfdpManager
    
    Svc::Ccsds::ClearTextDecryptor
    
    Svc::Ccsds::ClearTextEncryptor
    
    Svc::Ccsds::SdlsFileKeyManager
    
    Svc::Ccsds::SdlsSaRouter
    
    Svc::Ccsds::SpacePacketDeframer
    
    Svc::Ccsds::SpacePacketFramer
    
    Svc::Ccsds::TcDeframer
    
    Svc::Ccsds::TmFramer
    
    Svc::ChronoTime
    
    Svc::CmdDispatcher Component
    
    Svc::CmdSequencer Component
    
    Svc::CmdSplitter Component
    
    Svc::ComAggregator
    
    Svc::ComLogger
    
    Svc::ComQueue (Active Component)
    
    Svc::ComRetry
    
    Svc::ComSplitter
    
    Svc::ComStub (Passive Component)
    
    Svc::DpCatalog Component
    
    Svc::DpCompressProc
    
    Svc::DpManager (Active Component)
    
    Svc::DpWriter (Active Component)
    
    Svc::DpZLibCompressor
    
    Svc::EventManager Component
    
    Svc::Fatal Port
    
    Svc::FatalHandler Component
    
    Svc::FileDispatcher
    
    Svc::FileDownlink Component
    
    Svc::FileManager Component
    
    Svc::FileUplink Component
    
    Svc::FileWorker
    
    Svc::FprimeDeframer
    
    Svc::FprimeFramer
    
    The F Prime communications protocol
    
    Svc::FprimeRouter
    
    Svc::FpySequencer
    
    Svc::FrameAccumulator
    
    Svc::GenericHub Generic Hub Component
    
    Svc::Health Component
    
    Svc FPP Interfaces
    
    Svc::LinuxTimer
    
    Svc::OsTime Component
    
    Svc::PassiveConsoleTextLogger Component
    
    PassiveRateGroup Component
    
    Svc::PassThroughRouter
    
    Svc::Ping Port
    
    Svc::PolyDb Component
    
    Svc::Poly Port
    
    Svc/FilePorts SDD
    
    Svc::PosixTime Component
    
    Svc::PrmDb Component
    
    Svc::RateGroupDriver Component
    
    Svc::Sched Port
    
    components::SeqDispatcher
    
    Svc::StaticMemory Component
    
    CdhCore Subtopology — Software Design Document (SDD)
    
    ComCcsds (CCSDS Framing) Subtopology — Software Design Document (SDD)
    
    ComCcsdsSdls (CCSDS Framing with SDLS Decryption) Subtopology — Software Design Document (SDD)
    
    ComFprime (F´ Framing) Subtopology — Software Design Document (SDD)
    
    DataProducts Subtopology — Software Design Document (SDD)
    
    DpCompression Subtopology — Software Design Document (SDD)
    
    FileHandling Subtopology — Software Design Document (SDD)
    
    FileHandlingCfdp Subtopology — Software Design Document (SDD)
    
    SystemResources Component
    
    Svc::TlmChan Component
    
    Svc::TlmPacketizer Component
    
    Svc::EventSeverityFilter Utility
    
    Svc::Version
    
    Svc::WatchDog Port
    
    Fw
    Fw
    
    DataStructures
    DataStructures
    
    1.2. Array
    
    ArrayMap
    
    ArraySet
    
    ArraySetOrMapImpl
    
    CircularIndex
    
    ExternalArray
    
    ExternalArrayMap
    
    ExternalArraySet
    
    ExternalFifoQueue
    
    ExternalRedBlackTreeMap
    
    ExternalRedBlackTreeSet
    
    ExternalStack
    
    FifoQueue
    
    FifoQueueBase
    
    MapBase
    
    MapConstIterator
    
    MapEntryBase
    
    Nil
    
    RedBlackTreeMap
    
    RedBlackTreeSet
    
    RedBlackTreeSetOrMapImpl
    
    SetBase
    
    SetConstIterator
    
    SetEntry
    
    SetOrMapImplConstIterator
    
    SetOrMapImplEntry
    
    SizedContainer
    
    Stack
    
    StackBase
    
    Fw/DataStructures: Basic Data Structures
    
    Fw::Buffer Serializable / Fw::BufferGet Port / Fw::BufferSend Port
    
    Fw::Cmd / Fw::CmdResponse / Fw::CmdReg Ports
    
    Fw::Com Port
    
    Fw::Dp Framework Support for Data Products
    
    Fw::FilePacket Classes
    
    Fw::Log / Fw::LogText Ports
    
    Fw::Obj Classes
    
    Fw::Port Classes
    
    Fw::PrmGet / PrmSet Ports
    
    Fw::Time Port
    
    Fw::Tlm Port
    
    Fw::Type Classes and Types
    
    Drv
    Drv
    
    Drv::AsyncByteStreamBufferAdapter
    
    Drv::ByteStreamBufferAdapter
    
    Drv::ByteStreamDriverModel Byte Stream Driver Model
    
    Drv FPP Interfaces
    
    Drv::Ip IPv4 Socket Implementations
    
    Drv::LinuxGpioDriver
    
    Drv::LinuxI2cDriver
    
    Drv::LinuxSpiDriver
    
    Drv::LinuxUartDriver
    
    Drv::TcpClient TCP Client Component
    
    Drv::TcpServer Tcp Server Component
    
    Drv::Udp UDP Component
    
    Os
    Os
    
    Operating System Abstraction Layer (OSAL)
    
    Generic OSAL Implementations
    
    AtomicQueue Software Design Document
  - Specifications
    Specifications
    
    FPP Language Spec
    
    GDS Plugins
    
    GDS Plugins
    
    Communication Plugin
    
    Data Handler Plugin
    
    Framing Plugin
    
    App Plugin
    
    GDS Function Plugin
    
    Communication Adapter Interface
    
    FPP JSON Dictionary Specification
    
    F Prime Translation Guide
    
    Nomenclature
    
    F´ Numerical Types
Support
Events
News

FlagsComponent

Note: auto-generated from comments in: ./test/data/TestFlagsProject/FlagsComponent/CMakeLists.txt

F´ GitHub
Discussion Forum
Report Issues
Email Us

NASA
JPL
Caltech
Privacy
Image Policy
FAQ
Feedback

Site Manager: Jeffrey Levison
Site Editors: Michael Starch, Thomas Boyer-Chammard, Ashley Nilo
CL#24-6514

JPL is a federally funded research and development center managed for NASA by Caltech. © 2025 California Institute of Technology. Government sponsorship acknowledged.