Bus.h

Go to the documentation of this file.

#pragma once

#include <vector>
#include "Logger.h"
#include <d3dx9math.h>

#include "Command.h"
//#include "Nullable.h"
//#include "Component.h"
#include "Message.h"
#include "Viewscreen/globals.h"
#include "scanDb.h"

#define MAX_ENGINES 3

class Bus
{
        Logger* logger;
        //std::vector<std::string> highlightElements;

public:
        _SYSTEMTIME Time; 

        float PressureAltitudeKm = 0.0f; // (2)

        float IndicatedAirspeedKms = 0.0f; // (3) brought online 5/22/2018

        // (4) Heading--primary flight crew reference (if selectable, record discrete, true or magnetic);
        float HeadingTrueDegrees = 0.0f; // (4)
        float HeadingMagneticDegrees = 0.0f; // used for the assay grid among other things

        // (5) vertical (11) longitudinal (18) lateral
        D3DXVECTOR3 NormalAcceleration = D3DXVECTOR3(0, 0, 0); // G

        float PitchAttitudeRadians = 0.0f; // (6)
        float RollAttitudeRadians = 0.0f; // (7)

        // (8) Manual radio transmitter keying, or CVR/DFDR synchronization reference; 
        //std::vector<bool> Transmitting; // one for each of TeamSpeakConfig::pttLocations

        // (9) Thrust/power of each engine—primary flight crew reference;
        float EngineThrustOutput[MAX_ENGINES];

        // (12) Pitch control input;
        // (13) Lateral control input;
        // (14) Rudder pedal input;
        // (15) Primary pitch control surface position;
        // (16) Primary lateral control surface position;
        // (17) Primary yaw control surface position;

        // (19) Pitch trim surface position or parameters of paragraph (a)(82) of this section if currently recorded; 
        float PitchTrimSurfacePositionDegrees = 0.0f;

        // (20) Trailing edge flap or cockpit flap control selection (except when parameters of paragraph (a)(85) of this section apply); 
        UINT flapSettingTE = 0; // in flapSettings vector
        // (21) Leading edge flap or cockpit flap control selection (except when parameters of paragraph (a)(86) of this section apply); 
        UINT flapSettingLE = 0; // in flapSettings vector

        // (22) Each Thrust reverser position
        bool ThrustReverserCommand[MAX_ENGINES];

        // (23) Ground spoiler position or speed brake selection (except when parameters of paragraph (a)(87) of this section apply); 

        // (24) Outside or total air temperature;
        float StaticAirTemperatureCelsius = 0.0f; // brought online 5/22/2018
        float OutsideAirTemperatureKelvin = 0.0f; // brought online 5/22/2018
        float TotalAirTemperatureCelsius = 0.0f; // brought online 5/22/2018
        float AirframeTemperatureCelsius = -1.0f; // brought online 5/22/2018

        struct Afcs
        {
                bool AutopilotEngaged = false; // (10) Autopilot engagement status;
                bool AutothrottleEngaged = false;
                //float assistanceLevel = 1.0f; // 1.0f is 
                // full scale VOR is 10 degrees, LOC is 2.5 degrees, G/S is 0.72 degrees

                enum VerticalModes : int
                {
                        VerticalMode_TakeOff = -1,
                        VerticalMode_Off = 0,
                        Pitch = 1, // vs. Flight Path Angle or FPA?
                        VerticalSpeed = 2,
                        SpeedPitch = 3,
                        AltitudeMsl = 4,
                        AltitudeAgl = 5,
                        GlideSlope = 6,
                        VerticalMode_Enum = 7
                } CurrentVerticalMode = VerticalModes::VerticalMode_Off,
                        StandbyVerticalMode = VerticalModes::VerticalMode_Off;

                enum LateralModes : int
                {
                        LateralMode_TakeOff = -1,
                        LateralMode_Off = 0,
                        Roll = 1,
                        Heading = 2,
                        Navigation = 3,
                        Localizer = 4,
                        LateralMode_Enum = 5
                } CurrentLateralMode = LateralModes::LateralMode_Off, // (60) Primary Navigation System Reference;
                        StandbyLateralMode = LateralModes::LateralMode_Off;

