F´ Flight Software - C/C++ Documentation  NASA-v2.1.0
A framework for building embedded system applications to NASA flight quality standards.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PrmString.hpp
Go to the documentation of this file.
1 #ifndef FW_PRM_STRING_TYPE_HPP
2 #define FW_PRM_STRING_TYPE_HPP
3 
6 #include <FpConfig.hpp>
7 #include <Fw/Cfg/SerIds.hpp>
8 
9 namespace Fw {
10 
11  class ParamString : public Fw::StringBase {
12  public:
13 
14  enum {
16  SERIALIZED_SIZE = FW_PARAM_STRING_MAX_SIZE + sizeof(FwBuffSizeType) // size of buffer + storage of two size words
17  };
18 
19  ParamString(const char* src);
20  ParamString(const StringBase& src);
21  ParamString(const ParamString& src);
22  ParamString(void);
23  ParamString& operator=(const ParamString& other);
24  ParamString& operator=(const StringBase& other);
25  ParamString& operator=(const char* other);
26  ~ParamString(void);
27 
28  const char* toChar(void) const;
29  NATIVE_UINT_TYPE getCapacity(void) const;
30 
31  private:
32 
33  char m_buf[FW_PARAM_STRING_MAX_SIZE];
34  };
35 
36 }
37 
38 #endif
StringType.hpp
Declares ISF string base class.
Fw::ParamString::toChar
const char * toChar(void) const
Definition: PrmString.cpp:40
Fw::ParamString::operator=
ParamString & operator=(const ParamString &other)
Definition: PrmString.cpp:22
Fw::StringBase
Definition: StringType.hpp:23
Fw::ParamString::~ParamString
~ParamString(void)
Definition: PrmString.cpp:37
Fw::ParamString::SERIALIZED_TYPE_ID
@ SERIALIZED_TYPE_ID
Definition: PrmString.hpp:15
FW_PARAM_STRING_MAX_SIZE
#define FW_PARAM_STRING_MAX_SIZE
Max size of parameter string type.
Definition: FpConfig.hpp:275
Fw::ParamString::ParamString
ParamString(void)
Definition: PrmString.cpp:18
Fw::ParamString::getCapacity
NATIVE_UINT_TYPE getCapacity(void) const
return size of buffer
Definition: PrmString.cpp:44
NATIVE_UINT_TYPE
unsigned int NATIVE_UINT_TYPE
native unsigned integer type declaration
Definition: BasicTypes.hpp:30
Fw::ParamString::SERIALIZED_SIZE
@ SERIALIZED_SIZE
Definition: PrmString.hpp:16
FpConfig.hpp
ISF configuration file.
Fw::FW_TYPEID_PRM_STR
@ FW_TYPEID_PRM_STR
Parameter string type id.
Definition: SerIds.hpp:52
BasicTypes.hpp
Declares ISF basic types.
SerIds.hpp
Definitions for ISF type serial IDs.
FwBuffSizeType
#define FwBuffSizeType
Type representation for storing a buffer or string size.
Definition: FpConfig.hpp:83
Fw::ParamString
Definition: PrmString.hpp:11
Fw
Definition: Buffer.cpp:21