// SPDX-License-Identifier: LGPL-3.0-or-later

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* Copyright (C) 2013 - 2024, nymea GmbH
* Copyright (C) 2024 - 2025, chargebyte austria GmbH
*
* This file is part of nymea.
*
* nymea is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation, either version 3
* of the License, or (at your option) any later version.
*
* nymea 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.
*
* You should have received a copy of the GNU Lesser General Public License
* along with nymea. If not, see <https://www.gnu.org/licenses/>.
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/*!
  \class State
  \brief Holds the parameters of a State of a \l{Device}.

  \ingroup nymea-types
  \inmodule libnymea

  States hold the state values for devices. A State is associated to a \l{Device} by
  the \l{State::deviceId()} and represents the value of a state described in a \l{StateType}

  \sa StateType, StateDescriptor
*/

#include "state.h"

State::State()
{

}

/*! Constructs a State reflecting the \l{StateType} given by \a stateTypeId
 *  and associated with the \l{Device} given by \a deviceId */
State::State(const StateTypeId &stateTypeId, const ThingId &thingId):
    m_stateTypeId(stateTypeId),
    m_thingId(thingId)
{
}

/*! Returns the id of the StateType describing this State. */
StateTypeId State::stateTypeId() const
{
    return m_stateTypeId;
}

/*! Returns the \l{ThingId} of the thing of this State. */
ThingId State::thingId() const
{
    return m_thingId;
}

/*! Returns the state's value. */
QVariant State::value() const
{
    return m_value;
}

/*! Set the state's value to \a value. */
void State::setValue(const QVariant &value)
{
    m_value = value;
}

void State::setMinValue(const QVariant &minValue)
{
    m_minValue = minValue;
}

void State::setMaxValue(const QVariant &maxValue)
{
    m_maxValue = maxValue;
}

void State::setPossibleValues(const QVariantList &values)
{
    m_possibleValues = values;
}

QVariant State::minValue() const
{
    return m_minValue;
}

QVariant State::maxValue() const
{
    return m_maxValue;
}

QVariantList State::possibleValues() const
{
    return m_possibleValues;
}

Types::StateValueFilter State::filter() const
{
    return m_filter;
}

void State::setFilter(Types::StateValueFilter filter)
{
    m_filter = filter;
}

/*! Writes the stateTypeId, the deviceId and the value of the given \a state to \a dbg. */
QDebug operator<<(QDebug dbg, const State &state)
{
    QDebugStateSaver saver(dbg);
    dbg.nospace() << "State(StateTypeId: " << state.stateTypeId().toString() << ", DeviceId:" << state.thingId() << ", value:" << state.value() << ")";
    return dbg;
}

/*! Writes each stateTypeId, deviceId and value of the given \a states to \a dbg. */
QDebug operator<<(QDebug dbg, const QList<State> &states)
{
    QDebugStateSaver saver(dbg);
    dbg.nospace() << "StateList (count:" << states.count() << ")";
    for (int i = 0; i < states.count(); i++ ) {
        dbg.nospace() << "     " << i << ": " << states.at(i);
    }

    return dbg;
}

States::States()
{

}

States::States(const QList<State> &other): QList<State>(other)
{

}

QVariant States::get(int index) const
{
    return QVariant::fromValue(at(index));
}

void States::put(const QVariant &variant)
{
    append(variant.value<State>());
}

QVariant States::stateValue(const StateTypeId &stateTypeId)
{
    foreach (const State & state, *this) {
        if (state.stateTypeId() == stateTypeId) {
            return state.value();
        }
    }
    return QVariant();
}
