DigitalPinAccess.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 DIGITALPINACCESS_HPP
#define DIGITALPINACCESS_HPP

#include <duds/hardware/interface/DigitalPort.hpp>
#include <duds/hardware/interface/DigitalPinAccessBase.hpp>

namespace duds { namespace hardware { namespace interface {

class DigitalPinAccess : public DigitalPinAccessBase {
    unsigned int gid;
    DigitalPinAccess(DigitalPort *port, unsigned int globalPinId) :
        DigitalPinAccessBase(port), gid(globalPinId) { }
    friend DigitalPort;
public:
    DigitalPinAccess() : DigitalPinAccessBase() { }
    /*
     * A move constructor. Causes troubles internal to DigitalPort.
     */
    //DigitalPinAccess(DigitalPinAccess &&old) noexcept;
    DigitalPinAccess &operator=(DigitalPinAccess &&old);
    ~DigitalPinAccess() {
        retire();
    }
    void retire() noexcept;
    bool havePin() const {
        return port() != nullptr;
    }
    unsigned int localId() const {
        return port()->localId(gid);
    }
    unsigned int globalId() 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);
    }
    DigitalPinConfig modifyConfig(const DigitalPinConfig &conf) const {
        return port()->modifyConfig(gid, conf, &portdata);
    }
    bool input() const {
        return port()->input(gid, &portdata);
    }
    void output(bool state) const {
        port()->output(gid, state, &portdata);
    }

    // convenience functions -- may expand later

    bool isInput() const {
        return configuration() & DigitalPinConfig::DirInput;
    }
    bool isOutput() const {
        return configuration() & DigitalPinConfig::DirOutput;
    }
    bool canBeInput() const {
        return capabilities() & DigitalPinCap::Input;
    }
    bool canBeOutput() const {
        return capabilities().canOutput();
    }
    bool canFloat() const {
        return capabilities() & DigitalPinCap::OutputHighImpedance;
    }
};

} } }

#endif        //  #ifndef DIGITALPINACCESS_HPP