BinaryFileReader.h

Go to the documentation of this file.

#pragma once
 
#include "DataIO/FileSystem/Path.h"
 
#include <Common/assertion.h>
 
#include <fstream>
#include <vector>
 
namespace ph
{
 
class BinaryFileReader
{
public:
    explicit BinaryFileReader(const Path& filePath);
    virtual ~BinaryFileReader();
 
    bool open();
    void close();
 
    // TODO: able to specify byte order
    template<typename T>
    void read(T* out_buffer, std::size_t numElements = 1);
 
private:
    Path          m_filePath;
    std::ifstream m_inputStream;
};
 
// In-header Implementations:
 
inline BinaryFileReader::BinaryFileReader(const Path& filePath) :
    m_filePath(filePath), m_inputStream()
{}
 
inline BinaryFileReader::~BinaryFileReader()
{
    close();
}
 
inline void BinaryFileReader::close()
{
    m_inputStream.close();
}
 
template<typename T>
inline void BinaryFileReader::read(T* const out_buffer, const std::size_t numElements)
{
    // FIXME: this is only safe for trivially copyable types
 
    PH_ASSERT(out_buffer && numElements > 0 && m_inputStream.good());
    
    m_inputStream.read(reinterpret_cast<char*>(out_buffer), sizeof(T) * numElements);
}
 
}// end namespace ph