flightsimulatorplatfrom/pilotclient
1
0
Fork 0
mirror of https://github.com/swift-project/pilotclient.git synced 2026-05-01 06:35:41 +08:00
Code Issues Packages Projects Releases Wiki Activity

refs #91 & #124 doxygen fixes, style/comment changes, typos, and override keywords

Browse Source
This commit is contained in:
Klaus Basan
2014-02-07 22:00:40 +01:00
parent e88ee7c808
commit f245ea1283
1 changed files with 49 additions and 107 deletions
Download Patch File Download Diff File Expand all files Collapse all files

156
src/blackcore/context_network.h
View File

@@ -33,14 +33,10 @@ namespace BlackCore
Q_OBJECT Q_OBJECT
public: public:
/*! //! \brief Constructor, with link to runtime
* \brief With link to server
*/
CContextNetwork(CCoreRuntime *runtime); CContextNetwork(CCoreRuntime *runtime);
/*! //! \brief Destructor
* \brief Destructor
*/
virtual ~CContextNetwork(); virtual ~CContextNetwork();
/*! /*!
@@ -53,32 +49,25 @@ namespace BlackCore
server->addObject(IContextNetwork::ServicePath(), this); server->addObject(IContextNetwork::ServicePath(), this);
} }
/*! //! \brief Runtime
* \brief Runtime
* \return
*/
const CCoreRuntime *getRuntime() const const CCoreRuntime *getRuntime() const
{ {
return static_cast<CCoreRuntime *>(this->parent()); return static_cast<CCoreRuntime *>(this->parent());
} }
/*! //! \brief Using local objects?
* \brief Using local objects? virtual bool usingLocalObjects() const override { return true; }
*/
virtual bool usingLocalObjects() const { return true; }
public slots: public slots:
/*! //! \copydoc IContextNetwork::readAtcBookingsFromSource()
* \copydoc IContextNetwork::readAtcBookingsFromSource()
*/
virtual void readAtcBookingsFromSource(); virtual void readAtcBookingsFromSource();
/*! /*!
* \copydoc IContextNetwork::getAtcStationsOnline() * \copydoc IContextNetwork::getAtcStationsOnline()
* \todo If I make this &getAtcStations XML is not generated correctly, needs to be crosschecked with the latest version of Qt * \todo If I make this &getAtcStations XML is not generated correctly, needs to be crosschecked with the latest version of Qt
*/ */
virtual const BlackMisc::Aviation::CAtcStationList getAtcStationsOnline() const virtual const BlackMisc::Aviation::CAtcStationList getAtcStationsOnline() const override
{ {
// this->log(Q_FUNC_INFO); // this->log(Q_FUNC_INFO);
return m_atcStationsOnline; return m_atcStationsOnline;
@@ -88,82 +77,66 @@ namespace BlackCore
* \copydoc IContextNetwork::getAtcStationsBooked() * \copydoc IContextNetwork::getAtcStationsBooked()
* \todo If I make this &getAtcStations XML is not generated correctly * \todo If I make this &getAtcStations XML is not generated correctly
*/ */
virtual const BlackMisc::Aviation::CAtcStationList getAtcStationsBooked() const virtual const BlackMisc::Aviation::CAtcStationList getAtcStationsBooked() const override
{ {
// this->log(Q_FUNC_INFO); // this->log(Q_FUNC_INFO);
return m_atcStationsBooked; return m_atcStationsBooked;
} }
/*! //! \copydoc IContextNetwork::getAircraftsInRange()
* \copydoc IContextNetwork::getAircraftsInRange() virtual const BlackMisc::Aviation::CAircraftList getAircraftsInRange() const override
*/
virtual const BlackMisc::Aviation::CAircraftList getAircraftsInRange() const
{ {
// this->log(Q_FUNC_INFO); // this->log(Q_FUNC_INFO);
return m_aircraftsInRange; return m_aircraftsInRange;
} }
/*! //! \copydoc IContextNetwork::connectToNetwork()
* \copydoc IContextNetwork::connectToNetwork() virtual BlackMisc::CStatusMessageList connectToNetwork(uint mode) override;
*/
virtual BlackMisc::CStatusMessageList connectToNetwork(uint mode);
/*! //! \copydoc IContextNetwork::disconnectFromNetwork()
* \copydoc IContextNetwork::disconnectFromNetwork() virtual BlackMisc::CStatusMessageList disconnectFromNetwork() override;
*/
virtual BlackMisc::CStatusMessageList disconnectFromNetwork();
/*! //! \copydoc IContextNetwork::isConnected()
* \copydoc IContextNetwork::isConnected() virtual bool isConnected() const override;
*/
virtual bool isConnected() const;
/*! //! \copydoc IContextNetwork::setOwnAircraft()
* \copydoc IContextNetwork::setOwnAircraft() virtual BlackMisc::CStatusMessageList setOwnAircraft(const BlackMisc::Aviation::CAircraft &aircraft) override;
*/
virtual BlackMisc::CStatusMessageList setOwnAircraft(const BlackMisc::Aviation::CAircraft &aircraft);
/*! //! \copydoc IContextNetwork::updateOwnPosition()
* \copydoc IContextNetwork::updateOwnPosition() virtual void updateOwnPosition(const BlackMisc::Geo::CCoordinateGeodetic &position, const BlackMisc::Aviation::CAltitude &altitude) override;
*/
virtual void updateOwnPosition(const BlackMisc::Geo::CCoordinateGeodetic &position, const BlackMisc::Aviation::CAltitude &altitude);
/*! //! \copydoc IContextNetwork::updateOwnSituation()
* \copydoc IContextNetwork::updateOwnSituation() virtual void updateOwnSituation(const BlackMisc::Aviation::CAircraftSituation &situation) override;
*/
virtual void updateOwnSituation(const BlackMisc::Aviation::CAircraftSituation &situation);
/*! //! \copydoc IContextNetwork::updateOwnCockpit()
* \copydoc IContextNetwork::updateOwnCockpit() virtual void updateOwnCockpit(const BlackMisc::Aviation::CComSystem &com1, const BlackMisc::Aviation::CComSystem &com2, const BlackMisc::Aviation::CTransponder &transponder) override;
*/
virtual void updateOwnCockpit(const BlackMisc::Aviation::CComSystem &com1, const BlackMisc::Aviation::CComSystem &com2, const BlackMisc::Aviation::CTransponder &transponder);
//! \copydoc IContextNetwork::getOwnAircraft() //! \copydoc IContextNetwork::getOwnAircraft()
virtual BlackMisc::Aviation::CAircraft getOwnAircraft() const; virtual BlackMisc::Aviation::CAircraft getOwnAircraft() const override;
//! \copydoc IContextNetwork::sendTextMessages() //! \copydoc IContextNetwork::sendTextMessages()
virtual void sendTextMessages(const BlackMisc::Network::CTextMessageList &textMessages); virtual void sendTextMessages(const BlackMisc::Network::CTextMessageList &textMessages) override;
//! \copydoc IContextNetwork::getMetar() //! \copydoc IContextNetwork::getMetar()
virtual BlackMisc::Aviation::CInformationMessage getMetar(const QString &airportIcaoCode); virtual BlackMisc::Aviation::CInformationMessage getMetar(const QString &airportIcaoCode) override;
//! \copydoc IContextNetwork::getSelectedVoiceRooms() //! \copydoc IContextNetwork::getSelectedVoiceRooms()
virtual BlackMisc::Voice::CVoiceRoomList getSelectedVoiceRooms() const; virtual BlackMisc::Voice::CVoiceRoomList getSelectedVoiceRooms() const override;
//! \copydoc IContextNetwork::getSelectedAtcStations //! \copydoc IContextNetwork::getSelectedAtcStations
virtual BlackMisc::Aviation::CAtcStationList getSelectedAtcStations() const; virtual BlackMisc::Aviation::CAtcStationList getSelectedAtcStations() const override;
//! \copydoc IContextNetwork::getUsers() //! \copydoc IContextNetwork::getUsers()
virtual BlackMisc::Network::CUserList getUsers() const; virtual BlackMisc::Network::CUserList getUsers() const override;
//! \copydoc IContextNetwork::getUsersForCallsigns //! \copydoc IContextNetwork::getUsersForCallsigns
virtual BlackMisc::Network::CUserList getUsersForCallsigns(const BlackMisc::Aviation::CCallsignList &callsigns) const; virtual BlackMisc::Network::CUserList getUsersForCallsigns(const BlackMisc::Aviation::CCallsignList &callsigns) const override;
//! \copydoc IContextNetwork::requestDataUpdates //! \copydoc IContextNetwork::requestDataUpdates
virtual void requestDataUpdates(); virtual void requestDataUpdates()override;
//! \copydoc IContextNetwork::requestAtisUpdates //! \copydoc IContextNetwork::requestAtisUpdates
virtual void requestAtisUpdates(); virtual void requestAtisUpdates() override;
private: private:
BlackMisc::Aviation::CAtcStationList m_atcStationsOnline; BlackMisc::Aviation::CAtcStationList m_atcStationsOnline;
@@ -179,40 +152,28 @@ namespace BlackCore
QTimer *m_dataUpdateTimer; //!< general updates such as ATIS, frequencies, see requestDataUpdates() QTimer *m_dataUpdateTimer; //!< general updates such as ATIS, frequencies, see requestDataUpdates()
QDateTime m_atcBookingsUpdateTimestamp; QDateTime m_atcBookingsUpdateTimestamp;
/*! //! \brief Replace value by new values
* \brief Replace value by new values
*/
void setAtcStationsBooked(const BlackMisc::Aviation::CAtcStationList &newStations); void setAtcStationsBooked(const BlackMisc::Aviation::CAtcStationList &newStations);
/*! //! \brief Replace value by new values
* \brief Replace value by new values
*/
void setAtcStationsOnline(const BlackMisc::Aviation::CAtcStationList &newStations); void setAtcStationsOnline(const BlackMisc::Aviation::CAtcStationList &newStations);
/*! //! \brief The "central" ATC list with online ATC controllers
* \brief The "central" ATC list with online ATC controllers
*/
BlackMisc::Aviation::CAtcStationList &atcStationsOnline() BlackMisc::Aviation::CAtcStationList &atcStationsOnline()
{ {
return m_atcStationsOnline; return m_atcStationsOnline;
} }
/*! //! \brief ATC list, with booked controllers
* \brief ATC list, with booked controllers
*/
BlackMisc::Aviation::CAtcStationList &atcStationsBooked() BlackMisc::Aviation::CAtcStationList &atcStationsBooked()
{ {
return m_atcStationsBooked; return m_atcStationsBooked;
} }
/*! //! \brief Init my very onw aircraft
* \brief Init my very onw aircraft
*/
void initOwnAircraft(); void initOwnAircraft();
/*! //! \brief Get network settings
* \brief Get network settings
*/
BlackMisc::Settings::CSettingsNetwork getNetworkSettings() const BlackMisc::Settings::CSettingsNetwork getNetworkSettings() const
{ {
Q_ASSERT(this->getRuntime()); Q_ASSERT(this->getRuntime());
@@ -222,15 +183,13 @@ namespace BlackCore
private slots: private slots:
/*! /*!
* \brief Connection status changed * \brief Connection status changed?
* \param from old status * \param from old status
* \param to new status * \param to new status
*/ */
void psFsdConnectionStatusChanged(INetwork::ConnectionStatus from, INetwork::ConnectionStatus to); void psFsdConnectionStatusChanged(INetwork::ConnectionStatus from, INetwork::ConnectionStatus to);
/*! //! \brief ATC position update
* \brief ATC position update
*/
void psFsdAtcPositionUpdate(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::PhysicalQuantities::CFrequency &frequency, const BlackMisc::Geo::CCoordinateGeodetic &position, const BlackMisc::PhysicalQuantities::CLength &range); void psFsdAtcPositionUpdate(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::PhysicalQuantities::CFrequency &frequency, const BlackMisc::Geo::CCoordinateGeodetic &position, const BlackMisc::PhysicalQuantities::CLength &range);
/*! /*!
@@ -239,9 +198,7 @@ namespace BlackCore
*/ */
void psFsdAtcControllerDisconnected(const BlackMisc::Aviation::CCallsign &callsign); void psFsdAtcControllerDisconnected(const BlackMisc::Aviation::CCallsign &callsign);
/*! //! \brief ATIS received
* \brief ATIS received
*/
void psFsdAtisQueryReceived(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::Aviation::CInformationMessage &atisMessage); void psFsdAtisQueryReceived(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::Aviation::CInformationMessage &atisMessage);
/*! /*!
@@ -258,39 +215,25 @@ namespace BlackCore
*/ */
void psFsdAtisLogoffTimeQueryReceived(const BlackMisc::Aviation::CCallsign &callsign, const QString &zuluTime); void psFsdAtisLogoffTimeQueryReceived(const BlackMisc::Aviation::CCallsign &callsign, const QString &zuluTime);
/*! //! \brief METAR received
* \brief METAR received
*/
void psFsdMetarReceived(const QString &metarMessage); void psFsdMetarReceived(const QString &metarMessage);
/*! //! \brief Realname recevied
* \brief Realname recevied
*/
void psFsdRealNameReplyReceived(const BlackMisc::Aviation::CCallsign &callsign, const QString &realname); void psFsdRealNameReplyReceived(const BlackMisc::Aviation::CCallsign &callsign, const QString &realname);
/*! //! \brief Plane ICAO codes received
* \brief Plane ICAO codes received
*/
void psFsdIcaoCodesReceived(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::Aviation::CAircraftIcao &icaoData); void psFsdIcaoCodesReceived(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::Aviation::CAircraftIcao &icaoData);
/*! //! \brief Aircraft position update received
* \brief Aircraft position update received
*/
void psFsdAircraftUpdateReceived(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::Aviation::CAircraftSituation &situation, const BlackMisc::Aviation::CTransponder &transponder); void psFsdAircraftUpdateReceived(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::Aviation::CAircraftSituation &situation, const BlackMisc::Aviation::CTransponder &transponder);
/*! //! \brief Pilot disconnected
* \brief Pilot disconnected
*/
void psFsdPilotDisconnected(const BlackMisc::Aviation::CCallsign &callsign); void psFsdPilotDisconnected(const BlackMisc::Aviation::CCallsign &callsign);
/*! //! \brief Frequency received
* \brief Frequency received
*/
void psFsdFrequencyReceived(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::PhysicalQuantities::CFrequency &frequency); void psFsdFrequencyReceived(const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::PhysicalQuantities::CFrequency &frequency);
/*! //! \brief Radio text messages received
* \brief Radio text messages received
*/
void psFsdTextMessageReceived(const BlackMisc::Network::CTextMessageList &messages); void psFsdTextMessageReceived(const BlackMisc::Network::CTextMessageList &messages);
/*! /*!
@@ -300,7 +243,6 @@ namespace BlackCore
void psAtcBookingsRead(QNetworkReply *nwReply); void psAtcBookingsRead(QNetworkReply *nwReply);
}; };
} }
#endif // guard #endif // guard