/***************************************************************************
 *
 * Project:  OpenCPN
 * Purpose:  NMEA0183 Support Classes
 * Author:   Samuel R. Blackburn, David S. Register
 *
 ***************************************************************************
 *   Copyright (C) 2010 by Samuel R. Blackburn, David S Register           *
 *                                                                         *
 *   This program 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.                                   *
 *                                                                         *
 *   This program 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 this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,  USA.             *
 ***************************************************************************
 *
 *   S Blackburn's original source license:                                *
 *         "You can use it any way you like."                              *
 *   More recent (2010) license statement:                                 *
 *         "It is BSD license, do with it what you will"                   *
 */

#include "nmea0183.h"

/*
** Author: Samuel R. Blackburn
** CI$: 76300,326
** Internet: sammy@sed.csc.com
**
** You can use it any way you like.
*/

RTE::RTE() {
  m_complete_char = 'c';
  m_skip_checksum = 0;

  Mnemonic = _T("RTE");
  Empty();
}

RTE::~RTE() {
  Mnemonic.Empty();
  Empty();
}

void RTE::Empty(void) {
  total_number_of_messages = 0;
  last_message_number_received = 0;
  message_number = 0;
  last_waypoint_number_written = 0;

  TypeOfRoute = RouteUnknown;
  RouteName.Empty();

  delete_all_entries();
}

bool RTE::Parse(const SENTENCE& sentence) {
  /*
  ** RTE - Routes
  **
  **        1   2   3 4	 5		       x    n
  **        |   |   | |    |           |    |
  ** $--RTE,x.x,x.x,a,c--c,c--c, ..... c--c*hh<CR><LF>
  **
  ** Field Number:
  **  1) Total number of messages being transmitted
  **  2) Message Number
  **  3) Message mode
  **     c = complete route, all waypoints
  **     w = working route, the waypoint you just left, the waypoint you're
  *heading to then all the rest
  **  4) Waypoint ID
  **  x) More Waypoints
  **  n) Checksum
  */

  delete_all_entries();

  int field_number = 1;

  total_number_of_messages = sentence.Integer(1);
  //   total_number_of_messages = sentence.Double( 1 );

  int this_message_number = sentence.Integer(2);
  //   double this_message_number = sentence.Double( 2 );

  if (this_message_number == 1) {
    /*
    ** Make sure we've got a clean list
    */

    delete_all_entries();
  }

  if (sentence.Field(3).StartsWith(_T("c"))) {
    TypeOfRoute = CompleteRoute;
  } else if (sentence.Field(3).StartsWith(_T("w"))) {
    TypeOfRoute = WorkingRoute;
  } else {
    TypeOfRoute = RouteUnknown;
  }

  RouteName = sentence.Field(4);

  int number_of_data_fields = sentence.GetNumberOfDataFields();
  field_number = 5;

  while (field_number < number_of_data_fields) {
    Waypoints.Add((sentence.Field(field_number)));
    field_number++;
  }

  return (TRUE);
}

bool RTE::Write(SENTENCE& sentence) {
  /*
  ** Let the parent do its thing
  */

  RESPONSE::Write(sentence);

  sentence += total_number_of_messages;
  sentence += message_number;

  switch (TypeOfRoute) {
    case CompleteRoute:

      //            sentence += _T("C");             // uppercase required for
      //            GPS MLR FFX312 sentence += _T("c");             // trying
      //            lowercase for generic NMEA device
      sentence += wxString((wxChar)m_complete_char);
      break;

    case WorkingRoute:

      sentence += _T("w");
      break;

    default:

      //         sentence += "";
      break;
  }

  sentence += RouteName;

  for (unsigned int i = 0; i < Waypoints.GetCount(); i++)
    sentence += Waypoints[i];

  if (m_skip_checksum) {
    wxString temp_string;
    temp_string.Printf(_T("%c%c"), CARRIAGE_RETURN, LINE_FEED);
    sentence.Sentence += temp_string;
  } else
    sentence.Finish();

  return (TRUE);
}

bool RTE::AddWaypoint(const wxString& name) {
  Waypoints.Add(name);

  return (TRUE);
}

void RTE::delete_all_entries(void) { Waypoints.Clear(); }