                // (48) Selected altitude(when an information source is installed);
                // (49) Selected speed(when an information source is installed);
                // (50) Selected mach(when an information source is installed);
                // (51) Selected vertical speed(when an information source is installed);
                // (52) Selected heading(when an information source is installed);
                // (53) Selected flight path(when an information source is installed); // I assume this is course?

                float DesiredVsiKms = 0.0f;
                float DesiredHeadingRadians = 0.0f;
                float DesiredCourseRadians = 0.0f;
                float DesiredRollRadians = 0.0f; // for command bars
                float DesiredPitchRadians = 0.0f; // for command bars
                float DesiredAltitudeKm = 0.0f;
                float DesiredThrust = 0.0f; // 0-1 for 0-100%
                float DesiredIasKms = 0.0f;

                float PitchInput = 0.0f;
                float RollInput = 0.0f;
                float YawInput = 0.0f;

                bool TvmOn = false;
                float DesiredClosingSpeed = 0.0f;
                float TvmCurrentClosingSpeed = 0.0f;

                bool DorOn = false;

        } AFCS;

        float RadioAltitudeKm = cloudTopsMslC; // (26)
        float LocalizerDeviationRadians = 0.0f; // (27) in radians
        float GlideslopeDeviationRadians = 0.0f; // (28) in radians

        enum MarkerBeaconTypes
        {
                None,
                Outer,
                Middle,
                Inner

        } MarkerBeacon = MarkerBeaconTypes::None;

        bool MasterWarning = false; // (30)

        bool OnGround = true; // (31)

        float AngleOfAttackRadians = 0.0f; // (32)

        // (33) hydraulic pressure LOW each loop

        float GroundSpeedKms = 0.0f; // (34)

        // (35) Ground proximity warning system;
        // @ref https://skybrary.aero/bookshelf/books/3364.pdf
        struct Gpws
        {
                float TerrainClosureRate = 0.0f;
                float ObstacleClosureRate = 0.0f;
                enum GpwsEnum : char
                {
                        NoAlert,

                        // very important! these are in order of highest to lowest priority so we need an upper bound to compare against
                        Mode7_Windshear_Warning,
                        Mode1_Pull_Up,
                        Mode2a_Pull_Up,
                        Mode2b_Pull_Up,
                        Mode2a_Terrain_Terrain,
                        Mode2b_Terrain_Terrain,
                        // @todo V1
                        // @todo Engine Fail
                        // @todo TA terrain, terrain pull up
                        // @todo TA obstacle, obstacle pull up
                        Mode6_Minimums_Minimums,
                        Mode6_Caution_Terrain,
                        Mode6_Caution_Obstacle,
                        Mode4a_Too_Low_Terrain,
                        Mode4b_Too_Low_Terrain,
                        Mode4c_Too_Low_Terrain,
                        Mode6_One_Thousand,
                        Mode6_Five_Hundred,
                        Mode6_Two_Hundred,
                        Mode6_One_Hundred,
                        Mode6_Fifty,
                        Mode6_Forty,
                        Mode6_Thirty,
                        Mode6_Twenty,
                        Mode6_Ten,
                        // @todo Speed brake, speed brake
                        Mode4a_Too_Low_Gear,
                        Mode4b_Too_Low_Flaps,
                        Mode1_Sink_Rate,
                        Mode3_Dont_Sink,
                        Mode5a_Glideslope,
                        Mode5b_Glideslope,
                        // @todo Approaching Minimums
                        Mode6_Bank_Angle,
                        Mode7_Windshear_Caution,
                        // @todo Autopilot
                        // @todo Airspeed Low, Airspeed Low
                        // @todo Flaps, Flaps
                        // @todo Too High, Too High
                        // @todo Too Fast, Too Fast
                        // @todo Flaps (pause Flaps" or "Flaps, Flaps"
                        // @todo Unstable, Unstable"
                        // @todo Altimeter Setting, Altimeter Setting
                        // @todo RAAS advisoryies
                        // @todo RAAS distance remaining callouts

