Indicator.h

//  trax track library
//  AD 2014 
//
//  "the resolution of all the fruitless searches"
//
//                              Peter Gabriel
//
// Copyright (c) 2025 Trend Redaktions- und Verlagsgesellschaft mbH
// Copyright (c) 2019 Marc-Michael Horstmann
//
// Permission is hereby granted to any person obtaining a copy of this software 
// and associated source code (the "Software"), to use, view, and study the 
// Software for personal or internal business purposes, subject to the following 
// conditions:
//
// 1. Redistribution, modification, sublicensing, or commercial use of the 
// Software is NOT permitted without prior written consent from the copyright 
// holder.
//
// 2. The Software is provided "AS IS", without warranty of any kind, express 
// or implied.
//
// 3. All copies of the Software must retain this license notice.
//
// For further information, please contact: horstmann.marc@trendverlag.de
 
#pragma once
 
#include "Configuration.h"
#include "Units.h"
#include "Identified.h"
 
#include "spat/Frame.h"
 
namespace trax{
 
    struct Plug;
    struct Jack;
    struct SocketRegistry;

    struct Indicator : Identified<Indicator>
    {
        enum class Type : char{
            unknown = -1,
            none  = 0,
            switch_mono,
            switch_multi,
            velocity_control,
        };

        static dclspc std::unique_ptr<Indicator> Make( Type type ) noexcept;
 

        virtual const char* TypeName() const noexcept = 0;
 

        enum class Status{
            none    = -1,   
            unknown = 0,    
            one     = 1,
            two     = 2,
            three   = 3,
            four    = 4,
            five    = 5,
            six     = 6,
            seven   = 7,
            eight   = 8,
            nine    = 9,
            ten     = 10,
            eleven  = 11,
            twelve  = 12,
            thirteen= 13,
            count,          
            toggle,         
            change          
        };
 

        virtual void SetFrame( const spat::Frame<Length,One>& frame ) = 0;
 

        virtual const spat::Frame<Length,One>& GetFrame() const = 0;
 

        //virtual void SetAbsoluteFrame( const Frame<Real>& frame ) = 0;
 

        //virtual const Frame<Real>& GetAbsoluteFrame() const = 0;
 

        virtual void Get( spat::Frame<Length,One>& frame ) const = 0;
 

        virtual void Toggle( bool pulse = true ) = 0;
 

        virtual Status Set( Status status, bool pulse = true ) = 0;
 

        virtual Status Get() const = 0;
 

        virtual bool IsValidState( Status status ) const = 0;
 

        virtual void RotateWithStatus( Status status, Real angle ) = 0;
 

        virtual Real RotateWithStatus( Status status ) const = 0;
 

        virtual Jack& JackOn( Status status ) = 0;
 

        virtual Plug& PlugTo( Status status ) = 0;
 

        virtual Plug& PlugToToggle() noexcept = 0;
 

        virtual Jack& JackOnChange() noexcept = 0;
 

        virtual void RegisterSockets( SocketRegistry& registry ) = 0;
 

        virtual void UnregisterSockets( SocketRegistry& registry ) = 0;
    };
 

    dclspc std::string ToString( Indicator::Type type );

    dclspc std::string ToString( Indicator::Status status );
 

    dclspc Indicator::Status ToIndicatorStatus( const std::string& status );
 
 
    dclspc Indicator::Status IndicatorStatusFrom( const std::string& socketName );
 

    struct BinaryIndicator : Indicator{

        static dclspc std::unique_ptr<BinaryIndicator> Make( Type type ) noexcept;
        

        virtual Jack& JackOnOne() noexcept = 0;
 

        virtual Plug& PlugToOne() noexcept = 0;
 

        virtual Jack& JackOnTwo() noexcept = 0;
 

        virtual Plug& PlugToTwo() noexcept = 0;
    };
}