/**
 * server/src/hardware/output/output.hpp
 *
 * This file is part of the traintastic source code.
 *
 * Copyright (C) 2019-2020,2022 Reinder Feenstra
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#ifndef TRAINTASTIC_SERVER_HARDWARE_OUTPUT_OUTPUT_HPP
#define TRAINTASTIC_SERVER_HARDWARE_OUTPUT_OUTPUT_HPP

#include "../../core/idobject.hpp"
#include "../../core/objectproperty.hpp"
#include "../../core/objectvectorproperty.hpp"
#include "../../enum/tristate.hpp"
#include "outputcontroller.hpp"

#ifdef interface
  #undef interface // interface is defined in combaseapi.h
#endif

class Output final : public IdObject
{
  CLASS_ID("output")
  DEFAULT_ID("output")
  CREATE(Output)

  friend class OutputController;

  private:
    static constexpr uint32_t addressMinDefault = 0;
    static constexpr uint32_t addressMaxDefault = 1'000'000;

    void interfaceChanged();
    void channelChanged();

  protected:
    void addToWorld() final;
    void loaded() final;
    void destroying() final;
    void worldEvent(WorldState state, WorldEvent event) final;
    virtual void valueChanged(TriState /*_value*/) {}
    virtual bool setValue(TriState& /*_value*/) { return true; }
    void updateValue(TriState _value);

  public:
    static constexpr uint32_t invalidAddress = std::numeric_limits<uint32_t>::max();

    Property<std::string> name;
    ObjectProperty<OutputController> interface;
    Property<uint32_t> channel;
    Property<uint32_t> address;
    Property<TriState> value;
    ObjectVectorProperty<Object> controllers;

    Output(World& world, std::string_view _id);
};

#endif
