CAS.cpp

Go to the documentation of this file.

#include "Module.h"
#include <algorithm> // for std::sort

Cas::Cas(Bus* prmBus, Logger* prmLogger, Sound* prmSound) : Module(prmBus)
{
        logger = prmLogger;
        sound = prmSound;
}

void Cas::FrameMove(float fElapsed)
{
        if (ourcockpit.gndvehicle && ourcockpit.texturelib != T27) return;

        if (ourcockpit.texturelib == Apartment || ourcockpit.texturelib == SimBay || ourcockpit.texturelib == ControlTower) return;

        if (ourcockpit.power < 0.5f) // unpowered
        {
                secsincelast = -2.0f; // 2 second intro delay
                return;
        }

        if (secsincelast < 0.0f) // 2 second power-up delay
        {
                secsincelast += fElapsed;
                if (secsincelast >= 0.0f)
                {
                        secsincelast = 2.0f;
                        bus->messages.clear(); // reset on power-up
                }
                else
                {
                        return;
                }
        }

        secsincelast += fElapsed;


        for (UINT i = 0; i < bus->commandStream.size(); i++)
        {
                const Command command = bus->commandStream.at(i);
                //if (command.delay != 0.0f) continue;

                if (command.name == "AcknowledgeAllMessages")
                {
                        AcknowledgeAllMessages();
                        bus->commandStream.erase(bus->commandStream.begin() + i);
                }
        }

        const bool weightOnWheels = playerships[0].reference == REF_ONGROUND;

        if (!weightOnWheels)
        {
                weightOnWheelsTime = 0.0f;
                weightOffWheelsTime += fElapsed;
        }
        else
        {
                weightOffWheelsTime = 0.0f;
                weightOnWheelsTime += fElapsed;
        }
        if (bus->RadioAltitudeKm < 0.12192f)
                below400Time += fElapsed;
        else
                below400Time = 0.0f;

        // @todo probably need to move these values to the Bus if more people start using them
        bool takeoffThrust = false;
        bool takeoffInhibit = true;
        bool takeoffRelease = false;
        for (int i = 0; i < ourcockpit.engines; i++)
        {
                takeoffThrust |= bus->EngineThrustLever[i] >= 0.7f; // if ANY one engine is over 70%
                takeoffInhibit &= bus->EngineThrustLever[i] > 0.79f; // if ALL engines are over 79%
                takeoffRelease |= bus->EngineThrustLever[i] < 0.676f; // if ANY one engine is below 67.6%
        }

        const bool takeoffConfig = true; 
        if (takeoffInhibit && weightOnWheels && bus->IndicatedAirspeedKms < 0.0514444f) // 100 KIAS
                inhibit = true;
        else if (!weightOnWheels && bus->RadioAltitudeKm < 0.12192f && bus->LandingGearExtended) // 400 AGL
                inhibit = true;
        else if (takeoffRelease || (takeoffInhibit && bus->IndicatedAirspeedKms > 0.0514444f) || (bus->RadioAltitudeKm > 0.12192f && weightOffWheelsTime > 30.0f)) // 100 KIAS, 400 AGL
                inhibit = false;
        else if (weightOnWheelsTime > 30.0f || (bus->RadioAltitudeKm < 0.12192f && below400Time > 3.0f))
                inhibit = false;

        switch (evaluating++)
        {
        case 0:
                if ((!bus->YawDamperStatus || ourcockpit.vdat.yawdamper < 64) && ourcockpit.vdat.yawdamper > -1)
                        AddMessage(L"YAW DAMPER", MessageLevel::Caution, false);
                else
                        // ReSharper disable once CppExpressionWithoutSideEffects
                        RemoveMessage(L"YAW DAMPER");
                break;
        case 1:
                if (ourcockpit.vdat.thrustaug != -1 && (!g_bAugment || ourcockpit.vdat.thrustaug < 64))
                {
                        if (!inhibit)
                                AddMessage(L"THRUST AUG", MessageLevel::Caution, false);
                }
                else
                        // ReSharper disable once CppExpressionWithoutSideEffects
                        RemoveMessage(L"THRUST AUG");
                break;
        case 2: 
                if (ourcockpit.bays && playerships[0].baydoor)
                {
                        if (!inhibit)
                                AddMessage(L"CARGO DOOR", MessageLevel::Caution, false);
                }
                else
                        // ReSharper disable once CppExpressionWithoutSideEffects
                        RemoveMessage(L"CARGO DOOR");
                break;
        case 3:
                if ((GetKeyState(VK_CAPITAL) & 0x0001) != 0)
                        AddMessage(L"CAPS LOCK ON", MessageLevel::Advisory, false);
                else
                        // ReSharper disable once CppExpressionWithoutSideEffects
                        RemoveMessage(L"CAPS LOCK ON");
                break;
        case 4:
                if ((GetKeyState(VK_NUMLOCK) & 0x0001) == 0)
                        AddMessage(L"NUM LOCK OFF", MessageLevel::Advisory, false);
                else
                        // ReSharper disable once CppExpressionWithoutSideEffects
                        RemoveMessage(L"NUM LOCK OFF");
                break;
        case 5:
                if (ourcockpit.parkingBrake && weightOnWheels && !takeoffThrust)
                        AddMessage(L"PARKING BRAKE ON", MessageLevel::Advisory, false);
                else
                        // ReSharper disable once CppExpressionWithoutSideEffects
                        RemoveMessage(L"PARKING BRAKE ON");
                break;
        case 6:
                if (ourcockpit.parkingBrake && (!weightOnWheels || (takeoffConfig && takeoffThrust)))
                {
                        if (AddMessage(L"PARKING BRAKE", MessageLevel::Warning, false) && weightOnWheels)
                        {
                                Command newCommand;
                                newCommand.name = "CASConfigBrake";
                                newCommand.delay = 1.5f; // give master warn time
                                bus->commandStream.emplace_back(newCommand);
                                logger->Log("CAS::AddMessage ConfigBrake requested!");
                                secsincelast = 0.0f;
                        }
                }
                else
                        // ReSharper disable once CppExpressionWithoutSideEffects
                        RemoveMessage(L"PARKING BRAKE");
                break;
        case 7:
                if (bus->IceDetected)
                {
                        if (!bus->AntiIce)
                                AddMessage(L"ICE", MessageLevel::Caution, false);
                        else
                                AddMessage(L"ICE", MessageLevel::Advisory, false);
                }
                else
                        // ReSharper disable once CppExpressionWithoutSideEffects
                        RemoveMessage(L"ICE");
        case 8:
                if (bus->AntiIce)
                        AddMessage(L"WING/COWL A/I ON", MessageLevel::Advisory, false);
                else
                        // ReSharper disable once CppExpressionWithoutSideEffects
                        RemoveMessage(L"WING/COWL A/I ON");
                break;
        case 9:
                if (bus->AFCS.AutopilotEngaged && weightOnWheels && takeoffConfig && takeoffThrust)
                {
                        if (AddMessage(L"CONFIG AF", MessageLevel::Warning, false))
                        {
                                Command newCommand;
                                newCommand.name = "CASConfigAF";
                                newCommand.delay = 1.5f; // give master warn time
                                bus->commandStream.emplace_back(newCommand);
                                logger->Log("CAS::AddMessage ConfigAF requested!");
                                secsincelast = 0.0f;
                        }
                }
                else
                        // ReSharper disable once CppExpressionWithoutSideEffects
                        RemoveMessage(L"CONFIG AF");
                break;
        case 10:
                if (weightOnWheels && takeoffConfig && takeoffThrust && bus->TrailingEdgeFlapsPosition > 20.0f)
                {
                        if (AddMessage(L"CONFIG FLAPS", MessageLevel::Warning, false))
                        {
                                Command newCommand;
                                newCommand.name = "CASConfigFlaps";
                                newCommand.delay = 1.5f; // give master warn time
                                bus->commandStream.emplace_back(newCommand);
                                logger->Log("CAS::AddMessage ConfigFlaps requested!");
                                secsincelast = 0.0f;
                        }
                }
                else
                        // ReSharper disable once CppExpressionWithoutSideEffects
                        RemoveMessage(L"CONFIG FLAPS");
                break;
        case 11:
                if (weightOnWheels && takeoffConfig && takeoffThrust && fabsf(bus->PitchTrimSurfacePositionDegrees) > 10.0f)
                {
                        if (AddMessage(L"CONFIG STAB", MessageLevel::Warning, false))
                        {
                                Command newCommand;
                                newCommand.name = "CASConfigTrim";
                                newCommand.delay = 1.5f; // give master warn time
                                bus->commandStream.emplace_back(newCommand);
                                logger->Log("CAS::AddMessage ConfigTrim requested!");
                                secsincelast = 0.0f;
                        }
                }
                else
                        // ReSharper disable once CppExpressionWithoutSideEffects
                        RemoveMessage(L"CONFIG STAB");
                break;
        case 12:
                if (bus->ProximityAlert)
                {
                        if (AddMessage(L"PROXIMITY ALERT", MessageLevel::Caution, false))
                        {
                                sound->PlayEx(SOUND_PROXIMITY, true);
                        }
                }
                else
                {
                        // ReSharper disable once CppExpressionWithoutSideEffects
                        RemoveMessage(L"PROXIMITY ALERT");
                        sound->Stop(SOUND_PROXIMITY);
                }
                break;
        case 13:
                if (bus->AirframeTemperatureCelsius > 225)
                        AddMessage(L"WING OVHT", MessageLevel::Warning, false);
                else if (bus->AirframeTemperatureCelsius > 125)
                        AddMessage(L"WING OVHT", MessageLevel::Caution, false);
                else
                        // ReSharper disable once CppExpressionWithoutSideEffects
                        RemoveMessage(L"WING OVHT");
                break;
        case 14:
                if (bus->ComponentFcsRollFail)
                        AddMessage(L"AILERONS FAULT", MessageLevel::Caution, false);
                else
                        // ReSharper disable once CppExpressionWithoutSideEffects
                        RemoveMessage(L"AILERONS FAULT");
                if (bus->ComponentRcsRollFail)
                        AddMessage(L"RCS ROLL FAULT", MessageLevel::Caution, false);
                else
                        // ReSharper disable once CppExpressionWithoutSideEffects
                        RemoveMessage(L"RCS ROLL FAULT");
                break;
        case 15:
                if (fuel < (ourcockpit.fuelmax * 0.03f)) // fuel for go-around for air vehicles
                        AddMessage(L"FUEL LO LEVEL", MessageLevel::Caution, false);
                else
                        // ReSharper disable once CppExpressionWithoutSideEffects
                        RemoveMessage(L"FUEL LO LEVEL");
                break;
        case 16:
                for (int i = 0; i < ourcockpit.engines; i++)
                {
                        swprintf_s(temporaryMessage, 99, L"ENG %i FAIL", i + 1);
                        if ((bus->EngineThrustCommand[i] - bus->EngineThrustOutput[i]) >= 0.25f)
                                AddMessage(temporaryMessage, MessageLevel::Warning, false);
                        else
                                RemoveMessage(temporaryMessage, true);
                }
                break;
        case 17:
                if (bus->CabinPressureMb < 703.2652f) // 10000'
                {
                        if (AddMessage(L"CABIN ALT", MessageLevel::Warning, false))
                        {
                                Command newCommand;
                                newCommand.name = "CASCabinPressure";
                                newCommand.delay = 1.5f; // give master warn time
                                bus->commandStream.emplace_back(newCommand);
                                logger->Log("CAS::AddMessage CabinPressure requested!");
                                secsincelast = 0.0f;
                        }
                }
                else
                        RemoveMessage(L"CABIN ALT", false);
                if (bus->CabinPressureMb >= 703.2652f && bus->CabinPressureMb < 737.0f) // 8500'
                        AddMessage(L"CABIN ALT", MessageLevel::Caution, false);
                else
                        RemoveMessage(L"CABIN ALT", false);
                break;
        default:
                evaluating = 0;
                break;
        }

        // rules
        bus->MasterWarning = false;
        bus->MasterCaution = false;
        for (UINT i = 0; i < bus->messages.size(); i++)
        {
                if (!bus->messages.at(i).acknowledged)
                {
                        if (bus->messages.at(i).level == MessageLevel::Advisory)
                        {
                                // auto-ack after 5 seconds
                                if ((bus->ProgramTime - bus->messages.at(i).time) > 5.0f)
                                {
                                        bus->messages.at(i).acknowledged = true;
                                }
                        }
                        if (bus->messages.at(i).level == MessageLevel::Warning)
                        {
                                bus->MasterWarning = true;
                        }
                        if (bus->messages.at(i).level == MessageLevel::Caution)
                        {
                                bus->MasterCaution = true;
                        }
                }
        }
}

