Fw::String Class Reference

#include <Fw/Types/String.hpp>

Inheritance diagram for Fw::String:

Public Types
enum	{ SERIALIZED_TYPE_ID = FW_TYPEID_FIXED_LENGTH_STRING, STRING_SIZE = FW_FIXED_LENGTH_STRING_SIZE, SERIALIZED_SIZE = STATIC_SERIALIZED_SIZE(STRING_SIZE) }
Public Types inherited from Fw::StringBase
using	SizeType = FwSizeType
Public Types inherited from Fw::Serializable
using	SizeType = FwSizeType

Public Member Functions
	String ()
	String (const String &src)
	String (const StringBase &src)
	String (const char *src)
	~String ()
String &	operator= (const String &src)
String &	operator= (const StringBase &src)
String &	operator= (const char *src)
const char *	toChar () const
StringBase::SizeType	getCapacity () const
	return size of buffer More...
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...
FormatStatus	format (const CHAR *formatString,...)
	write formatted string to buffer More...
FormatStatus	vformat (const CHAR *formatString, va_list args)
	write formatted string to buffer using va_list More...
SerializeStatus	serializeTo (SerializeBufferBase &buffer, Endianness mode=Endianness::BIG) const override
	serialize contents to buffer More...
virtual SerializeStatus	serializeTo (SerializeBufferBase &buffer, SizeType maxLen, Endianness mode=Endianness::BIG) const
SerializeStatus	deserializeFrom (SerializeBufferBase &buffer, Endianness mode=Endianness::BIG) override
	deserialize contents from buffer More...
	DEPRECATED (SerializeStatus serialize(SerializeBufferBase &buffer) const, "Use serializeTo(SerializeBufferBase& buffer) instead")
	DEPRECATED (SerializeStatus serialize(SerializeBufferBase &buffer, SizeType maxLen) const, "Use serializeTo(SerializeBufferBase& buffer, SizeType maxLen) instead")
Public Member Functions inherited from Fw::Serializable
	DEPRECATED (SerializeStatus serialize(SerializeBufferBase &buffer) const, "Use serializeTo(SerializeBufferBase& buffer) instead")
	DEPRECATED (SerializeStatus deserialize(SerializeBufferBase &buffer), "Use deserializeFrom(SerializeBufferBase& buffer) instead")

Additional Inherited Members
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...

Detailed Description

Definition at line 17 of file String.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
SERIALIZED_TYPE_ID
STRING_SIZE
SERIALIZED_SIZE

Definition at line 19 of file String.hpp.

Constructor & Destructor Documentation

String() [1/4]

Fw::String::String ( )

inline

Definition at line 25 of file String.hpp.

String() [2/4]

Fw::String::String ( const String &  src )

inline

Definition at line 27 of file String.hpp.

String() [3/4]

Fw::String::String ( const StringBase &  src )

inline

Definition at line 29 of file String.hpp.

String() [4/4]

Fw::String::String ( const char *  src )

inline

Definition at line 31 of file String.hpp.

~String()

Fw::String::~String ( )

inline

Definition at line 33 of file String.hpp.

Member Function Documentation

getCapacity()

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

inlinevirtual

return size of buffer

Implements Fw::StringBase.

Definition at line 52 of file String.hpp.

operator=() [1/3]

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

inline

Definition at line 35 of file String.hpp.

operator=() [2/3]

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

inline

Definition at line 40 of file String.hpp.

operator=() [3/3]

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

inline

Definition at line 45 of file String.hpp.

toChar()

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

inlinevirtual

Implements Fw::StringBase.

Definition at line 50 of file String.hpp.

---

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

• Fw/Types/String.hpp