Limpiando el código, documentando

country.cpp

@@ -27,25 +27,7 @@ void Country::limits(){
     qDebug() << minX << minY << maxX << maxY ;
 }
 
-void Country::topLeft(QString &st, DoublePoint &p ) {
-    QMap<QString,City*>::iterator it = Cities.begin();
-    st = it.key();
-    p.x = it.value()->getGeometry()->at(0).x;
-    p.y = it.value()->getGeometry()->at(0).y;
-
-    qDebug() << p.x << ". " << p.y;
-    for (it = Cities.begin(); it != Cities.end(); ++it) {
-        QVector<DoublePoint> *geometry = it.value()->getGeometry();
-        for (int i = 0; i < geometry->size(); i++) {
-            if (geometry->at(i).x > p.x && geometry->at(i).y < p.y)  {
-                p.x = geometry->at(i).x;
-                p.y = geometry->at(i).y;
-                st = it.key();
-            }
-        }
 
-    }
-}
 unsigned long  *colorMap;
 bool Country::readInfoFromJSON(const QString &fileName) {
     QFile loadFile(fileName);

country.h

@@ -35,34 +35,16 @@ public:
     ///
     bool readInfoFromJSON(const QString &fileName);
 
-    /// \fn topLeft(QString &st, DoublePoint &p );
-    /// \~English
-    /// \brief ??
-    /// \param ??
-    /// \~Spanish
-    /// \brief ??
-    /// \param ??
-    ///
-    void topLeft(QString &st, DoublePoint &p );
-
     /// \fn void limits();
     /// \~English
-    /// \brief ??
-    /// \param ??
-    /// \~Spanish
-    /// \brief ??
-    /// \param ??
+    /// \brief Determines the coordinates of the top left and bottom right
+    ///        corners of the map.
+    /// \~Spanish 
+    /// \brief Determina las coordenadas de las esquinas superior izquierda
+    ///        e inferior derecha del mapa.
     ///
     void limits();
 
-    /// \fn QMap<QString,City*> getCities()
-    /// \~English
-    /// \brief gets the Cities map structure.
-    /// \~Spanish
-    /// \brief consigue la estructura de mapa de Cities.
-    ///
-    QMap<QString,City*> getCities() { return Cities;}
-    //~Country() { delete Cities; }
 };
 
 #endif // COUNTRY_H

mainwindow.cpp

@@ -13,7 +13,6 @@
 #include <QPoint>
 #include <string>
 #include <QPolygon>
-#include <census.h>
 #include <city.h>
 #include <country.h>
 #include <doublepoint.h>

mainwindow.h

@@ -2,7 +2,7 @@
 #define MAINWINDOW_H
 
 #include <QMainWindow>
