ArnItemValve.hpp

Go to the documentation of this file.

// Copyright (C) 2010-2022 Michael Wiklund.
// All rights reserved.
// Contact: arnlib@wiklunden.se
//
// This file is part of the ArnLib - Active Registry Network.
// Parts of ArnLib depend on Qt and/or other libraries that have their own
// licenses. Usage of these other libraries is subject to their respective
// license agreements.
//
// GNU Lesser General Public License Usage
// This file may be used under the terms of the GNU Lesser General Public
// License version 2.1 as published by the Free Software Foundation and
// appearing in the file LICENSE_LGPL.txt included in the packaging of this
// file. In addition, as a special exception, you may use the rights described
// in the Nokia Qt LGPL Exception version 1.1, included in the file
// LGPL_EXCEPTION.txt in this package.
//
// GNU General Public License Usage
// Alternatively, this file may be used under the terms of the GNU General Public
// License version 3.0 as published by the Free Software Foundation and appearing
// in the file LICENSE_GPL.txt included in the packaging of this file.
//
// Other Usage
// Alternatively, this file may be used in accordance with the terms and conditions
// contained in a signed written agreement between you and Michael Wiklund.
//
// This program is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
// PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
//

#ifndef ARNITEMVALVE_HPP
#define ARNITEMVALVE_HPP

#include "ArnLib_global.hpp"
#include "ArnItemB.hpp"

class ArnItemValvePrivate;



class ARNLIBSHARED_EXPORT ArnItemValve : public ArnItemB
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(ArnItemValve)

public:
    struct SwitchMode {
        enum E {
            InStream    = 0x01,
            OutStream   = 0x02,
            InOutStream = InStream | OutStream
        };
        MQ_DECLARE_FLAGS( SwitchMode)
    };

    explicit ArnItemValve( QObject* parent = arnNullptr);

    bool  setTarget( ArnItemB* targetItem, SwitchMode mode = SwitchMode::InOutStream);

    SwitchMode  switchMode()  const;


    ArnItemValve&  setSaveMode()
    {ArnItemB::setSaveMode(); return *this;}

    bool  isSaveMode()  const
    {return ArnItemB::isSaveMode();}


    ArnItemValve&  setMaster()
    {ArnItemB::setMaster(); return *this;}

    bool  isMaster()  const
    {return ArnItemB::isMaster();}


    ArnItemValve&  setAutoDestroy()
    {ArnItemB::setAutoDestroy(); return *this;}

    bool  isAutoDestroy()  const
    {return ArnItemB::isAutoDestroy();}

    bool  toBool()  const;

    ArnItemValve&  operator=( bool value);


public slots:

    void  setValue( bool value);

signals:
    void  changed( int value);

protected:
    virtual void  itemUpdated( const ArnLinkHandle& handleData, const QByteArray* value = arnNullptr);

    ArnItemValve( ArnItemValvePrivate& dd, QObject* parent);

private:
    void  doControl();
};

MQ_DECLARE_OPERATORS_FOR_FLAGS( ArnItemValve::SwitchMode)

#endif // ARNITEMVALVE_HPP