F´ Flight Software - C/C++ Documentation  NASA-v2.0.1
A framework for building embedded system applications to NASA flight quality standards.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
TextLogString.hpp
Go to the documentation of this file.
1 #ifndef FW_TEXT_LOG_STRING_TYPE_HPP
2 #define FW_TEXT_LOG_STRING_TYPE_HPP
3 
6 #include <FpConfig.hpp>
7 #include <Fw/Cfg/SerIds.hpp>
8 
9 namespace Fw {
10 
11  class TextLogString : public Fw::StringBase {
12  public:
13 
14  enum {
16  SERIALIZED_SIZE = FW_LOG_TEXT_BUFFER_SIZE + sizeof(FwBuffSizeType) // size of buffer + storage of two size words
17  };
18 
19  TextLogString(const char* src);
20  TextLogString(const StringBase& src);
21  TextLogString(const TextLogString& src);
22  TextLogString(void);
23  ~TextLogString(void);
24  const char* toChar(void) const;
25  NATIVE_UINT_TYPE length(void) const;
26 
27  const TextLogString& operator=(const TextLogString& other);
28 
31 
32  private:
33  void copyBuff(const char* buff, NATIVE_UINT_TYPE size);
34  NATIVE_UINT_TYPE getCapacity(void) const ;
35  void terminate(NATIVE_UINT_TYPE size);
36 
37  char m_buf[FW_LOG_TEXT_BUFFER_SIZE];
38  };
39 
40 }
41 
42 #endif
StringType.hpp
Declares ISF string base class.
Fw::TextLogString
Definition: TextLogString.hpp:11
Fw::TextLogString::serialize
SerializeStatus serialize(SerializeBufferBase &buffer) const
serialize contents
Definition: TextLogString.cpp:48
Fw::SerializeBufferBase
Definition: Serializable.hpp:43
Fw::SerializeStatus
SerializeStatus
forward declaration for string
Definition: Serializable.hpp:14
Fw::StringBase
Definition: StringType.hpp:23
Fw::TextLogString::SERIALIZED_SIZE
@ SERIALIZED_SIZE
Definition: TextLogString.hpp:16
Fw::FW_TYPEID_LOG_STR
@ FW_TYPEID_LOG_STR
Log string type id.
Definition: SerIds.hpp:50
Fw::TextLogString::length
NATIVE_UINT_TYPE length(void) const
Get length of string.
Definition: TextLogString.cpp:30
NATIVE_UINT_TYPE
unsigned int NATIVE_UINT_TYPE
native unsigned integer type declaration
Definition: BasicTypes.hpp:30
Fw::TextLogString::toChar
const char * toChar(void) const
Definition: TextLogString.cpp:34
Fw::TextLogString::TextLogString
TextLogString(void)
Definition: TextLogString.cpp:23
Fw::TextLogString::operator=
const TextLogString & operator=(const TextLogString &other)
equal operator for other strings
Definition: TextLogString.cpp:73
FpConfig.hpp
ISF configuration file.
Fw::TextLogString::SERIALIZED_TYPE_ID
@ SERIALIZED_TYPE_ID
Definition: TextLogString.hpp:15
BasicTypes.hpp
Declares ISF basic types.
SerIds.hpp
Definitions for ISF type serial IDs.
Fw::TextLogString::~TextLogString
~TextLogString(void)
Definition: TextLogString.cpp:27
FwBuffSizeType
#define FwBuffSizeType
Type representation for storing a buffer or string size.
Definition: FpConfig.hpp:79
Fw
Definition: Buffer.cpp:21
Fw::TextLogString::deserialize
SerializeStatus deserialize(SerializeBufferBase &buffer)
deserialize to contents
Definition: TextLogString.cpp:54
FW_LOG_TEXT_BUFFER_SIZE
#define FW_LOG_TEXT_BUFFER_SIZE
Max size of string for text log message.
Definition: FpConfig.hpp:291