RailRunner.h

//  trax track library
//  AD 2023 
//
//  "Slide!"
//
//      Fight Club
// 
// 
// 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 "trax/Units.h"
#include "trax/Identified.h"
#include "trax/Location.h"
 
#include <memory>
 
 
namespace trax{
 
    struct Jack;

    struct RailRunnerUserData;
        
        
    struct RailRunner : Identified<RailRunner>
    {
        virtual const char* TypeName() const noexcept = 0;
 

        enum class EndType : char{
            none = 0,
            north,      
            south,      
            any,        
            all         
        };

        virtual std::shared_ptr<RailRunner> This() const noexcept = 0;
 

        virtual bool IsValid() const noexcept = 0;
 
 
        // Rail/DeRail:
 

        virtual void Rail( const Location& location, bool bMoveTo = true ) = 0;
 

        virtual Location GetLocation() const noexcept = 0;
 

        virtual void DeRail() noexcept = 0;
 

        virtual bool IsRailed() const noexcept = 0;
 
 
        // Locating in space

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

        virtual void ResetToGlobalAnchor( const spat::Frame<Length,One>& anchorPose ) = 0;
 
 
        // Driving:

        virtual void SetVelocity( Velocity velocity ) = 0;
 

        virtual Velocity GetVelocity() const = 0;
 

        virtual void TargetVelocity( Velocity velocity ) = 0;
 

        virtual Velocity TargetVelocity() const noexcept = 0;
 

        virtual EndType TargetDirection() const noexcept = 0;
 

        virtual Power MaximumPowerOutput() const noexcept = 0;
 

        virtual Power CurrentPowerOutput() const noexcept = 0;
 

        virtual Velocity MaximumVelocity() const noexcept = 0;
 

        virtual void Thrust( One byfactor ) = 0;
 

        virtual One Thrust() const noexcept = 0;
 

        virtual void ThrustAbsolute( Force thrust ) = 0;
 

        virtual Force ThrustAbsolute() const noexcept = 0;
 


        virtual Force MaxThrust() const noexcept = 0;

        virtual Force MaxThrust( Velocity velocity ) const noexcept = 0;
 

        virtual void Brake( One byfactor ) = 0;
 

        virtual One Brake() const noexcept = 0;
 

        virtual void BrakeAbsolute( Force brake ) = 0;
 

        virtual Force BrakeAbsolute() const noexcept = 0;
 

        virtual Force MaxBrake() const noexcept = 0;
 
 
        // Coupling:

        virtual void ActivateCoupling( EndType end ) = 0;
 

        virtual void DeactivateCoupling( EndType end ) = 0;
 

        virtual bool IsActivated( EndType end ) const noexcept = 0;
 

        virtual bool Uncouple( EndType end = EndType::all, bool btriggerPulses = true ) noexcept = 0;
 

        virtual bool IsCoupled( EndType end = EndType::any ) const noexcept = 0;
 

        virtual Length GetCouplingHeight( EndType end ) const noexcept = 0;
 
 
        // Jacks 'N Plugs:

        virtual Jack& JackOnCouple( EndType end ) = 0;
 

        virtual Jack& JackOnUnCouple( EndType end ) = 0;
 

        virtual Jack& JackOnCouplingActivated( EndType end ) = 0;
 

        virtual Jack& JackOnCouplingDeactivated( EndType end ) = 0;
 

        virtual void UserData( RailRunnerUserData* pData ) noexcept = 0;
 

        virtual RailRunnerUserData* UserData() const noexcept = 0;
    };
 

    inline RailRunner::EndType operator!( RailRunner::EndType end ) noexcept{
        switch( end ){
            case RailRunner::EndType::north:    return RailRunner::EndType::south;
            case RailRunner::EndType::south:    return RailRunner::EndType::north;
            default:                            return RailRunner::EndType::none;
        }
    }

    dclspc std::string ToString( RailRunner::EndType end );
 

    dclspc RailRunner::EndType ToRailRunnerEndType( const std::string& endtype );
 
}