F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
Fw::LogStringArg Class Reference

#include <Fw/Log/LogString.hpp>

Inheritance diagram for Fw::LogStringArg:
Fw::StringBase Fw::Serializable

Public Types

enum  { SERIALIZED_TYPE_ID = FW_TYPEID_LOG_STR , SERIALIZED_SIZE = FW_LOG_STRING_MAX_SIZE + sizeof(FwBuffSizeType) }
 

Public Member Functions

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

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. More...
 
virtual ~Serializable ()
 destructor More...
 

Detailed Description

Definition at line 10 of file LogString.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_TYPE_ID 
SERIALIZED_SIZE 

Definition at line 13 of file LogString.hpp.

Constructor & Destructor Documentation

◆ LogStringArg() [1/4]

Fw::LogStringArg::LogStringArg ( )

Definition at line 18 of file LogString.cpp.

◆ LogStringArg() [2/4]

Fw::LogStringArg::LogStringArg ( const LogStringArg src)

LogStringArg string constructor.

Definition at line 14 of file LogString.cpp.

◆ LogStringArg() [3/4]

Fw::LogStringArg::LogStringArg ( const StringBase src)

other string constructor

Definition at line 10 of file LogString.cpp.

◆ LogStringArg() [4/4]

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

char* source constructor

Definition at line 6 of file LogString.cpp.

◆ ~LogStringArg()

Fw::LogStringArg::~LogStringArg ( )

Definition at line 46 of file LogString.cpp.

Member Function Documentation

◆ deserialize()

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

deserialization function

Reimplemented from Fw::StringBase.

Definition at line 76 of file LogString.cpp.

◆ getCapacity()

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

return size of buffer

Implements Fw::StringBase.

Definition at line 53 of file LogString.cpp.

◆ operator=() [1/3]

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

char* assignment operator

Definition at line 41 of file LogString.cpp.

◆ operator=() [2/3]

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

assignment operator

Definition at line 23 of file LogString.cpp.

◆ operator=() [3/3]

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

other string assignment operator

Definition at line 32 of file LogString.cpp.

◆ serialize() [1/2]

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

serialization function

Reimplemented from Fw::StringBase.

Definition at line 57 of file LogString.cpp.

◆ serialize() [2/2]

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

serialization function

Reimplemented from Fw::StringBase.

Definition at line 61 of file LogString.cpp.

◆ toChar()

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

Implements Fw::StringBase.

Definition at line 49 of file LogString.cpp.


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