Module.h

//  trax track library
//  AD 2025 
//
//  "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 "trax/Configuration.h"
#include "trax/Identified.h"
#include "trax/Units.h"
#include "trax/SocketRegistry.h"
#include "trax/collections/ObjectIDDecorator.h"
 
#include "spat/Box.h"
#include "spat/Frame.h"
 
 
namespace trax{
 
    struct CameraCollection;
    struct CargoCollection;
    struct Fleet;
    struct IndicatorCollection;
    struct PulseCounterCollection;
    struct SignalCollection;
    struct TimerCollection;
    struct TrackSystem;
 

    struct Module : Identified<Module>,
                    virtual SocketRegistry
    {
        static dclspc std::unique_ptr<Module> Make( bool bCreateCollections = true ) noexcept;
 

        virtual const char* TypeName() const noexcept = 0;
 

        virtual bool IsValid() const noexcept = 0;
 

        virtual void SetFrame( const spat::Frame<Length,One>& frame ) noexcept = 0;
 

        virtual const spat::Frame<Length,One>& GetFrame() const noexcept = 0;
 

        virtual void SetVolume( const spat::Box<Length>& volume ) noexcept = 0;
 

        virtual const spat::Box<Length>& GetVolume() const noexcept = 0;
 

        virtual void Attach( std::shared_ptr<TrackSystem> pTrackSystem ) noexcept = 0;
 

        virtual std::shared_ptr<TrackSystem> GetTrackSystem() const noexcept = 0;
 

        virtual void Attach( std::shared_ptr<Fleet> pFleet ) noexcept = 0;
 

        virtual std::shared_ptr<Fleet> GetFleet() const noexcept = 0;
 

        virtual void Attach( std::shared_ptr<SignalCollection> pSignalCollection ) noexcept = 0;
 

        virtual std::shared_ptr<SignalCollection> GetSignalCollection() const noexcept = 0;
 

        virtual void Attach( std::shared_ptr<IndicatorCollection> pIndicatorCollection ) noexcept = 0;
 

        virtual std::shared_ptr<IndicatorCollection> GetIndicatorCollection() const noexcept = 0;
 
        
        virtual void Attach( std::shared_ptr<CargoCollection> pCargoCollection ) noexcept = 0;
 

        virtual std::shared_ptr<CargoCollection> GetCargoCollection() const noexcept = 0;
 

        virtual void Attach( std::shared_ptr<TimerCollection> pTimerCollection ) noexcept = 0;
 

        virtual std::shared_ptr<TimerCollection> GetTimerCollection() const noexcept = 0;
 

        virtual void Attach( std::shared_ptr<PulseCounterCollection> pPulseCounterCollection ) noexcept = 0;
 

        virtual std::shared_ptr<PulseCounterCollection> GetPulseCounterCollection() const noexcept = 0;
 

        virtual void Attach( std::shared_ptr<CameraCollection> pCameraCollection ) noexcept = 0;
 

        virtual std::shared_ptr<CameraCollection> GetCameraCollection() const noexcept = 0;
 

        virtual void Take( Module& fromModule ) = 0;
 

        virtual void Clear() = 0;
 

        virtual void ClearCollections() = 0;
    };
 
}