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

#include <Fw/Cmd/CmdString.hpp>

Inheritance diagram for Fw::CmdStringArg:
Fw::StringBase Fw::Serializable

Public Types

enum  { SERIALIZED_TYPE_ID = FW_TYPEID_CMD_STR , SERIALIZED_SIZE = FW_CMD_STRING_MAX_SIZE + sizeof(FwBuffSizeType) }
 

Public Member Functions

 CmdStringArg (const char *src)
 
 CmdStringArg (const StringBase &src)
 
 CmdStringArg (const CmdStringArg &src)
 
 CmdStringArg ()
 
CmdStringArgoperator= (const CmdStringArg &other)
 
CmdStringArgoperator= (const StringBase &other)
 
CmdStringArgoperator= (const char *other)
 
 ~CmdStringArg ()
 
const char * toChar () const
 
NATIVE_UINT_TYPE getCapacity () const
 return buffer size 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...
 
virtual SerializeStatus serialize (SerializeBufferBase &buffer) const
 serialization function More...
 
virtual SerializeStatus serialize (SerializeBufferBase &buffer, NATIVE_UINT_TYPE maxLen) const
 serialization function More...
 
virtual SerializeStatus deserialize (SerializeBufferBase &buffer)
 deserialization function 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 CmdString.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_TYPE_ID 
SERIALIZED_SIZE 

Definition at line 13 of file CmdString.hpp.

Constructor & Destructor Documentation

◆ CmdStringArg() [1/4]

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

Definition at line 6 of file CmdString.cpp.

◆ CmdStringArg() [2/4]

Fw::CmdStringArg::CmdStringArg ( const StringBase src)

Definition at line 10 of file CmdString.cpp.

◆ CmdStringArg() [3/4]

Fw::CmdStringArg::CmdStringArg ( const CmdStringArg src)

Definition at line 14 of file CmdString.cpp.

◆ CmdStringArg() [4/4]

Fw::CmdStringArg::CmdStringArg ( )

Definition at line 18 of file CmdString.cpp.

◆ ~CmdStringArg()

Fw::CmdStringArg::~CmdStringArg ( )

Definition at line 45 of file CmdString.cpp.

Member Function Documentation

◆ getCapacity()

NATIVE_UINT_TYPE Fw::CmdStringArg::getCapacity ( ) const
virtual

return buffer size

Implements Fw::StringBase.

Definition at line 52 of file CmdString.cpp.

◆ operator=() [1/3]

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

Definition at line 40 of file CmdString.cpp.

◆ operator=() [2/3]

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

Definition at line 22 of file CmdString.cpp.

◆ operator=() [3/3]

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

Definition at line 31 of file CmdString.cpp.

◆ toChar()

const char * Fw::CmdStringArg::toChar ( ) const
virtual

Implements Fw::StringBase.

Definition at line 48 of file CmdString.cpp.


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