line.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_HPP__
#define __LIBGPIOD_CXX_LINE_HPP__
 
#if !defined(__LIBGPIOD_GPIOD_CXX_INSIDE__)
#error "Only gpiod.hpp can be included directly."
#endif
 
#include <ostream>
#include <utility>
#include <vector>
 
namespace gpiod {

namespace line {

class offset
{
public:
    offset(unsigned int off = 0) : _m_offset(off) { }

    offset(const offset& other) = default;

    offset(offset&& other) = default;
 
    ~offset() = default;

    offset& operator=(const offset& other) = default;

    offset& operator=(offset&& other) noexcept = default;

    operator unsigned int() const noexcept
    {
        return this->_m_offset;
    }
 
private:
    unsigned int _m_offset;
};

enum class value
{
    INACTIVE = 0,
    ACTIVE = 1,
};

enum class direction
{
    AS_IS = 1,
    INPUT,
    OUTPUT,
};

enum class edge
{
    NONE = 1,
    RISING,
    FALLING,
    BOTH,
};

enum class bias
{
    AS_IS = 1,
    UNKNOWN,
    DISABLED,
    PULL_UP,
    PULL_DOWN,
};

enum class drive
{
    PUSH_PULL = 1,
    OPEN_DRAIN,
    OPEN_SOURCE,
};

enum class clock
{
    MONOTONIC = 1,
    REALTIME,
    HTE,
    /*<< Line uses the hardware timestamp engine for event timestamps. */
};

using offsets = ::std::vector<offset>;

using values = ::std::vector<value>;

using value_mapping = ::std::pair<offset, value>;

using value_mappings = ::std::vector<value_mapping>;

::std::ostream& operator<<(::std::ostream& out, value val);

::std::ostream& operator<<(::std::ostream& out, direction dir);

::std::ostream& operator<<(::std::ostream& out, edge edge);

::std::ostream& operator<<(::std::ostream& out, bias bias);

::std::ostream& operator<<(::std::ostream& out, drive drive);

::std::ostream& operator<<(::std::ostream& out, clock clock);

::std::ostream& operator<<(::std::ostream& out, const values& vals);

::std::ostream& operator<<(::std::ostream& out, const offsets& offs);

::std::ostream& operator<<(::std::ostream& out, const value_mapping& mapping);

::std::ostream& operator<<(::std::ostream& out, const value_mappings& mappings);
 
} /* namespace line */
 
} /* namespace gpiod */
 
#endif /* __LIBGPIOD_CXX_LINE_HPP__ */