                        // These aren't enumerated in the priority list??
                        Mode6_Retard,
                        Mode6_Positive_Rate,
                        Mode6_Rotate,

                        Reset
                } Alert = GpwsEnum::NoAlert;
        } GPWS;

        float LandingGearExtended = 0.0f; // (36)

        float HeadingTrackDegrees = 0.0f; // (37)

        // (38) Wind speed and direction (when an information source is installed);
        float WindDirectionDegrees = 0.0f;
        float WindSpeedMs = 0.0f;
        float WindUpdraftMs = 0.0f;

        // (39) Latitude and longitude (when an information source is installed); 
        float LatitudeDeg = 0.0f, LongitudeDeg = 0.0f;
        float LatitudeRad = 0.0f;
        VECTOR2SHORT tcp;

        // (40) Stick shaker/pusher (when an information source is installed); 
        // (41) Windshear (when an information source is installed); 
        // (43) Additional engine parameters (as designed in appendix E of this part); 

        // (44) Traffic alert and collision avoidance system; 
        enum TcasEnum
        {
                Clear_Of_Conflict = 0,
                Traffic_Advisory = 1,
                RA_Climb = 2,
                RA_Descend = 3,
                RA_Monitor_Climb = 4,
                RA_Monitor_Descent = 5,
        } TCAS = TcasEnum::Clear_Of_Conflict;
        short TCASTargetOrdinal = -1;

        /*
        (45) DME 1 and 2 distances; // deprecated
        (46) Nav 1 and 2 selected frequency; // deprecated
        (47) Selected barometric setting (when an information source is installed);
        (54) Selected decision height (when an information source is installed);
        (55) EFIS display format;
        (56) Multi-function/engine/alerts display format;
        */

        //(42) Throttle/power lever position; what is the difference?
        float EngineThrustLever[MAX_ENGINES];

        //(57) Thrust command (when an information source is installed);
        float EngineThrustCommand[MAX_ENGINES];

        //(58) Thrust target (when an information source is installed);

        //(59) Fuel quantity in CG trim tank (when an information source is installed);

        //(61) Icing (when an information source is installed);
        bool IceDetected = false;
        float IceDetectorMm = 0.0f; // mm accrued... automatically cycles to melt every X seconds ... sensitivity is 0.0254 but triggers CAS at 0.5
        bool IceDetectorHeat = false;

        /*
        (62) Engine warning each engine vibration (when an information source is installed);
        (63) Engine warning each engine over temp. (when an information source is installed);
        (64) Engine warning each engine oil pressure low (when an information source is installed);
        (65) Engine warning each engine over speed (when an information source is installed);
        (66) Yaw trim surface position;
        (67) Roll trim surface position;
        (68) Brake pressure (selected system);
        */

        //(69) Brake pedal application (left and right);
        float LeftBrake = 0.0f, RightBrake = 0.0f;

        /*
        (70) Yaw or sideslip angle (when an information source is installed);
        (71) Engine bleed valve position (when an information source is installed);
        */

        bool AntiIce = false; // (72)

        /*
        (73) Computed center of gravity (when an information source is installed);
        (74) AC electrical bus status;
        (75) DC electrical bus status;
        (76) APU bleed valve position (when an information source is installed);
        (77) Hydraulic pressure (each system);
        */

        // (78) Loss of cabin pressure;
        float CabinPressureMb = SeaLevelPressureMb; // @todo needs to be initialized from server?
        
        /*
        (79) Computer failure;
        (80) Heads-up display (when an information source is installed);
        (81) Para-visual display (when an information source is installed);
        */

        // (82) Cockpit trim control input position—pitch;
        float PitchTrimScalar = 0.0f; // -1 to +1 for -15 degrees to +15 degrees

        /*
        (83) Cockpit trim control input position—roll;
        (84) Cockpit trim control input position—yaw;
        */

        //(85) Trailing edge flap and cockpit flap control position;
        float TrailingEdgeFlapsPosition = 0.0f; // degrees
        //(86) Leading edge flap and cockpit flap control position;
        float LeadingEdgeFlapsPosition = 0.0f; // degrees


