DigitalPin.hpp

Go to the documentation of this file.

/*
 * This file is part of the DUDS project. It is subject to the BSD-style
 * license terms in the LICENSE file found in the top-level directory of this
 * distribution and at https://github.com/jjackowski/duds/blob/master/LICENSE.
 * No part of DUDS, including this file, may be copied, modified, propagated,
 * or distributed except according to the terms contained in the LICENSE file.
 *
 * Copyright (C) 2017  Jeff Jackowski
 */
#ifndef DIGITALPIN_HPP
#define DIGITALPIN_HPP

#include <duds/hardware/interface/DigitalPinBase.hpp>
#include <duds/hardware/interface/DigitalPinAccess.hpp>

namespace duds { namespace hardware { namespace interface {

class DigitalPin : public DigitalPinBase {
    unsigned int gid;
public:
    DigitalPin() = default;
    DigitalPin(const std::shared_ptr<DigitalPort> &port, unsigned int pin);
    std::unique_ptr<DigitalPinAccess> access() const {
        return port()->access(gid);
    }
    void access(DigitalPinAccess *acc) const {
        port()->access(&gid, 1, acc);
    }
    bool havePin() const {
        return (bool)port();
    }
    unsigned int localId() const {
        return port()->localId(gid);
    }
    unsigned int globalId() const {
        return gid;
    }
    operator unsigned int () const {
        return gid;
    }
    DigitalPinCap capabilities() const {
        return port()->capabilities(gid);
    }
    DigitalPinConfig configuration() const {
        return port()->configuration(gid);
    }
    DigitalPinRejectedConfiguration::Reason proposeConfig(
        DigitalPinConfig &conf
    ) const {
        return port()->proposeConfig(gid, conf);
    }
    DigitalPinRejectedConfiguration::Reason proposeConfig(
        DigitalPinConfig &proposed,
        DigitalPinConfig &initial
    ) const {
        return port()->proposeConfig(gid, proposed, initial);
    }

    // convenience functions -- may expand later

    bool canBeInput() const {
        return capabilities() & DigitalPinCap::Input;
    }
    bool canBeOutput() const {
        return capabilities() & (
            DigitalPinCap::OutputPushPull |
            DigitalPinCap::OutputDriveLow |
            DigitalPinCap::OutputDriveHigh
        );
    }
    bool canFloat() const {
        return capabilities() & DigitalPinCap::OutputHighImpedance;
    }
};

} } } // namespaces

#endif        //  #ifndef DIGITALPIN_HPP