void Cas::AcknowledgeAllMessages() const
{
        for (UINT i = 0; i < bus->messages.size(); i++)
        {
                bus->messages.at(i).acknowledged = true;
        }
        logger->Log("CAS::AcknowledgeAllMessages Completed!");
}

bool Cas::IsMessageOnStack(std::wstring text, MessageLevel level, bool renew) const
{
        for (UINT i = 0; i < bus->messages.size(); i++)
        {
                if (bus->messages.at(i).text == text)
                {
                        if (renew || level != bus->messages.at(i).level)
                        {
                                char msg[99];
                                sprintf_s(msg, 99, "CAS::IsMessageOnStack Retripped: %S", bus->messages.at(i).text.c_str());
                                logger->Log(msg);
                                bus->messages.erase(bus->messages.begin() + i);
                                return false;
                        }
                        return true;
                }
        }
        return false;
}

bool Cas::RemoveMessage(const std::wstring& text, bool onlyIfAcknowledged) const
{
        for (UINT i = 0; i < bus->messages.size(); i++)
        {
                if (bus->messages.at(i).text == text && (!onlyIfAcknowledged || bus->messages.at(i).acknowledged))
                {
                        bus->messages.erase(bus->messages.begin() + i);
                        char msg[99];
                        sprintf_s(msg, 99, "CAS::RemoveMessage Removed: %S", text.c_str());
                        logger->Log(msg);
                        return true;
                }
        }
        return false;
}

bool Cas::AddMessage(const std::wstring& text, MessageLevel level, bool renew = true)
{
        if (IsMessageOnStack(text, level, renew))
                return false;

        Message message;
        message.acknowledged = false;
        message.text = text;
        message.level = level;
        message.time = bus->ProgramTime;
        bus->messages.emplace_back(message);
        char msg[99];
        sprintf_s(msg, 99, "CAS::AddMessage Added: %S (%i)", text.c_str(), level);
        logger->Log(msg);

        // uses less-than operator in Message class!
        std::sort(bus->messages.begin(), bus->messages.end());

        if (secsincelast >= 2.0f)
        {
                if (level == Warning)
                {
                        sound->Play(SOUND_MASTERWARNING);
                        secsincelast = 0.0f;
                }
                else if (level == Caution)
                {
                        sound->Play(SOUND_MASTERCAUTION);
                        secsincelast = 0.0f;
                }
        }

        return true;
}