DigitalPinSet.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 DIGITALPINSET_HPP
#define DIGITALPINSET_HPP

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

namespace duds { namespace hardware { namespace interface {

class DigitalPinSet : public DigitalPinBase {
    std::vector<unsigned int> pinvec;
public:
    DigitalPinSet() = default;
    DigitalPinSet(
        const std::shared_ptr<DigitalPort> &port,
        const std::vector<unsigned int> &pvec
    );
    DigitalPinSet(
        const std::shared_ptr<DigitalPort> &port,
        std::vector<unsigned int> &&pvec
    );
    std::unique_ptr<DigitalPinSetAccess> access() const {
        return port()->access(pinvec);
    }
    void access(DigitalPinSetAccess &acc) const {
        acc.retire();
        port()->access(pinvec, acc);
    }
    const std::vector<unsigned int> &globalIds() const {
        return pinvec;
    }
    std::vector<unsigned int> localIds() const {
        return port()->localIds(pinvec);
    }
    bool havePins() const {
        return (port() != nullptr) && !pinvec.empty();
    }
    bool exists(unsigned int pos) const {
        return (pos < pinvec.size()) && (pinvec[pos] != -1);
    }
    unsigned int size() const {
        return (unsigned int)pinvec.size();
    }
    unsigned int localId(unsigned int pos) const {
        // check range using at()
        return port()->localId(pinvec.at(pos));
    }
    unsigned int globalId(unsigned int pos) const {
        // check range using at()
        return pinvec.at(pos);
    }
    DigitalPinCap capabilities(unsigned int pos) const {
        return port()->capabilities(pinvec.at(pos));
    }
    std::vector<DigitalPinCap> capabilities() const {
        return port()->capabilities(pinvec);
    }
    DigitalPinConfig configuration(unsigned int pos) const {
        return port()->configuration(pinvec.at(pos));
    }
    std::vector<DigitalPinConfig> configuration() const {
        return port()->configuration(pinvec);
    }
    DigitalPinRejectedConfiguration::Reason proposeConfig(
        unsigned int pos,
        DigitalPinConfig &conf
    ) const {
        return port()->proposeConfig(pinvec.at(pos), conf);
    }
    DigitalPinRejectedConfiguration::Reason proposeConfig(
        unsigned int pos,
        DigitalPinConfig &proposed,
        DigitalPinConfig &initial
    ) const {
        return port()->proposeConfig(pinvec.at(pos), proposed, initial);
    }
    bool proposeConfig(
        std::vector<DigitalPinConfig> &propConf,
        std::vector<DigitalPinConfig> &initConf,
        std::function<void(DigitalPinRejectedConfiguration::Reason)> insertReason
            = std::function<void(DigitalPinRejectedConfiguration::Reason)>()
    ) {
        return port()->proposeConfig(
            pinvec,
            propConf,
            initConf,
            insertReason
        );
    }

    // convenience functions -- may expand later

    bool simultaneousOperations() const {
        return port()->simultaneousOperations();
    }
    bool independentConfig() const {
        return port()->independentConfig();
    }
    bool canBeInput(unsigned int pos) const {
        return capabilities(pos) & DigitalPinCap::Input;
    }
    bool canBeOutput(unsigned int pos) const {
        return capabilities(pos) & DigitalPinCap::OutputDriveMask;
    }
    bool canFloat(unsigned int pos) const {
        return capabilities(pos) & DigitalPinCap::OutputHighImpedance;
    }
};

} } }

#endif        //  #ifndef DIGITALPINSET_HPP