Fw::ObjectName Class Reference

#include <Fw/Types/ObjectName.hpp>

Inheritance diagram for Fw::ObjectName:

Public Types
enum	{ SERIALIZED_TYPE_ID = FW_TYPEID_OBJECT_NAME , STRING_SIZE = FW_OBJ_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
	ObjectName ()
	ObjectName (const ObjectName &src)
	ObjectName (const StringBase &src)
	ObjectName (const char *src)
	~ObjectName ()
ObjectName &	operator= (const ObjectName &src)
ObjectName &	operator= (const StringBase &src)
ObjectName &	operator= (const char *src)
const char *	toChar () const
StringBase::SizeType	getCapacity () const
	return size of buffer
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
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

Definition at line 17 of file ObjectName.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
SERIALIZED_TYPE_ID
STRING_SIZE
SERIALIZED_SIZE

Definition at line 19 of file ObjectName.hpp.

Constructor & Destructor Documentation

ObjectName() [1/4]

Fw::ObjectName::ObjectName ( )

inline

Definition at line 25 of file ObjectName.hpp.

ObjectName() [2/4]

Fw::ObjectName::ObjectName ( const ObjectName &  src )

inlineexplicit

Definition at line 27 of file ObjectName.hpp.

ObjectName() [3/4]

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

inlineexplicit

Definition at line 29 of file ObjectName.hpp.

ObjectName() [4/4]

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

inlineexplicit

Definition at line 31 of file ObjectName.hpp.

~ObjectName()

Fw::ObjectName::~ObjectName ( )

inline

Definition at line 33 of file ObjectName.hpp.

Member Function Documentation

getCapacity()

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

inlinevirtual

return size of buffer

Implements Fw::StringBase.

Definition at line 52 of file ObjectName.hpp.

operator=() [1/3]

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

inline

Definition at line 45 of file ObjectName.hpp.

operator=() [2/3]

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

inline

Definition at line 35 of file ObjectName.hpp.

operator=() [3/3]

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

inline

Definition at line 40 of file ObjectName.hpp.

toChar()

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

inlinevirtual

Implements Fw::StringBase.

Definition at line 50 of file ObjectName.hpp.

---

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

• Fw/Types/ObjectName.hpp