F´ Flight Software - C/C++ Documentation  NASA-v2.0.1
A framework for building embedded system applications to NASA flight quality standards.
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(void);
24  const char* toChar(void) const;
25  NATIVE_UINT_TYPE length(void) const;
26 
27  const ParamString& operator=(const ParamString& 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_PARAM_STRING_MAX_SIZE];
38  };
39 
40 }
41 
42 #endif
StringType.hpp
Declares ISF string base class.
Fw::ParamString::toChar
const char * toChar(void) const
Definition: PrmString.cpp:34
Fw::SerializeBufferBase
Definition: Serializable.hpp:43
Fw::SerializeStatus
SerializeStatus
forward declaration for string
Definition: Serializable.hpp:14
Fw::StringBase
Definition: StringType.hpp:23
Fw::ParamString::~ParamString
~ParamString(void)
Definition: PrmString.cpp:27
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:271
Fw::ParamString::operator=
const ParamString & operator=(const ParamString &other)
equal operator for other strings
Definition: PrmString.cpp:73
Fw::ParamString::length
NATIVE_UINT_TYPE length(void) const
Get length of string.
Definition: PrmString.cpp:30
Fw::ParamString::ParamString
ParamString(void)
Definition: PrmString.cpp:23
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
Fw::ParamString::deserialize
SerializeStatus deserialize(SerializeBufferBase &buffer)
deserialize to contents
Definition: PrmString.cpp:54
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:79
Fw::ParamString
Definition: PrmString.hpp:11
Fw
Definition: Buffer.cpp:21
Fw::ParamString::serialize
SerializeStatus serialize(SerializeBufferBase &buffer) const
serialize contents
Definition: PrmString.cpp:48