iointerfacefile.h

Go to the documentation of this file.

 
//  Copyright (c) 2003-2021 Xsens Technologies B.V. or subsidiaries worldwide.
//  All rights reserved.
//  
//  Redistribution and use in source and binary forms, with or without modification,
//  are permitted provided that the following conditions are met:
//  
//  1.  Redistributions of source code must retain the above copyright notice,
//      this list of conditions, and the following disclaimer.
//  
//  2.  Redistributions in binary form must reproduce the above copyright notice,
//      this list of conditions, and the following disclaimer in the documentation
//      and/or other materials provided with the distribution.
//  
//  3.  Neither the names of the copyright holders nor the names of their contributors
//      may be used to endorse or promote products derived from this software without
//      specific prior written permission.
//  
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
//  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
//  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
//  THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
//  SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
//  OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
//  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY OR
//  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
//  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.THE LAWS OF THE NETHERLANDS 
//  SHALL BE EXCLUSIVELY APPLICABLE AND ANY DISPUTES SHALL BE FINALLY SETTLED UNDER THE RULES 
//  OF ARBITRATION OF THE INTERNATIONAL CHAMBER OF COMMERCE IN THE HAGUE BY ONE OR MORE 
//  ARBITRATORS APPOINTED IN ACCORDANCE WITH SAID RULES.
//  
 
 
//  Copyright (c) 2003-2021 Xsens Technologies B.V. or subsidiaries worldwide.
//  All rights reserved.
//  
//  Redistribution and use in source and binary forms, with or without modification,
//  are permitted provided that the following conditions are met:
//  
//  1.  Redistributions of source code must retain the above copyright notice,
//      this list of conditions, and the following disclaimer.
//  
//  2.  Redistributions in binary form must reproduce the above copyright notice,
//      this list of conditions, and the following disclaimer in the documentation
//      and/or other materials provided with the distribution.
//  
//  3.  Neither the names of the copyright holders nor the names of their contributors
//      may be used to endorse or promote products derived from this software without
//      specific prior written permission.
//  
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
//  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
//  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
//  THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
//  SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
//  OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
//  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY OR
//  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
//  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.THE LAWS OF THE NETHERLANDS 
//  SHALL BE EXCLUSIVELY APPLICABLE AND ANY DISPUTES SHALL BE FINALLY SETTLED UNDER THE RULES 
//  OF ARBITRATION OF THE INTERNATIONAL CHAMBER OF COMMERCE IN THE HAGUE BY ONE OR MORE 
//  ARBITRATORS APPOINTED IN ACCORDANCE WITH SAID RULES.
//  
 
#ifndef IOINTERFACEFILE_H
#define IOINTERFACEFILE_H
 
#include <xstypes/xsplatform.h>
#include "iointerface.h"
#include <xstypes/xsresultvalue.h>
 
class IoInterfaceFile : public IoInterface
{
protected:
        XsFile* m_handle;
        XsFilePos m_fileSize;
        XsFilePos m_readPos;
        XsFilePos m_writePos;
        mutable XsResultValue m_lastResult;
        XsString m_filename;
        bool m_reading;
        bool m_readOnly;
 
        void gotoRead();
        void gotoWrite();
public:
        IoInterfaceFile();
        ~IoInterfaceFile();
 
        // Function overrides
        XsResultValue close() override;
        XsResultValue closeFile();
        XsResultValue flushData() override;
        bool isOpen() const override;
        XsResultValue getLastResult() const override;
        XsResultValue writeData(const XsByteArray& data, XsFilePos* written = nullptr) override;
        XsResultValue readData(XsFilePos maxLength, XsByteArray& data) override;
        XsResultValue readDataBlocks(XsFilePos blockCount, XsByteArray& data);
        XsResultValue readTerminatedData(XsFilePos maxLength, unsigned char terminator, XsByteArray& bdata);
 
        // Other functions
        XsResultValue appendData(const XsByteArray& bdata);
        XsResultValue closeAndDelete();
        XsResultValue create(const XsString& filename);
        XsResultValue deleteData(XsFilePos start, XsFilePos length);
        XsResultValue find(const XsByteArray& data, XsFilePos& pos);
        XsFilePos getFileSize() const;
        XsTimeStamp getFileDate() const;
        XsResultValue getName(XsString& filename) const;
        XsString getFileName() const;
        XsFilePos getReadPosition() const;
        XsFilePos getWritePosition() const;
        XsResultValue insertData(XsFilePos start, const XsByteArray& data);
        bool isReadOnly() const;
        XsResultValue open(const XsString& filename, bool createNew, bool readOnly);
        XsResultValue setReadPosition(XsFilePos pos);
        XsResultValue setWritePosition(XsFilePos pos = -1);
        XsResultValue reserve(XsFilePos minSize);
        XsResultValue flushFileBuffers();
 
        static const XsFilePos m_fileBlockSize = 4096;
 
        XSENS_DISABLE_COPY(IoInterfaceFile);
};
 
#endif