DigitalPortDependentPins.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 DIGITALPORTDEPENDENTPINS_HPP
#define DIGITALPORTDEPENDENTPINS_HPP
#include <duds/hardware/interface/DigitalPort.hpp>

namespace duds { namespace hardware { namespace interface {

class DigitalPortDependentPins : public DigitalPort {
protected:
    DigitalPortDependentPins(unsigned int numpins, unsigned int firstid) :
    DigitalPort(numpins, firstid) { }
    virtual DigitalPinRejectedConfiguration::Reason inspectProposal(
        unsigned int localPinId,
        std::vector<DigitalPinConfig> &proposed,
        std::vector<DigitalPinConfig> &initial
    ) const = 0;
    virtual DigitalPinRejectedConfiguration::Reason proposeConfigImpl(
        unsigned int gid,
        DigitalPinConfig &pconf,
        DigitalPinConfig &iconf
    ) const;
    virtual bool proposeConfigImpl(
        const std::vector<unsigned int> &pins,
        std::vector<DigitalPinConfig> &propConf,
        std::vector<DigitalPinConfig> &initConf,
        std::function<void(DigitalPinRejectedConfiguration::Reason)> insertReason
            = std::function<void(DigitalPinRejectedConfiguration::Reason)>()
    ) const;
    virtual bool proposeFullConfigImpl(
        std::vector<DigitalPinConfig> &propConf,
        std::vector<DigitalPinConfig> &initConf,
        std::function<void(DigitalPinRejectedConfiguration::Reason)> insertReason
            = std::function<void(DigitalPinRejectedConfiguration::Reason)>()
    ) const;
public:
    virtual bool independentConfig() const;
    // a reminder to C++ that this function has been declared; bother
    virtual bool independentConfig(
        unsigned int gid,
        const DigitalPinConfig &newcfg,
        const DigitalPinConfig &initcfg
    ) const = 0;
};

} } }

#endif        //  #ifndef DIGITALPORTDEPENDENTPINS_HPP