mirror of
https://github.com/swift-project/pilotclient.git
synced 2026-04-16 10:25:36 +08:00
Renaming, header, Doxygen, formatting (during refs #314)
This commit is contained in:
@@ -1,7 +1,13 @@
|
||||
/* Copyright (C) 2013 VATSIM Community / contributors
|
||||
* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
||||
/* Copyright (C) 2013
|
||||
* swift project Community / Contributors
|
||||
*
|
||||
* This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
|
||||
* directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
|
||||
* including this file, may be copied, modified, propagated, or distributed except according to the terms
|
||||
* contained in the LICENSE file.
|
||||
*/
|
||||
|
||||
//! \file
|
||||
|
||||
#ifndef BLACKSIM_FSCOMMON_AIRCRAFTMAPPING_H
|
||||
#define BLACKSIM_FSCOMMON_AIRCRAFTMAPPING_H
|
||||
@@ -17,7 +23,7 @@ namespace BlackSim
|
||||
namespace FsCommon
|
||||
{
|
||||
|
||||
//! \brief Aircraft mapping class, represents one particular mapping
|
||||
//! Aircraft mapping class, represents one particular mapping
|
||||
class CAircraftMapping : public BlackMisc::CValueObject
|
||||
{
|
||||
|
||||
@@ -42,20 +48,20 @@ namespace BlackSim
|
||||
|
||||
private:
|
||||
BLACK_ENABLE_TUPLE_CONVERSION(CAircraftMapping)
|
||||
qint32 m_mappingId; //!< Kind of primary key for this particular mapping
|
||||
qint32 m_mappingId; //!< Kind of primary key for this particular mapping
|
||||
qint32 m_proposalId; //!< If proposal id of the proposal
|
||||
QString m_fsAircraftKey; //!< Id by which the simulator can create the aircraft
|
||||
QString m_aircraftDesignator; //!< Aircraft designator such as B737
|
||||
QString m_airlineDesignator; //!< Airline designator such as DLH
|
||||
QString m_aircraftCombinedType; //!< Engine, type, number of engines L2J, L1P
|
||||
QString m_fsAircraftKey; //!< Id by which the simulator can create the aircraft
|
||||
QString m_aircraftDesignator; //!< Aircraft designator such as B737
|
||||
QString m_airlineDesignator; //!< Airline designator such as DLH
|
||||
QString m_aircraftCombinedType; //!< Engine, type, number of engines L2J, L1P
|
||||
QString m_wakeTurbulenceCategory; //!< Wake turbulence category H, L, M
|
||||
QString m_aircraftColor; //!< Aircrafts painting designator, could be same as airline or specific
|
||||
QString m_lastChanged; //!< Simple timestamp as YYYYMMDDhhmmss
|
||||
QString m_lastChanged; //!< Simple timestamp as YYYYMMDDhhmmss
|
||||
BlackSim::CSimulatorInfo m_simulatorInfo; //!< Mapping is for simulator
|
||||
bool m_changed; //! Changed flag
|
||||
|
||||
public:
|
||||
//! \brief Columns
|
||||
//! Columns
|
||||
enum ColumnIndex
|
||||
{
|
||||
IndexMappingId = 0,
|
||||
@@ -70,11 +76,11 @@ namespace BlackSim
|
||||
IndexSimulatorInfo
|
||||
};
|
||||
|
||||
//! \brief Default mapping
|
||||
//! Default mapping
|
||||
CAircraftMapping();
|
||||
|
||||
/*!
|
||||
* \brief Complete constructor
|
||||
* Complete constructor
|
||||
* \param mappingId
|
||||
* \param proposalId
|
||||
* \param fsAircraftKey
|
||||
@@ -88,117 +94,108 @@ namespace BlackSim
|
||||
*/
|
||||
CAircraftMapping(qint32 mappingId, qint32 proposalId, const QString &fsAircraftKey, const QString &icaoAircraftDesignator, const QString &icaoAirline, const QString &icaoAircraftType, const QString &icaoWakeTurbulenceCategory, const QString &painting, const QString &lastChanged, CSimulatorInfo simulator);
|
||||
|
||||
//! \brief Virtual destructor
|
||||
//! Virtual destructor
|
||||
virtual ~CAircraftMapping()
|
||||
{}
|
||||
|
||||
//! \brief operator ==
|
||||
//! operator ==
|
||||
bool operator ==(const CAircraftMapping &otherMapping) const;
|
||||
|
||||
//! \brief operator !=
|
||||
//! operator !=
|
||||
bool operator !=(const CAircraftMapping &otherMapping) const;
|
||||
|
||||
//! \brief Mapping id
|
||||
//! Mapping id
|
||||
qint32 getMappingId() const { return this->m_mappingId; }
|
||||
|
||||
//! \brief Proposal id (if proposal, otherwise <0)
|
||||
//! Proposal id (if proposal, otherwise <0)
|
||||
qint32 getProposalId() const { return this->m_proposalId; }
|
||||
|
||||
//! \brief Aircraft key
|
||||
//! Aircraft key
|
||||
QString getFsAircraftKey() const { return this->m_fsAircraftKey; }
|
||||
|
||||
//! \brief ICAO designator (B737)
|
||||
//! ICAO designator (B737)
|
||||
QString getAircraftDesignator() const { return this->m_aircraftDesignator; }
|
||||
|
||||
//! \brief ICAO airline (DLH)
|
||||
//! ICAO airline (DLH)
|
||||
QString getAirlineDesignator() const { return this->m_airlineDesignator; }
|
||||
|
||||
//! \brief ICAO aircraft type (L2J)
|
||||
//! ICAO aircraft type (L2J)
|
||||
QString getAircraftCombinedType() const { return this->m_aircraftCombinedType; }
|
||||
|
||||
//! \brief ICAO wake turbulence category (L,M,H)
|
||||
//! ICAO wake turbulence category (L,M,H)
|
||||
QString getWakeTurbulenceCategory() const { return this->m_wakeTurbulenceCategory; }
|
||||
|
||||
//! \brief Painting, basically the airline code for GA planes
|
||||
//! Painting, basically the airline code for GA planes
|
||||
QString getAircraftColor() const { return this->m_aircraftColor; }
|
||||
|
||||
//! \brief Last changed timestamp YYYYMMDDhhmmss
|
||||
//! Last changed timestamp YYYYMMDDhhmmss
|
||||
QString getLastChanged() const { return this->m_lastChanged; }
|
||||
|
||||
//! \brief Last changed timestamp YYYYMMDDhhmmss
|
||||
//! Last changed timestamp YYYYMMDDhhmmss
|
||||
QString getLastChangedFormatted() const;
|
||||
|
||||
//! \brief Simulator
|
||||
//! Simulator
|
||||
BlackSim::CSimulatorInfo getSimulatorInfo() const { return this->m_simulatorInfo; }
|
||||
|
||||
//! \brief Simulator
|
||||
//! Simulator
|
||||
QString getSimulatorText() const;
|
||||
|
||||
//! \brief Get changed flag
|
||||
bool isChanged() const { return this->m_changed; }
|
||||
|
||||
//! \brief Valid data?
|
||||
//! Valid data?
|
||||
bool isValid() const
|
||||
{
|
||||
QString v = this->validate();
|
||||
return v.isEmpty();
|
||||
}
|
||||
|
||||
//! \brief Validate and return error messages, empty string means all OK.
|
||||
//! Validate and return error messages, empty string means all OK.
|
||||
QString validate() const;
|
||||
|
||||
//! \brief Set mapping id
|
||||
//! Set mapping id
|
||||
void setMappingId(qint32 mappingId) { this->m_mappingId = mappingId; }
|
||||
|
||||
//! \brief Proposal id
|
||||
//! Proposal id
|
||||
void setProposalId(qint32 proposalId) { this->m_proposalId = proposalId; }
|
||||
|
||||
//! \brief Aircraft key
|
||||
//! Aircraft key
|
||||
void setFsAircraftKey(const QString &aircraftKey) { this->m_fsAircraftKey = aircraftKey; }
|
||||
|
||||
//! \brief ICAO designator (B737)
|
||||
//! ICAO designator (B737)
|
||||
void setAircraftDesignator(const QString &icaoDesignator) { this->m_aircraftDesignator = icaoDesignator.toUpper(); }
|
||||
|
||||
//! \brief ICAO airline (DLH)
|
||||
//! ICAO airline (DLH)
|
||||
void setAirlineDesignator(const QString &airline) { this->m_airlineDesignator = airline.toUpper(); }
|
||||
|
||||
//! \brief ICAO aircraft type (L2J)
|
||||
//! ICAO aircraft type (L2J)
|
||||
void setAircraftCombinedType(const QString &aircraftType) { this->m_aircraftCombinedType = aircraftType.toUpper(); }
|
||||
|
||||
//! \brief ICAO wake turbulence category
|
||||
//! ICAO wake turbulence category
|
||||
void setWakeTurbulenceCategory(const QString &wtc) { this->m_wakeTurbulenceCategory = wtc.toUpper(); }
|
||||
|
||||
//! \brief Painting, basically the airline code for GA planes
|
||||
//! Painting, basically the airline code for GA planes
|
||||
void setAircraftColor(const QString &painting) { this->m_aircraftColor = painting; }
|
||||
|
||||
//! \brief Last changed timestamp YYYYMMDDhhmmss
|
||||
//! Last changed timestamp YYYYMMDDhhmmss
|
||||
void setLastChanged(qint32 lastChanged) { this->m_lastChanged = lastChanged; }
|
||||
|
||||
//! \brief Simulator
|
||||
//! Simulator
|
||||
void setSimulator(BlackSim::CSimulatorInfo simulator) { this->m_simulatorInfo = simulator; }
|
||||
|
||||
//! \brief Set simulator text
|
||||
//! Set simulator text
|
||||
void setSimulatorText(const QString &simulator);
|
||||
|
||||
//! \brief Set changed flag
|
||||
void setChanged(bool changed) { this->m_changed = changed; }
|
||||
|
||||
//! \copydoc CValueObject::propertyByIndex
|
||||
QVariant propertyByIndex(int index) const override;
|
||||
|
||||
//! \copydoc CValueObject::setPropertyByIndex()
|
||||
void setPropertyByIndex(const QVariant &value, int index) override;
|
||||
void setPropertyByIndex(const QVariant &value, const BlackMisc::CPropertyIndex &index) override;
|
||||
|
||||
//! \copydoc CValueObject::toQVariant()
|
||||
virtual QVariant toQVariant() const override
|
||||
{
|
||||
return QVariant::fromValue(*this);
|
||||
}
|
||||
virtual QVariant toQVariant() const override { return QVariant::fromValue(*this); }
|
||||
|
||||
//! \copydoc CValueObject::getValueHash()
|
||||
virtual uint getValueHash() const override;
|
||||
|
||||
//! \brief Current UTC timestamp
|
||||
//! Current UTC timestamp
|
||||
static QString currentUtcTimestamp()
|
||||
{
|
||||
QDateTime dateTime = QDateTime::currentDateTimeUtc();
|
||||
@@ -212,10 +209,10 @@ namespace BlackSim
|
||||
//! \copydoc CValueObject::fromJson
|
||||
virtual void fromJson(const QJsonObject &json) override;
|
||||
|
||||
//! \brief Register metadata
|
||||
//! Register metadata
|
||||
static void registerMetadata();
|
||||
|
||||
//! \brief Members
|
||||
//! Members
|
||||
static const QStringList &jsonMembers();
|
||||
};
|
||||
} // namespace
|
||||
|
||||
Reference in New Issue
Block a user