file_reader.hpp🔗

Namespaces🔗

Name
iox building block to easily create free function for logging in a library context
iox::cxx

Classes🔗

	Name
class	iox::cxx::FileReader Wrapper class for file reading operations. Tries to open a file in the constructor. Error handling strategy can be decided by means of the ErrorMode argument.

Source code🔗

// Copyright (c) 2019 by Robert Bosch GmbH. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// SPDX-License-Identifier: Apache-2.0
#ifndef IOX_UTILS_FILE_READER_FILE_READER_HPP
#define IOX_UTILS_FILE_READER_FILE_READER_HPP

#include "iceoryx_utils/error_handling/error_handling.hpp"

#include <fstream>

namespace iox
{
namespace cxx
{
class FileReader
{
  public:
    enum class ErrorMode
    {
        Ignore,
        Inform,
        Terminate
    };

    FileReader(const std::string& f_fileName,
               const std::string& f_filePath = "",
               ErrorMode f_errorMode = ErrorMode::Inform);

    FileReader(const FileReader&) = delete;
    FileReader(FileReader&&) = delete;
    FileReader& operator=(const FileReader&) = delete;
    FileReader& operator=(FileReader&&) = delete;

    ~FileReader() = default;

    bool IsOpen() const;
    bool ReadLine(std::string& f_string);

  private:
#ifdef _WIN32
    static constexpr char PATH_SEPARATOR[] = "\\";
#else
    static constexpr char PATH_SEPARATOR[] = "/";
#endif
    std::fstream m_fileStream;
    std::string m_file;
    ErrorMode m_errorMode;
};

} // namespace cxx
} // namespace iox

#endif // IOX_UTILS_FILE_READER_FILE_READER_HPP

Updated on 31 May 2022 at 15:29:15 CEST