F´ Flight Software - C/C++ Documentation  NASA-v2.1.0
A framework for building embedded system applications to NASA flight quality standards.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 char * toChar (void) const =0
 
virtual NATIVE_UINT_TYPE getCapacity (void) const =0
 return size of buffer More...
 
NATIVE_UINT_TYPE length (void) const
 Get length of string. More...
 
const char * operator+= (const char *src)
 Concatenate a char*. More...
 
const StringBaseoperator+= (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...
 
StringBaseoperator= (const char *src)
 Assign char*. More...
 
StringBaseoperator= (const StringBase &src)
 Assign another StringBase. More...
 
void format (const char *formatString,...)
 write formatted string to buffer More...
 
SerializeStatus serialize (SerializeBufferBase &buffer) const
 serialization function More...
 
SerializeStatus deserialize (SerializeBufferBase &buffer)
 deserialization function More...
 

Protected Member Functions

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

Detailed Description

Definition at line 23 of file StringType.hpp.

Constructor & Destructor Documentation

◆ StringBase()

Fw::StringBase::StringBase ( void  )
protected

Definition at line 22 of file StringType.cpp.

◆ ~StringBase()

Fw::StringBase::~StringBase ( void  )
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 106 of file StringType.cpp.

◆ deserialize()

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

deserialization function

Implements Fw::Serializable.

Definition at line 127 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 ( void  ) const
pure virtual

◆ length()

NATIVE_UINT_TYPE Fw::StringBase::length ( void  ) const

Get length of string.

Definition at line 119 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 101 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()

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

serialization function

Implements Fw::Serializable.

Definition at line 123 of file StringType.cpp.

◆ toChar()

virtual const char* Fw::StringBase::toChar ( void  ) const
pure virtual

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