Os::TaskString Class Reference

#include <Os/TaskString.hpp>

Inheritance diagram for Os::TaskString:

Public Types
enum	{ STRING_SIZE = FW_TASK_NAME_BUFFER_SIZE , SERIALIZED_SIZE = STATIC_SERIALIZED_SIZE(STRING_SIZE) }
Public Types inherited from Fw::StringBase
using	SizeType = NATIVE_UINT_TYPE
Public Types inherited from Fw::Serializable
using	SizeType = NATIVE_UINT_TYPE

Public Member Functions
	TaskString ()
	TaskString (const TaskString &src)
	TaskString (const StringBase &src)
	TaskString (const char *src)
	~TaskString ()
TaskString &	operator= (const TaskString &src)
TaskString &	operator= (const StringBase &src)
TaskString &	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...
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
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 16 of file TaskString.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
STRING_SIZE
SERIALIZED_SIZE

Definition at line 18 of file TaskString.hpp.

Constructor & Destructor Documentation

TaskString() [1/4]

Os::TaskString::TaskString ( )

inline

Definition at line 20 of file TaskString.hpp.

TaskString() [2/4]

Os::TaskString::TaskString ( const TaskString &  src )

inlineexplicit

Definition at line 22 of file TaskString.hpp.

TaskString() [3/4]

Os::TaskString::TaskString ( const StringBase &  src )

inlineexplicit

Definition at line 24 of file TaskString.hpp.

TaskString() [4/4]

Os::TaskString::TaskString ( const char *  src )

inlineexplicit

Definition at line 26 of file TaskString.hpp.

~TaskString()

Os::TaskString::~TaskString ( )

inline

Definition at line 28 of file TaskString.hpp.

Member Function Documentation

getCapacity()

StringBase::SizeType Os::TaskString::getCapacity ( ) const

inlinevirtual

return size of buffer

Implements Fw::StringBase.

Definition at line 47 of file TaskString.hpp.

operator=() [1/3]

TaskString& Os::TaskString::operator= ( const char *  src )

inline

Definition at line 40 of file TaskString.hpp.

operator=() [2/3]

TaskString& Os::TaskString::operator= ( const StringBase &  src )

inline

Definition at line 35 of file TaskString.hpp.

operator=() [3/3]

TaskString& Os::TaskString::operator= ( const TaskString &  src )

inline

Definition at line 30 of file TaskString.hpp.

toChar()

const char* Os::TaskString::toChar ( ) const

inlinevirtual

Implements Fw::StringBase.

Definition at line 45 of file TaskString.hpp.

---

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

• Os/TaskString.hpp