F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
Public Types | Public Member Functions | List of all members
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 , STRING_SIZE = FW_PARAM_STRING_MAX_SIZE , SERIALIZED_SIZE = STATIC_SERIALIZED_SIZE(STRING_SIZE) }
 
- Public Types inherited from Fw::StringBase
using SizeType = NATIVE_UINT_TYPE
 
- Public Types inherited from Fw::Serializable
using SizeType = NATIVE_UINT_TYPE
 

Public Member Functions

 ParamString ()
 
 ParamString (const ParamString &src)
 
 ParamString (const StringBase &src)
 
 ParamString (const char *src)
 
 ~ParamString ()
 
ParamString & operator= (const ParamString &src)
 
ParamString & operator= (const StringBase &src)
 
ParamString & operator= (const char *src)
 
const char * toChar () const
 
StringBase::SizeType getCapacity () const
 return size of buffer More...
 
- Public Member Functions inherited from Fw::StringBase
SizeType length () const
 Get length of string. More...
 
SizeType maxLength () const
 Get the maximum length of a string that the buffer can hold (which is capacity - 1) More...
 
SizeType serializedSize () const
 
SizeType serializedTruncatedSize (FwSizeType maxLength) const
 
const CHAR * operator+= (const CHAR *src)
 Concatenate a CHAR*. More...
 
const StringBase & operator+= (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...
 
StringBase & operator= (const CHAR *src)
 Assign CHAR*. More...
 
StringBase & operator= (const StringBase &src)
 Assign another StringBase. More...
 
void format (const CHAR *formatString,...)
 write formatted string to buffer More...
 
void vformat (const CHAR *formatString, va_list args)
 write formatted string to buffer using va_list More...
 
virtual SerializeStatus serialize (SerializeBufferBase &buffer) const
 serialization function More...
 
virtual SerializeStatus serialize (SerializeBufferBase &buffer, SizeType maxLen) const
 serialization function More...
 
virtual SerializeStatus deserialize (SerializeBufferBase &buffer)
 deserialization function More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Fw::StringBase
static constexpr SizeType STATIC_SERIALIZED_SIZE (SizeType maxLength)
 
static constexpr SizeType BUFFER_SIZE (SizeType maxLength)
 Get the size of a null-terminated string buffer. More...
 
- Protected Member Functions inherited from Fw::StringBase
 StringBase ()
 
virtual ~StringBase ()
 
void appendBuff (const CHAR *buff, SizeType size)
 
- Protected Member Functions inherited from Fw::Serializable
 Serializable ()
 Default constructor. More...
 
virtual ~Serializable ()
 destructor More...
 

Detailed Description

Definition at line 17 of file PrmString.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_TYPE_ID 
STRING_SIZE 
SERIALIZED_SIZE 

Definition at line 19 of file PrmString.hpp.

Constructor & Destructor Documentation

◆ ParamString() [1/4]

Fw::ParamString::ParamString ( )
inline

Definition at line 25 of file PrmString.hpp.

◆ ParamString() [2/4]

Fw::ParamString::ParamString ( const ParamString &  src)
inline

Definition at line 27 of file PrmString.hpp.

◆ ParamString() [3/4]

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

Definition at line 29 of file PrmString.hpp.

◆ ParamString() [4/4]

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

Definition at line 31 of file PrmString.hpp.

◆ ~ParamString()

Fw::ParamString::~ParamString ( )
inline

Definition at line 33 of file PrmString.hpp.

Member Function Documentation

◆ getCapacity()

StringBase::SizeType Fw::ParamString::getCapacity ( ) const
inlinevirtual

return size of buffer

Implements Fw::StringBase.

Definition at line 52 of file PrmString.hpp.

◆ operator=() [1/3]

ParamString& Fw::ParamString::operator= ( const char *  src)
inline

Definition at line 45 of file PrmString.hpp.

◆ operator=() [2/3]

ParamString& Fw::ParamString::operator= ( const ParamString &  src)
inline

Definition at line 35 of file PrmString.hpp.

◆ operator=() [3/3]

ParamString& Fw::ParamString::operator= ( const StringBase &  src)
inline

Definition at line 40 of file PrmString.hpp.

◆ toChar()

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

Implements Fw::StringBase.

Definition at line 50 of file PrmString.hpp.

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