Messaging.cpp

Go to the documentation of this file.

/*
 * Messaging.cpp
 *
 * Part of Fly! Legacy project
 *
 * Copyright 2003 Chris Wallace
 *
 * Fly! Legacy is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 * Fly! Legacy is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 *   along with Fly! Legacy; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#include "../Include/FlyLegacy.h"
#include "../Include/Globals.h"
#include "../Include/Situation.h"
#include "../Include/Subsystems.h"
#include "../Include/UserVehicles.h"

using namespace std;

static EMessageResult SendMessageToAmpSystems (SMessage *msg, CElectricalSystem *amp)
{
  EMessageResult rc = MSG_IGNORED;
  
  if (amp) {
    // Electrical systems are valid, send msg to each subs until handler found
    vector<CSubsystem*>::iterator i;
    for (i=amp->subs.begin(); i!=amp->subs.end(); i++) {
      CSubsystem *s = *i;
      rc = s->ReceiveMessage (msg);
      if (rc == MSG_PROCESSED) {
        // Receiver found. Update msg struct so that subsequent
        //   calls to SendMessage do not require lookup
        msg->receiver = s;
      }
    }
  }

  return rc;
}

static EMessageResult SendMessageToGasSystems (SMessage *msg, CFuelSystem *gas)
{
  EMessageResult rc = MSG_IGNORED;
  
  if (gas) {
    // Fuel systems are valid, send msg to each subs until handler found
    vector<CFuelSubsystem*>::iterator i;
    for (i=gas->fsub.begin(); i!=gas->fsub.end(); i++) {
      CSubsystem *s = *i;
      rc = s->ReceiveMessage (msg);
      if (rc == MSG_PROCESSED) {
        // Receiver found. Update msg struct so that subsequent
        //   calls to SendMessage do not require lookup
        msg->receiver = s;
        break;
      }
    }
  }

  return rc;
}    

static EMessageResult SendMessageToAirplane (SMessage *msg, CAirplane *plan)
{
  EMessageResult rc = MSG_IGNORED;
  
  if (plan) {
    // Try to find message receiver in list of electrical subsystems
    rc = SendMessageToAmpSystems (msg, plan->amp);
  }
  
  // If not found, try to find message receiver in list of fuel subsystems
  if (msg->receiver == NULL) {
    rc = SendMessageToGasSystems (msg, plan->gas);
  }
  
  return rc;
}

EMessageResult SendMessage (SMessage *msg)
{
  if (msg == NULL) return MSG_IGNORED;

  // Assume message has no handler by default
  EMessageResult rc = MSG_IGNORED;

  if (msg->receiver != NULL) {
    // Send the message to the known recipient
    CSubsystem *subs = (CSubsystem *)msg->receiver;
    rc = subs->ReceiveMessage (msg);
  } else {
    // Search all subsystems until a subsystem returns MSG_PROCESSED.
    CVehicleObject *vehi = globals->sit->GetUserVehicle ();
    EFlyObjectType userType = globals->sit->GetUserVehicleType ();
    switch (userType) {
    case TYPE_FLY_AIRPLANE:
      {
        CAirplaneObject *planObj = (CAirplaneObject *)vehi;
        CAirplane *plan = planObj->pAirplane;
        rc = SendMessageToAirplane (msg, plan);
      }
      break;
      
    default:
      // Unsupported user vehicle type; do nothing
      ;
    }

  }

  // Display warning message if message receiver not found
  if (rc == MSG_IGNORED) {
    char id_string[8];
    char group_string[8];
    char dtag_string[8];
    TagToString (id_string, msg->id);
    TagToString (group_string, msg->group);
    TagToString (dtag_string, msg->user.u.datatag);
    globals->logWarning->Write ("SendMessage: No rcvr: id=%s group=%s, dtag=%s (0x%08X)",
      id_string, group_string, dtag_string, msg->user.u.datatag);
  }

  msg->result = rc;

  return rc;
}

Documentation generated by