RollingStock.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"
 
#include <memory>
 
namespace trax{
 
    struct Bogie;
    struct Simulator;
    struct Train;
    struct WheelFrame;
    struct SimulatorTrain;
 

    struct RollingStock : TrainComponent{

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

        virtual std::shared_ptr<RollingStock> ThisRollingStock() const noexcept = 0;
 

        virtual bool Attach( Bogie& bogie ) noexcept = 0;
 

        virtual int GetNumberOfBogies() const noexcept = 0;
 

        virtual Bogie& GetBogie( int idx ) const = 0;
 

        virtual int GetNumberOfTopmostParents() const noexcept = 0;
 

        virtual Bogie& GetTopmostParent( int idx = 0 ) const = 0;
 

        virtual int GetNumberOfWheelFrames() const noexcept = 0;
 

        virtual WheelFrame& GetWheelFrame( int idx ) const = 0;
 
 
        //Coupling:
 

        virtual std::pair<std::shared_ptr<RollingStock>,EndType> GetCoupledRollingStock( EndType end ) const noexcept = 0;
 
 
        // Jacks 'N Plugs:
 

        virtual Jack& JackOnHoot() noexcept = 0;
 

        virtual Jack& JackOnSteam() noexcept = 0;
    };
 
};