TrainComponent.h

//  trax track library
//  AD 2024 
//
//  "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 "RailRunner.h"
#include "trax/Orientation.h"
 
namespace trax{
 
    struct Bogie;
    struct Train;

    struct TrainComponent : RailRunner
    {
        virtual std::shared_ptr<TrainComponent> ThisTrainComponent() const noexcept = 0;
 

        virtual Train* GetTrain() const noexcept = 0;
 

        virtual Orientation GetOrientation() const noexcept = 0;
 

        virtual std::pair<Train*,Orientation> GetTopmostTrain() const noexcept = 0;
 

        virtual bool IsFinal() const noexcept = 0;
 

        virtual bool IsParent( const Train& train ) const noexcept = 0;
 
 
        enum class DistanceType{
            actual,
            min,
            max,
            half,
        };
 
        using RailRunner::Rail;

        virtual void Rail( const Location& location, bool bMoveTo, DistanceType distance ) = 0;
 
 
        using RailRunner::ResetToGlobalAnchor;
 
        virtual void ResetToGlobalAnchor( const spat::Frame<Length,One>& anchorPose, DistanceType distance ) = 0;
 
 
 
        // Coupled:

        struct Coupling{
            std::shared_ptr<TrainComponent> pTrainComponentA;   
            EndType endA;                                       
            std::shared_ptr<TrainComponent> pTrainComponentB;   
            EndType endB;                                       
        };
 

        virtual bool Couple( EndType end, TrainComponent& with, EndType withEnd, bool btriggerPulses = true ) noexcept = 0;
 

        virtual std::pair<std::shared_ptr<TrainComponent>,EndType> GetCoupledTrainComponent( EndType end ) const noexcept = 0;
 

        virtual Length GetCouplingLength( EndType end, DistanceType distance = DistanceType::max ) const noexcept = 0;
 

        
        virtual std::pair<Bogie&,EndType> GetTipAt( EndType end ) = 0;

        virtual std::pair<const Bogie&,EndType> GetTipAt( EndType end ) const = 0;
 
 
        // Geometry:

        virtual Length GetOverhang( EndType end, DistanceType distance = DistanceType::actual ) const noexcept = 0;
 

        virtual Length GetLength( DistanceType distance = DistanceType::actual ) const noexcept = 0;
 
 
        // Dynamics:

        virtual Mass GetTotalMass() const noexcept = 0;
 
 
        // Jacks 'N Plugs:

        virtual Jack& JackOnRail() noexcept = 0;
 

        virtual Jack& JackOnDerail() noexcept = 0;
 
 
    protected:
        friend class Train_Imp;
        // TrainComponent_Imp:
        virtual void SetTrain( Train* pTrain ) noexcept = 0;
 
        virtual void SetOrientation( Orientation orientation ) noexcept = 0;
    };
 

    dclspc bool Couple( const TrainComponent::Coupling& coupling ) noexcept;
 

    dclspc Train* CommonParent( const TrainComponent& a, const TrainComponent& b ) noexcept;
 
 
}