F´ Flight Software - C/C++ Documentation
devel
A framework for building embedded system applications to NASA flight quality standards.
|
A string backed by an external buffer. More...
#include <Fw/Types/ExternalString.hpp>
Public Member Functions | |
ExternalString (const ExternalString &)=delete | |
Deleted copy constructor. More... | |
ExternalString () | |
Constructor (uninitialized buffer) More... | |
ExternalString (char *bufferPtr, StringBase::SizeType bufferSize) | |
Constructor (bufferPtr and bufferSize) More... | |
ExternalString (char *bufferPtr, StringBase::SizeType bufferSize, const StringBase &sb) | |
Constructor (bufferPtr, bufferSize, and StringBase) More... | |
ExternalString (char *bufferPtr, StringBase::SizeType bufferSize, const char *str) | |
Constructor (bufferPtr, bufferSize, and const char*) More... | |
~ExternalString () | |
Destructor. More... | |
const char * | toChar () const |
StringBase::SizeType | getCapacity () const |
void | setBuffer (char *bufferPtr, StringBase::SizeType bufferSize) |
Set the buffer and initialize it to the empty string. More... | |
ExternalString & | operator= (const ExternalString &src) |
ExternalString & | operator= (const StringBase &src) |
ExternalString & | operator= (const char *src) |
Public Member Functions inherited from Fw::StringBase | |
SizeType | length () const |
Get length of string. More... | |
SizeType | maxLength () const |
Get the maximum length of a string that the buffer can hold (which is capacity - 1) More... | |
SizeType | serializedSize () const |
SizeType | serializedTruncatedSize (FwSizeType maxLength) const |
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... | |
StringBase & | operator= (const CHAR *src) |
Assign CHAR*. More... | |
StringBase & | operator= (const StringBase &src) |
Assign another StringBase. More... | |
void | format (const CHAR *formatString,...) |
write formatted string to buffer More... | |
void | vformat (const CHAR *formatString, va_list args) |
write formatted string to buffer using va_list More... | |
virtual SerializeStatus | serialize (SerializeBufferBase &buffer) const |
serialization function More... | |
virtual SerializeStatus | serialize (SerializeBufferBase &buffer, SizeType maxLen) const |
serialization function More... | |
virtual SerializeStatus | deserialize (SerializeBufferBase &buffer) |
deserialization function More... | |
Additional Inherited Members | |
Public Types inherited from Fw::StringBase | |
using | SizeType = NATIVE_UINT_TYPE |
Public Types inherited from Fw::Serializable | |
using | SizeType = NATIVE_UINT_TYPE |
Static Public Member Functions inherited from Fw::StringBase | |
static constexpr SizeType | STATIC_SERIALIZED_SIZE (SizeType maxLength) |
static constexpr SizeType | BUFFER_SIZE (SizeType maxLength) |
Get the size of a null-terminated string buffer. More... | |
Protected Member Functions inherited from Fw::StringBase | |
StringBase () | |
virtual | ~StringBase () |
void | appendBuff (const CHAR *buff, SizeType size) |
Protected Member Functions inherited from Fw::Serializable | |
Serializable () | |
Default constructor. More... | |
virtual | ~Serializable () |
destructor More... | |
A string backed by an external buffer.
Definition at line 17 of file ExternalString.hpp.
|
delete |
Deleted copy constructor.
|
inline |
Constructor (uninitialized buffer)
Definition at line 27 of file ExternalString.hpp.
|
inline |
Constructor (bufferPtr and bufferSize)
bufferPtr | The buffer pointer |
bufferSize | The buffer size |
Definition at line 30 of file ExternalString.hpp.
|
inline |
Constructor (bufferPtr, bufferSize, and StringBase)
bufferPtr | The buffer pointer |
bufferSize | The buffer size |
sb | The source string |
Definition at line 38 of file ExternalString.hpp.
|
inline |
Constructor (bufferPtr, bufferSize, and const char*)
bufferPtr | The buffer pointer |
bufferSize | The buffer size |
str | The source string |
Definition at line 47 of file ExternalString.hpp.
|
inline |
Destructor.
Definition at line 56 of file ExternalString.hpp.
|
inlinevirtual |
Returns the buffer size
Implements Fw::StringBase.
Definition at line 69 of file ExternalString.hpp.
|
inline |
Definition at line 103 of file ExternalString.hpp.
|
inline |
Definition at line 91 of file ExternalString.hpp.
|
inline |
Definition at line 97 of file ExternalString.hpp.
|
inline |
Set the buffer and initialize it to the empty string.
bufferPtr | The buffer pointer |
bufferSize | The buffer size |
Definition at line 77 of file ExternalString.hpp.
|
inlinevirtual |
Gets the char buffer
Implements Fw::StringBase.
Definition at line 65 of file ExternalString.hpp.