F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
format.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title format.hpp
3 // \author mstarch
4 // \brief hpp file for c-string format function
5 //
6 // \copyright
7 // Copyright (C) 2025 California Institute of Technology.
8 // ALL RIGHTS RESERVED. United States Government Sponsorship
9 // acknowledged.
10 // ======================================================================
11 #ifndef FW_TYPES_FORMAT_HPP_
12 #define FW_TYPES_FORMAT_HPP_
13 #include <FpConfig.h>
14 #include <cstdarg>
15 namespace Fw {
16 
18 enum class FormatStatus {
19  SUCCESS,
20  OVERFLOWED,
21  INVALID_FORMAT_STRING,
22  SIZE_OVERFLOW,
23  OTHER_ERROR
24 };
25 
42  FormatStatus stringFormat(char* destination, const FwSizeType maximumSize, const char* formatString, ...);
43 
62 FormatStatus stringFormat(char* destination, const FwSizeType maximumSize, const char* formatString, va_list args);
63 }
64 #endif // FW_TYPES_FORMAT_HPP_
65 
66 
FwSizeType
PlatformSizeType FwSizeType
Definition: FpConfig.h:35
Fw::FormatStatus::OVERFLOWED
Format overflowed.
Fw::FormatStatus::SIZE_OVERFLOW
FwSizeType overflowed the range of size_t.
FpConfig.h
C-compatible configuration header for fprime configuration.
Fw::FormatStatus::INVALID_FORMAT_STRING
Format provided invalid format string.
Fw::FormatStatus::OTHER_ERROR
An error was returned from an underlying call.
Fw::stringFormat
FormatStatus stringFormat(char *destination, const FwSizeType maximumSize, const char *formatString,...)
format a c-string
Definition: snprintf_format.cpp:10
Fw::FormatStatus
FormatStatus
status of string format calls
Definition: format.hpp:18