Sensor.h

//  trax track library
//  AD 2014 
//
//  "It aint me"
//
//      Creedence Clearwater Revival
//
// 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 "common/Interval.h"
 
namespace trax{
 
    struct Event;
    struct Jack;
    struct Plug;
    struct SocketRegistry;
    struct TrackBuilder;
 
    class Location;

    struct Sensor : Identified<Sensor>
    {
        static dclspc std::unique_ptr<Sensor> Make() noexcept;
 

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

        virtual void Trigger( const Event& _event ) = 0;
 

        virtual TrackBuilder* TrackAttached() const = 0;
 

        virtual void Attach( TrackBuilder* pTrackBuilder ) = 0;
 

        virtual Jack& JackOnTrigger() = 0;
 

        virtual void RegisterSockets( SocketRegistry& modul ) = 0;
 

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

    //struct SensorFilterJack : Sensor
    //{
    //  /// \brief Flags for filtering the trigger events.
    //  enum Effect{
    //      none            = 0x0000,   ///< triggers never
    //      train_tip       = 0x0001,   ///< triggers if the train tip with respect to moving direction is encountered
    //      train_end       = 0x0002,   ///< triggers if the train end with respect to moving direction is encountered
    //      train_north     = 0x0004,   ///< triggers if the north end of the train is encountered
    //      train_south     = 0x0008,   ///< triggers if the south end of the train is encountered
    //      wheelframe      = 0x0010,   ///< triggers on every wheelframe
    //      name            = 0x0020,   ///< triggers if the name of the sensor is a substring of the wheelset's name path (Train_Name/RollingStock_Name/Bogie_Name/SubBogieName/ ... /WheelframeName).
    //      not_name        = 0x0040,   ///< triggers if the name of the sensor is not a substring of the wheelset's name path.
    //      any             = 0xffff    ///< triggers always
    //  };
 
    //  /// \brief Makes a SensorFilterJack object.
    //  static dclspc std::unique_ptr<SensorFilterJack> Make( int flags = SensorFilterJack::any ) noexcept;
 
 
    //  virtual int GetEffect() const = 0;
 
 
    //  virtual void SetEffect( int effect ) = 0;
    //};
 
 
    //dclspc std::string ToString( SensorFilterJack::Effect effect );
 
    //dclspc SensorFilterJack::Effect SensorEffectFromString( const std::string& effect );
    
}