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

#include <Fw/Prm/PrmString.hpp>

Inheritance diagram for Fw::ParamString:
Fw::StringBase Fw::Serializable

Public Types

enum  { SERIALIZED_TYPE_ID = FW_TYPEID_PRM_STR , SERIALIZED_SIZE = FW_PARAM_STRING_MAX_SIZE + sizeof(FwBuffSizeType) }
 

Public Member Functions

 ParamString (const char *src)
 
 ParamString (const StringBase &src)
 
 ParamString (const ParamString &src)
 
 ParamString ()
 
ParamStringoperator= (const ParamString &other)
 
ParamStringoperator= (const StringBase &other)
 
ParamStringoperator= (const char *other)
 
 ~ParamString ()
 
const char * toChar () const
 
NATIVE_UINT_TYPE getCapacity () const
 return size of buffer
 
- 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 PrmString.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_TYPE_ID 
SERIALIZED_SIZE 

Definition at line 13 of file PrmString.hpp.

Constructor & Destructor Documentation

◆ ParamString() [1/4]

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

Definition at line 6 of file PrmString.cpp.

◆ ParamString() [2/4]

Fw::ParamString::ParamString ( const StringBase src)

Definition at line 10 of file PrmString.cpp.

◆ ParamString() [3/4]

Fw::ParamString::ParamString ( const ParamString src)

Definition at line 14 of file PrmString.cpp.

◆ ParamString() [4/4]

Fw::ParamString::ParamString ( )

Definition at line 18 of file PrmString.cpp.

◆ ~ParamString()

Fw::ParamString::~ParamString ( )

Definition at line 45 of file PrmString.cpp.

Member Function Documentation

◆ getCapacity()

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

return size of buffer

Implements Fw::StringBase.

Definition at line 52 of file PrmString.cpp.

◆ operator=() [1/3]

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

Definition at line 40 of file PrmString.cpp.

◆ operator=() [2/3]

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

Definition at line 22 of file PrmString.cpp.

◆ operator=() [3/3]

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

Definition at line 31 of file PrmString.cpp.

◆ toChar()

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

Implements Fw::StringBase.

Definition at line 48 of file PrmString.cpp.


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