mlByteDataReader.h

Go to the documentation of this file.

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
// **InsertLicense** code
//----------------------------------------------------------------------------------

//----------------------------------------------------------------------------------
 
#pragma once
 
#include "MLReleaseToolsSystem.h"
#include "mlModuleIncludes.h"
 
ML_START_NAMESPACE
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
class MLRELEASE_TOOLS_EXPORT ByteDataReader {
  public:
  
    ByteDataReader();

    ByteDataReader(const std::string &fileName);

    virtual ~ByteDataReader();

    virtual std::string getFileName() const;

    virtual void setFileName(const std::string &fileName);

    virtual void open();

    virtual bool isOpen() const;

    virtual void close();

    virtual bool isGood() const;

    virtual std::string       getErrorState() const;

    virtual void              clearErrorState();
    
    virtual void              setIndent(const std::string &indent);
    
    virtual const std::string &getIndent() const;

    bool     needsByteSwapping() const;

    virtual void prefetch();
    
    virtual const MLuint8* getPrefetchData() const;
    
    virtual void clearPrefetchData();

    MLuint8  get8BitUWord(MLuint64 pos) const;

    MLuint16 get16BitUWord(MLuint64 pos) const;

    MLuint16 get16BitUWordInLocalEndianess(MLuint64 pos) const;

    MLuint32 get32BitUWord(MLuint64 pos) const;

    MLuint32 get32BitUWordInLocalEndianess(MLuint64 pos) const;

    MLuint64 get64BitUWord(MLuint64 pos) const;

    MLuint64 get64BitUWordInLocalEndianess(MLuint64 pos) const;
      
    std::string getNonTerminatedDataAsString(MLuint originPosition,
                                             MLuint numChars) const;

    MLuint8* getDataChunk(MLuint64 pos, MLuint64 numBytes) const;
    
    const MLuint8* getPrefetchDataChunk(MLuint64 pos, MLuint64 numBytes) const;

    virtual std::string getAsString(const std::string &prefix="",
                                    const std::string &sep=", ",
                                    const size_t      maxNumBinaryEntries=8,
                                    const size_t      maxNumStringEntries=20) const;

    MLint getFileSizeFromCurrentDescriptor();
    
    void appendStringToState(const std::string &errDesc) const;
    
  protected:
    
    int _getFileDescriptor() const;
    
    void _appendErrNoToState(const std::string &errDesc) const;

    void _setNeedsByteSwapping(bool needsSwapping);
 
  private:

    mutable std::string _errorStateString;

    std::string _fileName;
    
    int _fileDescriptor;

    std::string _indent;

    bool _needsByteSwapping;

    MLuint8 *_prefetchData;

    MLuint64 _prefetchedDataInBytes;
    
    ML_ROOT_CLASS_HEADER(ByteDataReader);
};

MLRELEASE_TOOLS_EXPORT std::ostream& operator<<(std::ostream& os, const ByteDataReader &obj);
 
ML_END_NAMESPACE