File.h

Go to the documentation of this file.

#ifndef MATIOCPP_FILE_H
#define MATIOCPP_FILE_H
 
/*
 * Copyright (C) 2020 Fondazione Istituto Italiano di Tecnologia
 *
 * This software may be modified and distributed under the terms of the
 * BSD-2-Clause license (https://opensource.org/licenses/BSD-2-Clause).
 */
 
 
#include <matioCpp/ForwardDeclarations.h>
#include <matioCpp/Variable.h>
 
class matioCpp::File
{
    class Impl;
 
    std::unique_ptr<Impl> m_pimpl; 
    template<class input>
    inline const input &getVariable(const input& it);
 
    template<class key, class input>
    inline const input &getVariable(const std::pair<key, input>& it);
 
public:
 
    File();
 
    File(const std::string& name, matioCpp::FileMode mode = matioCpp::FileMode::ReadAndWrite);
 
    File(const File& other) = delete;
 
    File(File&& other);
 
    ~File();
 
    void operator=(const File& other) = delete;
 
    void operator=(File&& other);
 
    void close();
 
    bool open(const std::string& name, matioCpp::FileMode mode = matioCpp::FileMode::ReadAndWrite);
 
    static File Create(const std::string& name,
                       matioCpp::FileVersion version = matioCpp::FileVersion::Default,
                       const std::string& header = "");
 
    static bool Delete(const std::string& name);
 
    static bool Exists(const std::string& name);
 
    std::string name() const;
 
    std::string header() const;
 
    matioCpp::FileVersion version() const;
 
    matioCpp::FileMode mode() const;
 
    std::vector<std::string> variableNames() const;
 
    matioCpp::Variable read(const std::string& name) const;
 
    bool write(const Variable &variable, matioCpp::Compression compression = matioCpp::Compression::None);
 
    template <class iterator>
    bool write(iterator begin, iterator end, matioCpp::Compression compression = matioCpp::Compression::None);
 
    bool isOpen() const;
 
};
 
#include "impl/File.tpp"
 
#endif // MATIOCPP_FILE_H