-#include <census.h>
+// #include <census.h>
 #include "map.h"
 namespace Ui {
 class MainWindow;

map.cpp

@@ -9,17 +9,19 @@ Map::Map(QWidget *parent) :
 {
     srand(time(NULL));
 
-
-    myCountry = new Country;
+    // Create country object and read data from the json file
+    myCountry = new Country;  
     myCountry->readInfoFromJSON(":/data/cityLimitsPR.json");
 
     cityColorMap = NULL;
     gisLocations = NULL;
     drawRoutes = false;
 
+    // Compute the limits of the coordinates 
     qDebug() << "Computing limits...";
     myCountry->limits();
 
+    // Create the main widget and resize according to the map aspect ratio
     QDesktopWidget widget;
     QRect mainScreenSize = widget.availableGeometry(widget.primaryScreen());
 
@@ -37,10 +39,11 @@ Map::~Map() {
     if (gisLocations != NULL)    delete [] gisLocations;
 }
 
+// These are used during the map drawing.
 QPoint **qpA = new QPoint*[100];
 unsigned int qpASize = 0;
 
-void Map::paintEvent(QPaintEvent *event) {
+void Map::paintEvent(QPaintEvent *) {
 
     // the QPainter is the 'canvas' to which we will draw
     // the QPen is the pen that will be used to draw to the 'canvas'
@@ -146,10 +149,6 @@ void Map::paintEvent(QPaintEvent *event) {
 
         p->drawPolygon(qpBegin,ctr,Qt::WindingFill);
 
-
-
-
-
         delete tmpPath;
         colorCtr++;
         cityCounter++;
@@ -163,15 +162,13 @@ void Map::paintEvent(QPaintEvent *event) {
     int cX, cY, pX, pY;
     cX = cY = pX = pY = -1;
 
-    //qDebug() << "gisLocations:" << gisLocations << endl;
-
     if(gisLocations) {
         myPen.setWidth(2);
         myPen.setColor(QColor(0x100000));
         myPen.setBrush(QBrush(Qt::black));
 
         p->setPen(myPen);
-        for (int i = 0; i < numLocations; i++) {
+        for (unsigned int i = 0; i < numLocations; i++) {
             qDebug() << "name from locations:" << gisLocations[i].getName();
 
             cX = factorX * (gisLocations[i].getLon() - myCountry->minX);
@@ -188,10 +185,12 @@ void Map::paintEvent(QPaintEvent *event) {
         }
     }
 
-     QVector < QPair<const GISPOI *,const GISPOI *> > ::iterator vit = this->cityLines.begin();
+    // Draws any lines between the cities which have been added using 
+    // the drawLine method.
+
+    QVector < QPair<const GISPOI *,const GISPOI *> > ::iterator vit = this->cityLines.begin();
     for (; vit != this->cityLines.end(); vit++) {
 
-//        qDebug() << "A line from " << linePair.first->getName() << " to " << linePair.second->getName() << endl;
         cX = factorX * (vit->first->getLon() - myCountry->minX);
         cY = height() - factorY*(vit->first->getLat()  - myCountry->minY);
         pX = factorX * (vit->second->getLon() - myCountry->minX);
@@ -213,7 +212,3 @@ void Map::paintEvent(QPaintEvent *event) {
     delete p;
 }
 
-
-void Map::drawLine(const GISPOI &city01, const GISPOI &city02) {
-    this->cityLines.push_back(QPair<const GISPOI *, const GISPOI *> (&city01, &city02));
-}

map.h

@@ -4,31 +4,57 @@
 #include <QWidget>
 #include <QMap>
 #include <QRgb>
-#include <census.h>
+// #include <census.h>
 #include <country.h>
 #include <gispoi.h>
 #include <QVector>
 #include <QPair>
 
+/// This is the actual widget in charge of drawing the map
+
+
 class Map : public QWidget
 {
     Q_OBJECT
 public:
+    /// \fn Map(QWidget *parent = 0);
+    /// \~English
+    /// \brief default constructor
+    /// \~Spanish
+    /// \brief constructor por defecto
+    ///
     explicit Map(QWidget *parent = 0);
-    void setColorMap(QMap<QString,QRgb> *colorMap) {cityColorMap = colorMap;}
-    void drawPoints(GISPOI *v, unsigned int size) {gisLocations = v; numLocations = size;}
-    void setDrawRoutes(bool r) {drawRoutes = r;}
-    void drawLine(const GISPOI &city01, const GISPOI &city02);
+
+    /// \fn drawPoints(GISPOI *v, unsigned int size);
+    /// \~English 
+    /// \brief sets the array of GIS locations and sets its size
+    /// \~Spanish
+    /// \brief establece el arreglo de localizaciones de GIS y su tamaño
+    ///
+    void drawPoints(GISPOI *v, unsigned int size) 
+                { gisLocations = v; numLocations = size; }
+    
+    /// \fn drawLine(const GISPOI &city01, const GISPOI &city02)
+    /// \~English
+    /// \brief adds a line from city01 to city02
+    /// \~Spanish
+    /// \brief añade una linea entre los centroides de city01 a city02
+    ///
+    void drawLine(const GISPOI &city01, const GISPOI &city02) {
+        this->cityLines.push_back(
+            QPair<const GISPOI *, const GISPOI *> (&city01, &city02));
+    }
+    
     ~Map();
 signals:
 
 private:
-    Country *myCountry;
+    Country            *myCountry;
     QMap<QString,QRgb> *cityColorMap;
-    GISPOI *gisLocations;
+    GISPOI             *gisLocations;
+    unsigned int       numLocations;
+    bool               drawRoutes;
     QVector < QPair<const GISPOI *,const GISPOI *> > cityLines;
-    unsigned int numLocations;
-    bool drawRoutes;
 
 protected:
     void paintEvent(QPaintEvent *event);

moc_mainwindow.cpp

@@ -0,0 +1,89 @@
+/****************************************************************************
+** Meta object code from reading C++ file 'mainwindow.h'
+**
+** Created by: The Qt Meta Object Compiler version 67 (Qt 5.4.0)
+**
+** WARNING! All changes made in this file will be lost!
+*****************************************************************************/
+
+#include "mainwindow.h"
+#include <QtCore/qbytearray.h>
+#include <QtCore/qmetatype.h>
+#if !defined(Q_MOC_OUTPUT_REVISION)
+#error "The header file 'mainwindow.h' doesn't include <QObject>."
+#elif Q_MOC_OUTPUT_REVISION != 67
+#error "This file was generated using the moc from 5.4.0. It"
+#error "cannot be used with the include files from this version of Qt."
+#error "(The moc has changed too much.)"
+#endif
+
+QT_BEGIN_MOC_NAMESPACE
+struct qt_meta_stringdata_MainWindow_t {
+    QByteArrayData data[1];
+    char stringdata[11];
+};
+#define QT_MOC_LITERAL(idx, ofs, len) \
+    Q_STATIC_BYTE_ARRAY_DATA_HEADER_INITIALIZER_WITH_OFFSET(len, \
+    qptrdiff(offsetof(qt_meta_stringdata_MainWindow_t, stringdata) + ofs \
+        - idx * sizeof(QByteArrayData)) \
+    )
+static const qt_meta_stringdata_MainWindow_t qt_meta_stringdata_MainWindow = {
+    {
+QT_MOC_LITERAL(0, 0, 10) // "MainWindow"
+
+    },
+    "MainWindow"
+};
+#undef QT_MOC_LITERAL
+
+static const uint qt_meta_data_MainWindow[] = {
+
+ // content:
+       7,       // revision
+       0,       // classname
+       0,    0, // classinfo
+       0,    0, // methods
+       0,    0, // properties
+       0,    0, // enums/sets
+       0,    0, // constructors
+       0,       // flags
+       0,       // signalCount
+
+       0        // eod
+};
+
+void MainWindow::qt_static_metacall(QObject *_o, QMetaObject::Call _c, int _id, void **_a)
+{
+    Q_UNUSED(_o);
+    Q_UNUSED(_id);
+    Q_UNUSED(_c);
+    Q_UNUSED(_a);
+}
+
+const QMetaObject MainWindow::staticMetaObject = {
+    { &QMainWindow::staticMetaObject, qt_meta_stringdata_MainWindow.data,
+      qt_meta_data_MainWindow,  qt_static_metacall, Q_NULLPTR, Q_NULLPTR}
+};
+
+
+const QMetaObject *MainWindow::metaObject() const
+{
+    return QObject::d_ptr->metaObject ? QObject::d_ptr->dynamicMetaObject() : &staticMetaObject;
+}
+
+void *MainWindow::qt_metacast(const char *_clname)
+{
+    if (!_clname) return Q_NULLPTR;
+    if (!strcmp(_clname, qt_meta_stringdata_MainWindow.stringdata))
+        return static_cast<void*>(const_cast< MainWindow*>(this));
+    return QMainWindow::qt_metacast(_clname);
+}
+
+int MainWindow::qt_metacall(QMetaObject::Call _c, int _id, void **_a)
+{
+    _id = QMainWindow::qt_metacall(_c, _id, _a);
+    if (_id < 0)
+        return _id;
+    return _id;
+}
+QT_END_MOC_NAMESPACE

moc_map.cpp

@@ -0,0 +1,89 @@
+/****************************************************************************
+** Meta object code from reading C++ file 'map.h'
+**
+** Created by: The Qt Meta Object Compiler version 67 (Qt 5.4.0)
+**
+** WARNING! All changes made in this file will be lost!
+*****************************************************************************/
+
+#include "map.h"
+#include <QtCore/qbytearray.h>
+#include <QtCore/qmetatype.h>
+#if !defined(Q_MOC_OUTPUT_REVISION)
+#error "The header file 'map.h' doesn't include <QObject>."
+#elif Q_MOC_OUTPUT_REVISION != 67
+#error "This file was generated using the moc from 5.4.0. It"
+#error "cannot be used with the include files from this version of Qt."
+#error "(The moc has changed too much.)"
+#endif
+
+QT_BEGIN_MOC_NAMESPACE
+struct qt_meta_stringdata_Map_t {
+    QByteArrayData data[1];
+    char stringdata[4];
+};
+#define QT_MOC_LITERAL(idx, ofs, len) \
+    Q_STATIC_BYTE_ARRAY_DATA_HEADER_INITIALIZER_WITH_OFFSET(len, \
+    qptrdiff(offsetof(qt_meta_stringdata_Map_t, stringdata) + ofs \
+        - idx * sizeof(QByteArrayData)) \
+    )
+static const qt_meta_stringdata_Map_t qt_meta_stringdata_Map = {
+    {
+QT_MOC_LITERAL(0, 0, 3) // "Map"
+
+    },
+    "Map"
+};
+#undef QT_MOC_LITERAL
+
+static const uint qt_meta_data_Map[] = {
+
+ // content:
+       7,       // revision
+       0,       // classname
+       0,    0, // classinfo
+       0,    0, // methods
+       0,    0, // properties
+       0,    0, // enums/sets
+       0,    0, // constructors
+       0,       // flags
+       0,       // signalCount
+
+       0        // eod
+};
+
+void Map::qt_static_metacall(QObject *_o, QMetaObject::Call _c, int _id, void **_a)
+{
+    Q_UNUSED(_o);
+    Q_UNUSED(_id);
+    Q_UNUSED(_c);
+    Q_UNUSED(_a);
+}
+
+const QMetaObject Map::staticMetaObject = {
+    { &QWidget::staticMetaObject, qt_meta_stringdata_Map.data,
+      qt_meta_data_Map,  qt_static_metacall, Q_NULLPTR, Q_NULLPTR}
+};
+
+
+const QMetaObject *Map::metaObject() const
+{
+    return QObject::d_ptr->metaObject ? QObject::d_ptr->dynamicMetaObject() : &staticMetaObject;
+}
+
+void *Map::qt_metacast(const char *_clname)
+{
+    if (!_clname) return Q_NULLPTR;
+    if (!strcmp(_clname, qt_meta_stringdata_Map.stringdata))
+        return static_cast<void*>(const_cast< Map*>(this));
+    return QWidget::qt_metacast(_clname);
+}
+
+int Map::qt_metacall(QMetaObject::Call _c, int _id, void **_a)
+{
+    _id = QWidget::qt_metacall(_c, _id, _a);
+    if (_id < 0)
+        return _id;
+    return _id;
+}
+QT_END_MOC_NAMESPACE

ui_mainwindow.h

@@ -0,0 +1,69 @@
+/********************************************************************************
+** Form generated from reading UI file 'mainwindow.ui'
+**
+** Created by: Qt User Interface Compiler version 5.4.0
+**
+** WARNING! All changes made in this file will be lost when recompiling UI file!
+********************************************************************************/
+
+#ifndef UI_MAINWINDOW_H
+#define UI_MAINWINDOW_H
+
+#include <QtCore/QVariant>
+#include <QtWidgets/QAction>
+#include <QtWidgets/QApplication>
+#include <QtWidgets/QButtonGroup>
+#include <QtWidgets/QHeaderView>
+#include <QtWidgets/QMainWindow>
+#include <QtWidgets/QMenuBar>
+#include <QtWidgets/QStatusBar>
+#include <QtWidgets/QToolBar>
+#include <QtWidgets/QWidget>
+
+QT_BEGIN_NAMESPACE
+
+class Ui_MainWindow
+{
+public:
+    QMenuBar *menuBar;
+    QToolBar *mainToolBar;
+    QWidget *centralWidget;
+    QStatusBar *statusBar;
+
+    void setupUi(QMainWindow *MainWindow)
+    {
+        if (MainWindow->objectName().isEmpty())
+            MainWindow->setObjectName(QStringLiteral("MainWindow"));
+        MainWindow->resize(400, 300);
+        menuBar = new QMenuBar(MainWindow);
+        menuBar->setObjectName(QStringLiteral("menuBar"));
+        MainWindow->setMenuBar(menuBar);
+        mainToolBar = new QToolBar(MainWindow);
+        mainToolBar->setObjectName(QStringLiteral("mainToolBar"));
+        MainWindow->addToolBar(mainToolBar);
+        centralWidget = new QWidget(MainWindow);
+        centralWidget->setObjectName(QStringLiteral("centralWidget"));
+        MainWindow->setCentralWidget(centralWidget);
+        statusBar = new QStatusBar(MainWindow);
+        statusBar->setObjectName(QStringLiteral("statusBar"));
+        MainWindow->setStatusBar(statusBar);
+
+        retranslateUi(MainWindow);
+
+        QMetaObject::connectSlotsByName(MainWindow);
+    } // setupUi
+
+    void retranslateUi(QMainWindow *MainWindow)
+    {
+        MainWindow->setWindowTitle(QApplication::translate("MainWindow", "MainWindow", 0));
+    } // retranslateUi
+
+};
+
+namespace Ui {
+    class MainWindow: public Ui_MainWindow {};
+} // namespace Ui
+
+QT_END_NAMESPACE
+
+#endif // UI_MAINWINDOW_H