F´ Flight Software - C/C++ Documentation  NASA-v1.5.0
A framework for building embedded system applications to NASA flight quality standards.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
InternalInterfaceString.hpp
Go to the documentation of this file.
1 #ifndef FW_INTERNAL_INTERFACE_STRING_TYPE_HPP
2 #define FW_INTERNAL_INTERFACE_STRING_TYPE_HPP
3 
6 #include <Fw/Cfg/SerIds.hpp>
7 #include <FpConfig.hpp>
8 
9 namespace Fw {
10 
12  public:
13 
14  enum {
17  };
18 
19  InternalInterfaceString(const char* src);
24  const char* toChar(void) const;
25  NATIVE_UINT_TYPE length(void) const;
26 
28 
31 
33  void copyBuff(const char* buff, NATIVE_UINT_TYPE size);
34  NATIVE_UINT_TYPE getCapacity(void) const ;
36 
38 };
39 }
40 
41 #endif // FW_INTERNAL_INTERFACE_STRING_TYPE_HPP
Fw::InternalInterfaceString
Definition: InternalInterfaceString.hpp:11
StringType.hpp
Declares ISF string base class.
Fw::InternalInterfaceString::SERIALIZED_TYPE_ID
@ SERIALIZED_TYPE_ID
typeid for string type
Definition: InternalInterfaceString.hpp:15
PRIVATE
#define PRIVATE
overridable private for unit testing
Definition: BasicTypes.hpp:118
Fw::InternalInterfaceString::terminate
void terminate(NATIVE_UINT_TYPE size)
terminate the string
Definition: InternalInterfaceString.cpp:73
Fw::InternalInterfaceString::serialize
SerializeStatus serialize(SerializeBufferBase &buffer) const
serialization function
Definition: InternalInterfaceString.cpp:48
Fw::InternalInterfaceString::deserialize
SerializeStatus deserialize(SerializeBufferBase &buffer)
deserialization function
Definition: InternalInterfaceString.cpp:54
Fw::SerializeBufferBase
Definition: Serializable.hpp:43
Fw::SerializeStatus
SerializeStatus
forward declaration for string
Definition: Serializable.hpp:14
Fw::StringBase
Definition: StringType.hpp:23
Fw::InternalInterfaceString::size
PRIVATE NATIVE_UINT_TYPE size
copy source buffer, overwriting
Definition: InternalInterfaceString.hpp:33
Fw::InternalInterfaceString::length
NATIVE_UINT_TYPE length(void) const
returns length of stored string
Definition: InternalInterfaceString.cpp:30
Fw::InternalInterfaceString::m_buf
char m_buf[FW_INTERNAL_INTERFACE_STRING_MAX_SIZE]
storage for string data
Definition: InternalInterfaceString.hpp:37
Fw::FW_TYPEID_INTERNAL_INTERFACE_STRING
@ FW_TYPEID_INTERNAL_INTERFACE_STRING
interface string Buffer type id
Definition: SerIds.hpp:58
NATIVE_UINT_TYPE
unsigned int NATIVE_UINT_TYPE
native unsigned integer type declaration
Definition: BasicTypes.hpp:30
Fw::InternalInterfaceString::~InternalInterfaceString
~InternalInterfaceString(void)
destructor
Definition: InternalInterfaceString.cpp:27
Fw::StringBase::copyBuff
virtual void copyBuff(const char *buff, NATIVE_UINT_TYPE size)=0
Fw::InternalInterfaceString::getCapacity
NATIVE_UINT_TYPE getCapacity(void) const
return buffer size
Definition: InternalInterfaceString.cpp:64
Fw::InternalInterfaceString::operator=
const InternalInterfaceString & operator=(const InternalInterfaceString &other)
equal operator
Definition: InternalInterfaceString.cpp:68
Fw::InternalInterfaceString::SERIALIZED_SIZE
@ SERIALIZED_SIZE
Serialized size is size of buffer + size field.
Definition: InternalInterfaceString.hpp:16
FpConfig.hpp
ISF configuration file.
Fw::InternalInterfaceString::toChar
const char * toChar(void) const
gets char buffer
Definition: InternalInterfaceString.cpp:34
BasicTypes.hpp
Declares ISF basic types.
SerIds.hpp
Definitions for ISF type serial IDs.
FW_INTERNAL_INTERFACE_STRING_MAX_SIZE
#define FW_INTERNAL_INTERFACE_STRING_MAX_SIZE
Max size of interface string parameter type.
Definition: FpConfig.hpp:281
FwBuffSizeType
#define FwBuffSizeType
Type representation for storing a buffer or string size.
Definition: FpConfig.hpp:79
Fw
Definition: BufferGetPortAc.cpp:6
Fw::InternalInterfaceString::InternalInterfaceString
InternalInterfaceString(void)
default constructor
Definition: InternalInterfaceString.cpp:23