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

#include <Fw/Types/String.hpp>

Inheritance diagram for Fw::String:
Fw::StringBase Fw::Serializable

Public Types

enum  { SERIALIZED_TYPE_ID = FW_TYPEID_FIXED_LENGTH_STRING , STRING_SIZE = FW_FIXED_LENGTH_STRING_SIZE , SERIALIZED_SIZE = STRING_SIZE + sizeof(FwBuffSizeType) }
 

Public Member Functions

 String (const char *src)
 char* source constructor More...
 
 String (const StringBase &src)
 other string constructor More...
 
 String (const String &src)
 String string constructor. More...
 
 String ()
 default constructor More...
 
Stringoperator= (const String &other)
 assignment operator More...
 
Stringoperator= (const StringBase &other)
 other string assignment operator More...
 
Stringoperator= (const char *other)
 char* assignment operator More...
 
 ~String ()
 destructor More...
 
const char * toChar () const
 gets char buffer More...
 
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 String.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_TYPE_ID 

typeid for string type

STRING_SIZE 

Storage for string.

SERIALIZED_SIZE 

Serialized size is size of buffer + size field.

Definition at line 13 of file String.hpp.

Constructor & Destructor Documentation

◆ String() [1/4]

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

char* source constructor

Definition at line 6 of file String.cpp.

◆ String() [2/4]

Fw::String::String ( const StringBase src)

other string constructor

Definition at line 10 of file String.cpp.

◆ String() [3/4]

Fw::String::String ( const String src)

String string constructor.

Definition at line 14 of file String.cpp.

◆ String() [4/4]

Fw::String::String ( )

default constructor

Definition at line 18 of file String.cpp.

◆ ~String()

Fw::String::~String ( )

destructor

Definition at line 45 of file String.cpp.

Member Function Documentation

◆ getCapacity()

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

return buffer size

Implements Fw::StringBase.

Definition at line 52 of file String.cpp.

◆ operator=() [1/3]

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

char* assignment operator

Definition at line 40 of file String.cpp.

◆ operator=() [2/3]

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

assignment operator

Definition at line 22 of file String.cpp.

◆ operator=() [3/3]

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

other string assignment operator

Definition at line 31 of file String.cpp.

◆ toChar()

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

gets char buffer

Implements Fw::StringBase.

Definition at line 48 of file String.cpp.


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