Train.h

//  trax track library
//  AD 2023 
//
//  "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 "TrainComponent.h"
 
namespace trax{
 
    struct SimulatorTrain;
 

    struct Train : TrainComponent{

        static dclspc std::shared_ptr<Train> Make() noexcept;
 

        virtual std::shared_ptr<Train> ThisTrain() const noexcept = 0;
 

        virtual int GetNumberOfComponents() const noexcept = 0;
 

        virtual std::shared_ptr<TrainComponent> GetComponent( int index ) const = 0;
 

        virtual int GetIndexOf( const TrainComponent& component ) const noexcept = 0;
 
 
        // Creation:

        
        virtual bool Create( 
            TrainComponent& trainComponent, 
            Orientation orientation = Orientation::Value::para ) = 0;

        virtual bool Create( 
            const std::vector<std::pair<std::shared_ptr<TrainComponent>,Orientation>>& trainComponents, 
            Orientation orientation = Orientation::Value::para, 
            bool bMoveTo = true,
            DistanceType distance = DistanceType::actual ) = 0;
 
 
        // Appending:

        
        virtual void Align( EndType atEnd, TrainComponent& component, EndType withEnd ) const = 0;

        virtual void Align( EndType atEnd, TrainComponent& component, Orientation orientation ) const = 0;
 

        
        virtual void Append( EndType atEnd, std::shared_ptr<TrainComponent> pComponent, EndType withEnd, bool bCouple = true ) = 0;
 
        virtual void Append( EndType atEnd, std::shared_ptr<TrainComponent> pComponent, Orientation orientation, bool bCouple = true ) = 0;
        

        virtual void Take( EndType atEnd, Train& fromTrain, EndType withEnd ) = 0;
 

        virtual std::pair<std::shared_ptr<Train>,std::shared_ptr<Train>> SplitAfter( int idxAt ) = 0;
 
 
        //Removing:

        virtual std::shared_ptr<Train> Separate() = 0;
 

        virtual void Reduce( bool bRecursive = true ) noexcept = 0;
 

        virtual void Clear() noexcept = 0;
 
 
        //Coupling:
 
        using TrainComponent::Couple;

        virtual bool Couple( EndType thisEnd, Train& with, EndType withEnd ) noexcept = 0;
 

        virtual bool IsUnCoupledInternally() const noexcept = 0;
 
 
        // \brief Get the coupled Train.
        // \param end End type of this Train.
        // \returns A pointer to the other Train coupled at end, or  
        // nullptr if none and the other Train's end type.  
    //  virtual std::pair<std::shared_ptr<Train>,EndType> GetCoupledTrain( EndType end ) const noexcept = 0;
 

        virtual struct Jack& JackOnUnCoupleInternal() noexcept = 0;
    };
 


    
    RailRunner::EndType Front( Orientation orientation ) noexcept;

    RailRunner::EndType Back( Orientation orientation ) noexcept;

    RailRunner::EndType Front( const TrainComponent& trainComponent ) noexcept;

    RailRunner::EndType Back( const TrainComponent& trainComponent ) noexcept;

 
 
 
// inlines:
    inline RailRunner::EndType Front( Orientation orientation ) noexcept{
        return orientation ? RailRunner::EndType::north : RailRunner::EndType::south;
    }
 
    inline RailRunner::EndType Back( Orientation orientation ) noexcept{
        return orientation ? RailRunner::EndType::south : RailRunner::EndType::north;
    }
 
    inline RailRunner::EndType Front( const TrainComponent& trainComponent ) noexcept{
        return Front( trainComponent.GetOrientation() );
    }
 
    inline RailRunner::EndType Back( const TrainComponent& trainComponent ) noexcept{
        return Back( trainComponent.GetOrientation() );
    }
 
}