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::TlmString Class Reference

#include <Fw/Tlm/TlmString.hpp>

Inheritance diagram for Fw::TlmString:
Fw::StringBase Fw::Serializable

Public Types

enum  { SERIALIZED_TYPE_ID = FW_TYPEID_TLM_STR , SERIALIZED_SIZE = FW_TLM_STRING_MAX_SIZE + sizeof(FwBuffSizeType) }
 

Public Member Functions

 TlmString ()
 
 TlmString (const TlmString &src)
 TlmString string constructor.
 
 TlmString (const StringBase &src)
 other string constructor
 
 TlmString (const char *src)
 char* source constructor
 
TlmStringoperator= (const TlmString &other)
 assignment operator
 
TlmStringoperator= (const StringBase &other)
 other string assignment operator
 
TlmStringoperator= (const char *other)
 char* assignment operator
 
 ~TlmString ()
 
const char * toChar () const override
 
NATIVE_UINT_TYPE getCapacity () const override
 return size of buffer
 
SerializeStatus serialize (SerializeBufferBase &buffer) const override
 serialization function
 
SerializeStatus serialize (SerializeBufferBase &buffer, NATIVE_UINT_TYPE maxLen) const override
 serialization function
 
SerializeStatus deserialize (SerializeBufferBase &buffer) override
 deserialization function
 
- Public Member Functions inherited from Fw::StringBase
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
 

Additional Inherited Members

- Protected Member Functions inherited from Fw::StringBase
 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 10 of file TlmString.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_TYPE_ID 
SERIALIZED_SIZE 

Definition at line 13 of file TlmString.hpp.

Constructor & Destructor Documentation

◆ TlmString() [1/4]

Fw::TlmString::TlmString ( )

Definition at line 18 of file TlmString.cpp.

◆ TlmString() [2/4]

Fw::TlmString::TlmString ( const TlmString src)

TlmString string constructor.

Definition at line 14 of file TlmString.cpp.

◆ TlmString() [3/4]

Fw::TlmString::TlmString ( const StringBase src)

other string constructor

Definition at line 10 of file TlmString.cpp.

◆ TlmString() [4/4]

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

char* source constructor

Definition at line 6 of file TlmString.cpp.

◆ ~TlmString()

Fw::TlmString::~TlmString ( )

Definition at line 45 of file TlmString.cpp.

Member Function Documentation

◆ deserialize()

SerializeStatus Fw::TlmString::deserialize ( SerializeBufferBase buffer)
overridevirtual

deserialization function

Reimplemented from Fw::StringBase.

Definition at line 75 of file TlmString.cpp.

◆ getCapacity()

NATIVE_UINT_TYPE Fw::TlmString::getCapacity ( ) const
overridevirtual

return size of buffer

Implements Fw::StringBase.

Definition at line 52 of file TlmString.cpp.

◆ operator=() [1/3]

TlmString & Fw::TlmString::operator= ( const char *  other)

char* assignment operator

Definition at line 40 of file TlmString.cpp.

◆ operator=() [2/3]

TlmString & Fw::TlmString::operator= ( const StringBase other)

other string assignment operator

Definition at line 31 of file TlmString.cpp.

◆ operator=() [3/3]

TlmString & Fw::TlmString::operator= ( const TlmString other)

assignment operator

Definition at line 22 of file TlmString.cpp.

◆ serialize() [1/2]

SerializeStatus Fw::TlmString::serialize ( SerializeBufferBase buffer) const
overridevirtual

serialization function

Reimplemented from Fw::StringBase.

Definition at line 56 of file TlmString.cpp.

◆ serialize() [2/2]

SerializeStatus Fw::TlmString::serialize ( SerializeBufferBase buffer,
NATIVE_UINT_TYPE  maxLen 
) const
overridevirtual

serialization function

Reimplemented from Fw::StringBase.

Definition at line 60 of file TlmString.cpp.

◆ toChar()

const char * Fw::TlmString::toChar ( ) const
overridevirtual

Implements Fw::StringBase.

Definition at line 48 of file TlmString.cpp.


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