line-info.hpp

Go to the documentation of this file.

/* SPDX-License-Identifier: LGPL-2.1-or-later */
/* SPDX-FileCopyrightText: 2021-2022 Bartosz Golaszewski <brgl@bgdev.pl> */
 
#ifndef __LIBGPIOD_CXX_LINE_INFO_HPP__
#define __LIBGPIOD_CXX_LINE_INFO_HPP__
 
#if !defined(__LIBGPIOD_GPIOD_CXX_INSIDE__)
#error "Only gpiod.hpp can be included directly."
#endif
 
#include <chrono>
#include <iostream>
#include <memory>
#include <string>
 
namespace gpiod {
 
class chip;
class info_event;
 
class line_info final
{
public:
 
    line_info(const line_info& other) noexcept;
 
    line_info(line_info&& other) noexcept;
 
    ~line_info();
 
    line_info& operator=(const line_info& other) noexcept;
 
    line_info& operator=(line_info&& other) noexcept;
 
    line::offset offset() const noexcept;
 
    ::std::string name() const noexcept;
 
    bool used() const noexcept;
 
    ::std::string consumer() const noexcept;
 
    line::direction direction() const;
 
    line::edge edge_detection() const;
 
    line::bias bias() const;
 
    line::drive drive() const;
 
    bool active_low() const noexcept;
 
    bool debounced() const noexcept;
 
    ::std::chrono::microseconds debounce_period() const noexcept;
 
    line::clock event_clock() const;
 
private:
 
    line_info();
 
    struct impl;
 
    ::std::shared_ptr<impl> _m_priv;
 
    friend chip;
    friend info_event;
};
 
::std::ostream& operator<<(::std::ostream& out, const line_info& info);
 
} /* namespace gpiod */
 
#endif /* __LIBGPIOD_CXX_LINE_INFO_HPP__ */