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::ConstStringBase
using	SizeType = FwSizeType
Public Types inherited from Fw::Serializable
using	SizeType = FwSizeType

Public Member Functions
	ObjectName ()
	ObjectName (const ObjectName &src)
	ObjectName (const ConstStringBase &src)
	ObjectName (const char *src)
	~ObjectName ()
ObjectName &	operator= (const ObjectName &src)
ObjectName &	operator= (const ConstStringBase &src)
ObjectName &	operator= (const char *src)
const char *	toChar () const
	Convert to a C-style char*. More...
StringBase::SizeType	getCapacity () const
	Return the size of the buffer. More...
Public Member Functions inherited from Fw::StringBase
const CHAR *	operator+= (const CHAR *src)
	Concatenate a CHAR*. More...
const StringBase &	operator+= (const ConstStringBase &src)
	Concatenate a ConstStringBase. More...
const StringBase &	operator+= (const StringBase &src)
	Concatenate a StringBase. More...
StringBase &	operator= (const CHAR *src)
	Assign CHAR*. More...
StringBase &	operator= (const ConstStringBase &src)
	Assign another ConstStringBase. 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	deserializeFrom (SerialBufferBase &buffer, Endianness mode=Endianness::BIG) override
	Deserialize the contents of this object from a buffer. More...
Public Member Functions inherited from Fw::ConstStringBase
virtual SizeType	length () const
	Get the length of the 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
bool	operator== (const ConstStringBase &other) const
	Check for equality with ConstStringBase. More...
bool	operator== (const CHAR *other) const
	Check for equality with CHAR*. More...
bool	operator!= (const ConstStringBase &other) const
	Inequality with ConstStringBase. More...
bool	operator!= (const CHAR *other) const
	Inequality with CHAR*. More...
SerializeStatus	serializeTo (SerialBufferBase &buffer, Endianness mode=Endianness::BIG) const override
	Serialize the contents of this object to a buffer. More...
virtual SerializeStatus	serializeTo (SerialBufferBase &buffer, SizeType maxLen, Endianness mode=Endianness::BIG) const
	DEPRECATED (SerializeStatus serialize(SerialBufferBase &buffer) const, "Use serializeTo(SerializeBufferBase& buffer) instead")
	DEPRECATED (SerializeStatus serialize(SerialBufferBase &buffer, SizeType maxLen) const, "Use serializeTo(SerializeBufferBase& buffer, SizeType maxLen) instead")
Public Member Functions inherited from Fw::Serializable
Serializable &	operator= (const Serializable &src)=default
	TODO: this operator should be deleted, this must be done after RawTime is modified though. More...
	DEPRECATED (SerializeStatus serialize(SerialBufferBase &buffer) const, "Use serializeTo(SerialBufferBase& buffer) instead")
	DEPRECATED (SerializeStatus deserialize(SerialBufferBase &buffer), "Use deserializeFrom(SerialBufferBase& buffer) instead")

Additional Inherited Members
Static Public Member Functions inherited from Fw::ConstStringBase
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::ConstStringBase
	ConstStringBase ()
virtual	~ConstStringBase ()
Protected Member Functions inherited from Fw::Serializable
	Serializable ()
	Default constructor. More...
virtual	~Serializable ()
	Virtual destructor. More...

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 )

inline

Definition at line 27 of file ObjectName.hpp.

ObjectName() [3/4]

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

inline

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 the size of the buffer.

Implements Fw::ConstStringBase.

Definition at line 52 of file ObjectName.hpp.

operator=() [1/3]

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

inline

Definition at line 35 of file ObjectName.hpp.

operator=() [2/3]

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

inline

Definition at line 40 of file ObjectName.hpp.

operator=() [3/3]

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

inline

Definition at line 45 of file ObjectName.hpp.

toChar()

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

inlinevirtual

Convert to a C-style char*.

Implements Fw::ConstStringBase.

Definition at line 50 of file ObjectName.hpp.

---

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

• Fw/Types/ObjectName.hpp