iointerfacefile.h

Go to the documentation of this file.

/* +------------------------------------------------------------------------+
   |                     Mobile Robot Programming Toolkit (MRPT)            |
   |                          https://www.mrpt.org/                         |
   |                                                                        |
   | Copyright (c) 2005-2019, Individual contributors, see AUTHORS file     |
   | See: https://www.mrpt.org/Authors - All rights reserved.               |
   | Released under BSD License. See: https://www.mrpt.org/License          |
   +------------------------------------------------------------------------+ */
#ifndef IOINTERFACEFILE_H
#define IOINTERFACEFILE_H

#include <xsens/xsplatform.h>
#include "streaminterface.h"

enum XsResultValue;

//////////////////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////// IoInterfaceFile
////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////////////

/*! \brief The low-level file communication class.
 */
class IoInterfaceFile : public IoInterface
{
   private:
    XSENS_DISABLE_COPY(IoInterfaceFile)

   protected:
    //! The file handlem, also indicates if the file is open or not.
    XsFileHandle* m_handle;
    //! Contains the size of the file
    XsFilePos m_fileSize;
    //! The last read position in the file
    XsFilePos m_readPos;
    //! The last write position in the file
    XsFilePos m_writePos;
    //! The last result of an operation
    mutable XsResultValue m_lastResult;
    //! Contains the name of the file that was last successfully opened.
    XsString m_filename;
    /*! \brief Indicates whether the last operation was a read or write
       operation.

        This value is used to check whether or not a seek is required to perform
       a
        requested read or write operation.
    */
    bool m_reading;
    //! Indicates if the file was opened in read-only mode
    bool m_readOnly;

    void gotoRead(void);
    void gotoWrite(void);

   public:
    IoInterfaceFile();
    ~IoInterfaceFile() override;

    // Function overrides
    XsResultValue close(void) override;
    XsResultValue closeFile(void);
    XsResultValue flushData(void) override;
    bool isOpen(void) const override;
    XsResultValue getLastResult(void) const override;
    XsResultValue writeData(
        const XsByteArray& data, XsSize* written = nullptr) override;
    XsResultValue readData(XsSize maxLength, XsByteArray& data) override;
    XsResultValue readTerminatedData(
        XsSize maxLength, unsigned char terminator, XsByteArray& bdata);

    // Other functions
    XsResultValue appendData(const XsByteArray& bdata) override;
    XsResultValue closeAndDelete(void) override;
    XsResultValue create(const XsString& filename) override;
    XsResultValue deleteData(XsFilePos start, XsSize length) override;
    XsResultValue find(const XsByteArray& data, XsFilePos& pos) override;
    XsFilePos getFileSize(void) const override;
    XsTimeStamp getFileDate(void) const;
    XsResultValue getName(XsString& filename) const override;
    XsFilePos getReadPosition(void) const override;
    XsFilePos getWritePosition(void) const override;
    XsResultValue insertData(XsFilePos start, const XsByteArray& data) override;
    bool isReadOnly(void) const override;
    XsResultValue open(
        const XsString& filename, bool createNew, bool readOnly) override;
    XsResultValue setReadPosition(XsFilePos pos) override;
    XsResultValue setWritePosition(XsFilePos pos = -1) override;
};

#endif  // file guard