TractionForceCharacteristic.h

//  trax track library
//  AD 2014
//
//  "It's all over and I'm standin' pretty
//   In this dust that was a city."
//
//                              Nena
//
// 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/Configuration.h"
#include "trax/Units.h"
 
namespace trax{
 

    struct TractionForceCharacteristic{

        enum class TractionType : char{
            unknown = 0,
            mechanic,       
            hydrodynamic,   
            electric,       
            steam,          
            speedsteps,
            other,
        };
 
        static dclspc std::unique_ptr<TractionForceCharacteristic> Make( TractionType type = TractionType::speedsteps, Velocity vmax = 0_mIs, Velocity vtransit = 0_mIs ) noexcept;
 
        virtual TractionType GetTractionType() const noexcept = 0;

        virtual One operator()( Velocity velocity ) const noexcept = 0;
 

        virtual decltype(Power{}/Force{}) MaximumPowerFraction() const noexcept = 0;
 

        virtual Velocity MaximumVelocity() const noexcept = 0;
 

        virtual void AddSpeedStep( Velocity velocity, One value ) = 0;
 

        virtual void GetSpeedSteps( std::vector<std::pair<Velocity,One>>& speedsteps ) const = 0;
 
        virtual ~TractionForceCharacteristic() = default;
        TractionForceCharacteristic( const TractionForceCharacteristic& ) = delete;
        TractionForceCharacteristic( TractionForceCharacteristic&& ) = delete;
        TractionForceCharacteristic& operator=( const TractionForceCharacteristic& ) = delete;
        TractionForceCharacteristic& operator=( TractionForceCharacteristic&& ) = delete;
    protected:
        TractionForceCharacteristic() = default;
    };
 
}