refs #345 Style and doxygen.

This commit is contained in:
Mathew Sutcliffe
2014-10-28 19:46:52 +00:00
parent 8f5315b846
commit 798b198d4e
78 changed files with 268 additions and 531 deletions

View File

@@ -19,7 +19,6 @@ namespace BlackSim
{
namespace FsCommon
{
/*!
* Set of aircraft.cfg entries representing an aircraft (FSX)
* \remarks an entry in the aircraft.cfg is title, atc type, ... This class already bundles
@@ -28,7 +27,6 @@ namespace BlackSim
class CAircraftCfgEntries: public BlackMisc::CValueObject
{
public:
//! Properties by index
enum ColumnIndex
{
@@ -41,7 +39,7 @@ namespace BlackSim
};
//! Default constructor
CAircraftCfgEntries() {}
CAircraftCfgEntries() = default;
/*!
* Entries representing an aircraft
@@ -54,9 +52,6 @@ namespace BlackSim
*/
CAircraftCfgEntries(const QString &filePath, qint32 index, const QString &title, const QString &atcType, const QString &atcModel, const QString &atcParkingCode);
//! Virtual destructor
virtual ~CAircraftCfgEntries() {}
//! operator ==
bool operator ==(const CAircraftCfgEntries &other) const;
@@ -153,7 +148,7 @@ namespace BlackSim
};
}
} // namespace
}
BLACK_DECLARE_TUPLE_CONVERSION(BlackSim::FsCommon::CAircraftCfgEntries, (o.m_index, o.m_filePath, o.m_title, o.m_atcType, o.m_atcModel, o.m_atcParkingCode))
Q_DECLARE_METATYPE(BlackSim::FsCommon::CAircraftCfgEntries)

View File

@@ -22,18 +22,12 @@ namespace BlackSim
{
namespace FsCommon
{
//! Aircraft mapping class, represents one particular mapping
class CAircraftMapping : public BlackMisc::CValueObject
{
public:
static const qint32 InvalidId = -1; //!< Invalid mapping id
protected:
//! \copydoc CValueObject::convertToQString
virtual QString convertToQString(bool i18n = false) const;
//! \copydoc CValueObject::marshallToDbus
virtual void marshallToDbus(QDBusArgument &) const override;
@@ -46,20 +40,6 @@ namespace BlackSim
//! \copydoc CValueObject::compareImpl
int compareImpl(const CValueObject &otherBase) const override;
private:
BLACK_ENABLE_TUPLE_CONVERSION(CAircraftMapping)
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_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
BlackSim::CSimulatorInfo m_simulatorInfo; //!< Mapping is for simulator
bool m_changed; //! Changed flag
public:
//! Columns
enum ColumnIndex
@@ -206,9 +186,25 @@ namespace BlackSim
return dateTimeString;
}
protected:
//! \copydoc CValueObject::convertToQString
virtual QString convertToQString(bool i18n = false) const;
//! \copydoc CValueObject::toJson
virtual QJsonObject toJson() const override;
private:
BLACK_ENABLE_TUPLE_CONVERSION(CAircraftMapping)
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_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
BlackSim::CSimulatorInfo m_simulatorInfo; //!< Mapping is for simulator
bool m_changed; //! Changed flag
//! \copydoc CValueObject::convertFromJson
virtual void convertFromJson(const QJsonObject &json) override;

View File

@@ -29,9 +29,6 @@ namespace BlackSim
//! Default constructor.
CSettingsSimulator();
//! Destructor.
virtual ~CSettingsSimulator() {}
//! Path
static const QString &ValueSelectedDriver()
{