Fw::ExternalString Class Reference

A string backed by an external buffer. More...

#include <Fw/Types/ExternalString.hpp>

Inheritance diagram for Fw::ExternalString:

Public Member Functions
	ExternalString (const ExternalString &)=delete
	Deleted copy constructor.
	ExternalString ()
	Constructor (uninitialized buffer)
	ExternalString (char *bufferPtr, StringBase::SizeType bufferSize)
	Constructor (bufferPtr and bufferSize)
	ExternalString (char *bufferPtr, StringBase::SizeType bufferSize, const StringBase &sb)
	Constructor (bufferPtr, bufferSize, and StringBase)
	ExternalString (char *bufferPtr, StringBase::SizeType bufferSize, const char *str)
	Constructor (bufferPtr, bufferSize, and const char*)
	~ExternalString ()
	Destructor.
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.
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.
SizeType	maxLength () const
	Get the maximum length of a string that the buffer can hold (which is capacity - 1)
SizeType	serializedSize () const
SizeType	serializedTruncatedSize (FwSizeType maxLength) const
const CHAR *	operator+= (const CHAR *src)
	Concatenate a CHAR*.
const StringBase &	operator+= (const StringBase &src)
	Concatenate a StringBase.
bool	operator== (const StringBase &other) const
	Check for equality with StringBase.
bool	operator== (const CHAR *other) const
	Check for equality with CHAR*.
bool	operator!= (const StringBase &other) const
	Inequality with StringBase.
bool	operator!= (const CHAR *other) const
	Inequality with CHAR*.
StringBase &	operator= (const CHAR *src)
	Assign CHAR*.
StringBase &	operator= (const StringBase &src)
	Assign another StringBase.
void	format (const CHAR *formatString,...)
	write formatted string to buffer
void	vformat (const CHAR *formatString, va_list args)
	write formatted string to buffer using va_list
virtual SerializeStatus	serialize (SerializeBufferBase &buffer) const
	serialization function
virtual SerializeStatus	serialize (SerializeBufferBase &buffer, SizeType maxLen) const
	serialization function
virtual SerializeStatus	deserialize (SerializeBufferBase &buffer)
	deserialization function

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.
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.
virtual	~Serializable ()
	destructor

Detailed Description

A string backed by an external buffer.

Definition at line 17 of file ExternalString.hpp.

Constructor & Destructor Documentation

ExternalString() [1/5]

Fw::ExternalString::ExternalString ( const ExternalString &  )

delete

Deleted copy constructor.

ExternalString() [2/5]

Fw::ExternalString::ExternalString ( )

inline

Constructor (uninitialized buffer)

Definition at line 27 of file ExternalString.hpp.

ExternalString() [3/5]

Fw::ExternalString::ExternalString ( char *  bufferPtr, StringBase::SizeType  bufferSize  )

inline

Constructor (bufferPtr and bufferSize)

Parameters

bufferPtr	The buffer pointer
bufferSize	The buffer size

Definition at line 30 of file ExternalString.hpp.

ExternalString() [4/5]

Fw::ExternalString::ExternalString ( char *  bufferPtr, StringBase::SizeType  bufferSize, const StringBase &  sb  )

inline

Constructor (bufferPtr, bufferSize, and StringBase)

Parameters

bufferPtr	The buffer pointer
bufferSize	The buffer size
sb	The source string

Definition at line 38 of file ExternalString.hpp.

ExternalString() [5/5]

Fw::ExternalString::ExternalString ( char *  bufferPtr, StringBase::SizeType  bufferSize, const char *  str  )

inline

Constructor (bufferPtr, bufferSize, and const char*)

Parameters

bufferPtr	The buffer pointer
bufferSize	The buffer size
str	The source string

Definition at line 47 of file ExternalString.hpp.

~ExternalString()

Fw::ExternalString::~ExternalString ( )

inline

Destructor.

Definition at line 56 of file ExternalString.hpp.

Member Function Documentation

getCapacity()

StringBase::SizeType Fw::ExternalString::getCapacity ( ) const

inlinevirtual

Returns the buffer size

Returns

The buffer size

Implements Fw::StringBase.

Definition at line 69 of file ExternalString.hpp.

operator=() [1/3]

ExternalString & Fw::ExternalString::operator= ( const char *  src )

inline

Definition at line 103 of file ExternalString.hpp.

operator=() [2/3]

ExternalString & Fw::ExternalString::operator= ( const ExternalString &  src )

inline

Definition at line 91 of file ExternalString.hpp.

operator=() [3/3]

ExternalString & Fw::ExternalString::operator= ( const StringBase &  src )

inline

Definition at line 97 of file ExternalString.hpp.

setBuffer()

void Fw::ExternalString::setBuffer ( char *  bufferPtr, StringBase::SizeType  bufferSize  )

inline

Set the buffer and initialize it to the empty string.

Parameters

bufferPtr	The buffer pointer
bufferSize	The buffer size

Definition at line 77 of file ExternalString.hpp.

toChar()

const char * Fw::ExternalString::toChar ( ) const

inlinevirtual

Gets the char buffer

Returns

The char buffer

Implements Fw::StringBase.

Definition at line 65 of file ExternalString.hpp.

---

The documentation for this class was generated from the following file:

• Fw/Types/ExternalString.hpp