F´ Flight Software - C/C++ Documentation  NASA-v2.0.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::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 (const char *src)
 
 TlmString (const StringBase &src)
 
 TlmString (const TlmString &src)
 
 TlmString (void)
 
 ~TlmString (void)
 
const char * toChar (void) const
 
NATIVE_UINT_TYPE length (void) const
 Get length of string. More...
 
void setMaxSerialize (NATIVE_UINT_TYPE size)
 
const TlmStringoperator= (const TlmString &other)
 equal operator for other strings More...
 
SerializeStatus serialize (SerializeBufferBase &buffer) const
 serialize contents More...
 
SerializeStatus deserialize (SerializeBufferBase &buffer)
 deserialize to contents More...
 
- Public Member Functions inherited from Fw::StringBase
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...
 
const char * operator= (const char *src)
 Assign char*. More...
 
const StringBaseoperator= (const StringBase &src)
 Assign another StringBase. More...
 
void appendBuff (const char *buff, NATIVE_UINT_TYPE size)
 
void format (const char *formatString,...)
 write formatted string to buffer More...
 

Additional Inherited Members

- Protected Member Functions inherited from Fw::StringBase
 StringBase (void)
 
virtual ~StringBase (void)
 
- Protected Member Functions inherited from Fw::Serializable
 Serializable ()
 Default constructor. More...
 
virtual ~Serializable ()
 destructor More...
 

Detailed Description

Definition at line 11 of file TlmString.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_TYPE_ID 
SERIALIZED_SIZE 

Definition at line 14 of file TlmString.hpp.

Constructor & Destructor Documentation

◆ TlmString() [1/4]

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

Definition at line 11 of file TlmString.cpp.

◆ TlmString() [2/4]

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

Definition at line 15 of file TlmString.cpp.

◆ TlmString() [3/4]

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

Definition at line 19 of file TlmString.cpp.

◆ TlmString() [4/4]

Fw::TlmString::TlmString ( void  )

Definition at line 23 of file TlmString.cpp.

◆ ~TlmString()

Fw::TlmString::~TlmString ( void  )

Definition at line 27 of file TlmString.cpp.

Member Function Documentation

◆ deserialize()

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

deserialize to contents

Implements Fw::Serializable.

Definition at line 69 of file TlmString.cpp.

◆ length()

NATIVE_UINT_TYPE Fw::TlmString::length ( void  ) const
virtual

Get length of string.

Implements Fw::StringBase.

Definition at line 30 of file TlmString.cpp.

◆ operator=()

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

equal operator for other strings

Definition at line 108 of file TlmString.cpp.

◆ serialize()

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

serialize contents

Implements Fw::Serializable.

Definition at line 48 of file TlmString.cpp.

◆ setMaxSerialize()

void Fw::TlmString::setMaxSerialize ( NATIVE_UINT_TYPE  size)

Definition at line 95 of file TlmString.cpp.

◆ toChar()

const char * Fw::TlmString::toChar ( void  ) const
virtual

Implements Fw::StringBase.

Definition at line 34 of file TlmString.cpp.


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