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
FileBuffer.hpp
Go to the documentation of this file.
1 /*
2  * FileBuffer.hpp
3  *
4  * Created on: May 2014
5  * Author: tcanham
6  */
7 
8 /*
9  * Description:
10  * This object contains the FileBuffer type, used for storing a piece of an uplinked file
11  */
12 #ifndef FW_FILE_BUFFER_HPP
13 #define FW_FILE_BUFFER_HPP
14 
15 #include <FpConfig.hpp>
16 #include <Fw/Types/BasicTypes.hpp>
18 #include <Fw/Cfg/SerIds.hpp>
19 
20 namespace Fw {
21 
23  public:
24 
25  enum {
28  };
29 
30  FileBuffer(const U8 *args, NATIVE_UINT_TYPE size);
31  FileBuffer();
32  FileBuffer(const FileBuffer& other);
33  virtual ~FileBuffer();
34  const FileBuffer& operator=(const FileBuffer& other);
35 
36  NATIVE_UINT_TYPE getBuffCapacity(void) const; // !< returns capacity, not current size, of buffer
37  U8* getBuffAddr(void);
38  const U8* getBuffAddr(void) const;
39 
40  private:
41  U8 m_data[FW_FILE_BUFFER_MAX_SIZE]; // command argument buffer
42  };
43 
44 }
45 
46 #endif
Fw::FileBuffer::~FileBuffer
virtual ~FileBuffer()
Definition: FileBuffer.cpp:14
Fw::FileBuffer::SERIALIZED_SIZE
@ SERIALIZED_SIZE
Definition: FileBuffer.hpp:27
Fw::FileBuffer
Definition: FileBuffer.hpp:22
Fw::FW_TYPEID_FILE_BUFF
@ FW_TYPEID_FILE_BUFF
File piece Buffer type id.
Definition: SerIds.hpp:53
Fw::SerializeBufferBase
Definition: Serializable.hpp:43
Serializable.hpp
U8
uint8_t U8
8-bit unsigned integer
Definition: BasicTypes.hpp:76
Fw::FileBuffer::FileBuffer
FileBuffer()
Definition: FileBuffer.cpp:11
Fw::FileBuffer::operator=
const FileBuffer & operator=(const FileBuffer &other)
Definition: FileBuffer.cpp:22
NATIVE_UINT_TYPE
unsigned int NATIVE_UINT_TYPE
native unsigned integer type declaration
Definition: BasicTypes.hpp:30
Fw::FileBuffer::SERIALIZED_TYPE_ID
@ SERIALIZED_TYPE_ID
Definition: FileBuffer.hpp:26
Fw::FileBuffer::getBuffCapacity
NATIVE_UINT_TYPE getBuffCapacity(void) const
returns capacity, not current size, of buffer
Definition: FileBuffer.cpp:28
FpConfig.hpp
ISF configuration file.
FW_FILE_BUFFER_MAX_SIZE
#define FW_FILE_BUFFER_MAX_SIZE
Max size of file buffer (i.e. chunk of file)
Definition: FpConfig.hpp:276
BasicTypes.hpp
Declares ISF basic types.
SerIds.hpp
Definitions for ISF type serial IDs.
Fw::FileBuffer::getBuffAddr
U8 * getBuffAddr(void)
gets buffer address for data filling
Definition: FileBuffer.cpp:36
FwBuffSizeType
#define FwBuffSizeType
Type representation for storing a buffer or string size.
Definition: FpConfig.hpp:79
Fw
Definition: BufferGetPortAc.cpp:6