        //(87) Ground spoiler position and speed brake selection;
        //(88) All cockpit flight control input forces (control wheel, control column, rudder pedal);

        //(89) Yaw damper status;
        bool YawDamperStatus = true;

        //(90) Yaw damper command; and
        float YawDamperCommand = 0.0f;

        //(91) Standby rudder valve status.



        std::vector<Command> commandStream;
        void AddCommand(Command command, bool onlyOne);

        std::vector<Message> messages; // CAS

        // this section is for internal and environmental
        float TrueAirspeedKms = 0.0f; // brought online 5/22/2018
        // Surprisingly, VSI wasn't in the list of FDR parameters, probably because it can be deduced from change in altitude over time
        // more likely it is the vertical acceleration converted to fpm
        float VerticalSpeedKms = 0.0f;
        float FlightPathAngleRadians = 0.0f;
        float AirDensityScalar = 1.0f; // sea level default, brought online 5/22/2018
        float DynamicPressure = 0.0f; // brought online 5/22/2018
        float LinearVelocityKms = 0.0f; // relative to vieneo, shows 300 m/s on the surface, added 5/22/2018
        float Mach = 0.0f; // brought online 5/22/2018
        float SpeedOfSoundKms = 0.0f; // brought online 5/22/2018
        float LocalTimeHours = 11.0f;
        float LocalTimeMinutes = 32.0f;

        float EmptyWeightLbs = 0.0f;
        float FuelWeightLbs = 0.0f;
        float FuelFlowKgh = 0.0f;
        float PayloadWeightLbs = 0.0f;
        unsigned short CargoBays[MAX_PODSPERSHIP];
        float GrossWeight() const noexcept // in pounds
        {
                // we could actually be below emptyweight if we lose parts ... empty weight will likely be a calculation based on modules               
                return EmptyWeightLbs + FuelWeightLbs + PayloadWeightLbs;
        }

        // Identified a need for these in modules
        double ProgramTime = 0.0; // from DirectX fTime
        bool FlightFreeze = false;
        bool MasterCaution = false; // MasterWarning is part of FDR but not MasterCaution
        bool ProximityAlert = false; // for Floating Man

        short targetC; // current scanner target
        scanDb Scanner;

        float MapScaleInnerRingKm = 25; // if we add more of these they can go in a MfdSettings container
        bool ComponentRcsRollFail = false;
        bool ComponentFcsRollFail = false;

        SAssayGrid assayGrid;
        float assayQuality = 0.0f;
        float assayProgressU = 0.0f, assayProgressV = 0.0f;

        // for Modules like TCAS, GPWS, and FMS
        int WPtargetC; // current waypoint
        std::vector<Swaypoint> waypoint;
        D3DXVECTOR3 lastWaypointLocation = centerC;
        float TargetDistanceKm;
        char TimeToNextFix[6];

        // These are special for a vector-based instrument StreetView
        std::vector<Snode> nodes;
        bool turnByTurnDirty = false;
        unsigned char turnByTurnRoutingType = 0; // 0 is NONE, 1 is complete, 2 is closest approach
        float turnByTurnTotalDistanceMeters = -1.0f;
        float turnByTurnTotalTimeSeconds = -1.0f;

        void FrameMove(float fElapsed);

        explicit Bus::Bus(Logger* prmLogger);

        // DEBUGGING
        float DebugFloat1 = 0.0f;
        float DebugFloat2 = 0.0f;
        float DebugFloat3 = 0.0f;
        float DebugFloat4 = 0.0f;
        float DebugFloat5 = 0.0f;
        float DebugFloat6 = 0.0f;
        float DebugFloat7 = 0.0f;
        float DebugFloat8 = 0.0f;
        float DebugFloat9 = 0.0f;
        D3DXVECTOR3 Debug1Vec3 = centerC;
        D3DXVECTOR3 Debug2Vec3 = centerC;
        char DebugString[MAX_PATH];
        float DebugSoundReal, DebugSoundFake, DebugSoundBear, DebugSoundClose;
        float DebugTurbidity, DebugTurbulence, DebugCeiling;
};