Fw::TlmString Class Reference
#include <Fw/Tlm/TlmString.hpp>
Inheritance diagram for Fw::TlmString:
Public Types | |
| enum | { SERIALIZED_TYPE_ID = FW_TYPEID_TLM_STR, SERIALIZED_SIZE = FW_TLM_STRING_MAX_SIZE + sizeof(FwBuffSizeType) } |
Public Member Functions | |
| TlmString (const char *src) | |
| TlmString (const StringBase &src) | |
| TlmString (const TlmString &src) | |
| TlmString (void) | |
| ~TlmString (void) | |
| const char * | toChar (void) const |
| NATIVE_UINT_TYPE | length (void) const |
| Get length of string. More... | |
| void | setMaxSerialize (NATIVE_UINT_TYPE size) |
| const TlmString & | operator= (const TlmString &other) |
| equal operator for other strings More... | |
| SerializeStatus | serialize (SerializeBufferBase &buffer) const |
| serialize contents More... | |
| SerializeStatus | deserialize (SerializeBufferBase &buffer) |
| deserialize to contents More... | |
| NATIVE_UINT_TYPE | getCapacity (void) const |
| return size of buffer More... | |
| void | terminate (NATIVE_UINT_TYPE size) |
| terminate the string More... | |
 Public Member Functions inherited from Fw::StringBase | |
| const char * | operator+= (const char *src) |
| Concatenate a char*. More... | |
| const StringBase & | operator+= (const StringBase &src) |
| Concatenate a StringBase. More... | |
| bool | operator== (const StringBase &other) const |
| Check for equality with StringBase. More... | |
| bool | operator== (const char *other) const |
| Check for equality with char*. More... | |
| bool | operator!= (const StringBase &other) const |
| Inequality with StringBase. More... | |
| bool | operator!= (const char *other) const |
| Inequality with char*. More... | |
| const char * | operator= (const char *src) |
| Assign char*. More... | |
| const StringBase & | operator= (const StringBase &src) |
| Assign another StringBase. More... | |
| void | appendBuff (const char *buff, NATIVE_UINT_TYPE size) |
| void | format (const char *formatString,...) |
| write formatted string to buffer More... | |
Public Attributes | |
| PRIVATE | __pad0__: void copyBuff(const char* buff |
| PRIVATE NATIVE_UINT_TYPE | size |
| char | m_buf [FW_TLM_STRING_MAX_SIZE] |
| NATIVE_UINT_TYPE | m_maxSer |
Additional Inherited Members | |
| Protected Member Functions inherited from Fw::StringBase | |
| StringBase (void) | |
| virtual | ~StringBase (void) |
| virtual void | copyBuff (const char *buff, NATIVE_UINT_TYPE size)=0 |
| Protected Member Functions inherited from Fw::Serializable | |
| Serializable () | |
| Default constructor. More... | |
| virtual | ~Serializable () |
| destructor More... | |
| Protected Attributes inherited from Fw::StringBase | |
| PRIVATE | __pad0__: StringBase(const StringBase &src) |
| constructor with buffer as source More... | |
Detailed Description
Definition at line 11 of file TlmString.hpp.
Member Enumeration Documentation
◆ anonymous enum
| anonymous enum |
| Enumerator | |
|---|---|
| SERIALIZED_TYPE_ID | |
| SERIALIZED_SIZE | |
Definition at line 14 of file TlmString.hpp.
Constructor & Destructor Documentation
◆ TlmString() [1/4]
| Fw::TlmString::TlmString | ( | const char * | src | ) |
Definition at line 11 of file TlmString.cpp.
◆ TlmString() [2/4]
| Fw::TlmString::TlmString | ( | const StringBase & | src | ) |
Definition at line 15 of file TlmString.cpp.
◆ TlmString() [3/4]
| Fw::TlmString::TlmString | ( | const TlmString & | src | ) |
Definition at line 19 of file TlmString.cpp.
◆ TlmString() [4/4]
| Fw::TlmString::TlmString | ( | void | ) |
Definition at line 23 of file TlmString.cpp.
◆ ~TlmString()
| Fw::TlmString::~TlmString | ( | void | ) |
Definition at line 27 of file TlmString.cpp.
Member Function Documentation
◆ deserialize()
|
virtual |
◆ getCapacity()
|
virtual |
◆ length()
|
virtual |
◆ operator=()
equal operator for other strings
Definition at line 108 of file TlmString.cpp.
◆ serialize()
|
virtual |
◆ setMaxSerialize()
| void Fw::TlmString::setMaxSerialize | ( | NATIVE_UINT_TYPE | size | ) |
Definition at line 95 of file TlmString.cpp.
◆ terminate()
| void Fw::TlmString::terminate | ( | NATIVE_UINT_TYPE | size | ) |
terminate the string
Definition at line 103 of file TlmString.cpp.
◆ toChar()
|
virtual |
Implements Fw::StringBase.
Definition at line 34 of file TlmString.cpp.
Member Data Documentation
◆ __pad0__
| PRIVATE Fw::TlmString::__pad0__ |
Definition at line 36 of file TlmString.hpp.
◆ m_buf
| char Fw::TlmString::m_buf[FW_TLM_STRING_MAX_SIZE] |
Definition at line 41 of file TlmString.hpp.
◆ m_maxSer
| NATIVE_UINT_TYPE Fw::TlmString::m_maxSer |
Definition at line 42 of file TlmString.hpp.
◆ size
| PRIVATE NATIVE_UINT_TYPE Fw::TlmString::size |
Definition at line 37 of file TlmString.hpp.
The documentation for this class was generated from the following files:
- Fw/Tlm/TlmString.hpp
- Fw/Tlm/TlmString.cpp
