F´ Flight Software - C/C++ Documentation NASA-v1.6.0
A framework for building embedded system applications to NASA flight quality standards.
Loading...
Searching...
No Matches
Fw::StringBase Class Referenceabstract

#include <Fw/Types/StringType.hpp>

Inheritance diagram for Fw::StringBase:
Fw::Serializable Fw::CmdStringArg Fw::EightyCharString Fw::InternalInterfaceString Fw::LogStringArg Fw::ParamString Fw::String Fw::TextLogString Fw::TlmString Os::QueueString Os::TaskString

Public Member Functions

virtual const CHARtoChar () const =0
 
virtual NATIVE_UINT_TYPE getCapacity () const =0
 return size of buffer
 
NATIVE_UINT_TYPE length () const
 Get length of string.
 
const CHARoperator+= (const CHAR *src)
 Concatenate a CHAR*.
 
const StringBaseoperator+= (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*.
 
StringBaseoperator= (const CHAR *src)
 Assign CHAR*.
 
StringBaseoperator= (const StringBase &src)
 Assign another StringBase.
 
void format (const CHAR *formatString,...)
 write formatted string to buffer
 
virtual SerializeStatus serialize (SerializeBufferBase &buffer) const
 serialization function
 
virtual SerializeStatus serialize (SerializeBufferBase &buffer, NATIVE_UINT_TYPE maxLen) const
 serialization function
 
virtual SerializeStatus deserialize (SerializeBufferBase &buffer)
 deserialization function
 
virtual SerializeStatus serialize (SerializeBufferBase &buffer) const =0
 serialize contents
 
virtual SerializeStatus deserialize (SerializeBufferBase &buffer)=0
 deserialize to contents
 

Protected Member Functions

 StringBase ()
 
virtual ~StringBase ()
 
void appendBuff (const CHAR *buff, NATIVE_UINT_TYPE size)
 
- Protected Member Functions inherited from Fw::Serializable
 Serializable ()
 Default constructor.
 
virtual ~Serializable ()
 destructor
 

Detailed Description

Definition at line 23 of file StringType.hpp.

Constructor & Destructor Documentation

◆ StringBase()

Fw::StringBase::StringBase ( )
protected

Definition at line 22 of file StringType.cpp.

◆ ~StringBase()

Fw::StringBase::~StringBase ( )
protectedvirtual

Definition at line 25 of file StringType.cpp.

Member Function Documentation

◆ appendBuff()

void Fw::StringBase::appendBuff ( const CHAR buff,
NATIVE_UINT_TYPE  size 
)
protected

Definition at line 110 of file StringType.cpp.

◆ deserialize()

SerializeStatus Fw::StringBase::deserialize ( SerializeBufferBase buffer)
virtual

deserialization function

Implements Fw::Serializable.

Reimplemented in Fw::LogStringArg, and Fw::TlmString.

Definition at line 136 of file StringType.cpp.

◆ format()

void Fw::StringBase::format ( const CHAR formatString,
  ... 
)

write formatted string to buffer

Definition at line 60 of file StringType.cpp.

◆ getCapacity()

virtual NATIVE_UINT_TYPE Fw::StringBase::getCapacity ( ) const
pure virtual

◆ length()

NATIVE_UINT_TYPE Fw::StringBase::length ( ) const

Get length of string.

Definition at line 123 of file StringType.cpp.

◆ operator!=() [1/2]

bool Fw::StringBase::operator!= ( const CHAR other) const

Inequality with CHAR*.

Definition at line 76 of file StringType.cpp.

◆ operator!=() [2/2]

bool Fw::StringBase::operator!= ( const StringBase other) const

Inequality with StringBase.

Definition at line 72 of file StringType.cpp.

◆ operator+=() [1/2]

const CHAR * Fw::StringBase::operator+= ( const CHAR src)

Concatenate a CHAR*.

Definition at line 28 of file StringType.cpp.

◆ operator+=() [2/2]

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

Concatenate a StringBase.

Definition at line 33 of file StringType.cpp.

◆ operator=() [1/2]

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

Assign CHAR*.

Definition at line 105 of file StringType.cpp.

◆ operator=() [2/2]

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

Assign another StringBase.

Definition at line 94 of file StringType.cpp.

◆ operator==() [1/2]

bool Fw::StringBase::operator== ( const CHAR other) const

Check for equality with CHAR*.

Definition at line 47 of file StringType.cpp.

◆ operator==() [2/2]

bool Fw::StringBase::operator== ( const StringBase other) const

Check for equality with StringBase.

Definition at line 38 of file StringType.cpp.

◆ serialize() [1/2]

SerializeStatus Fw::StringBase::serialize ( SerializeBufferBase buffer) const
virtual

serialization function

Implements Fw::Serializable.

Reimplemented in Fw::LogStringArg, and Fw::TlmString.

Definition at line 127 of file StringType.cpp.

◆ serialize() [2/2]

SerializeStatus Fw::StringBase::serialize ( SerializeBufferBase buffer,
NATIVE_UINT_TYPE  maxLen 
) const
virtual

serialization function

Reimplemented in Fw::LogStringArg, and Fw::TlmString.

Definition at line 131 of file StringType.cpp.

◆ toChar()


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