Files
pilotclient/src/misc/crashinfo.h
2024-11-16 21:40:55 +01:00

109 lines
3.2 KiB
C++

// SPDX-FileCopyrightText: Copyright (C) 2018 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
//! \file
#ifndef SWIFT_MISC_CRASHINFO_H
#define SWIFT_MISC_CRASHINFO_H
#include <QString>
#include "misc/valueobject.h"
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::misc, CCrashInfo)
namespace swift::misc
{
/*!
* Crash info. Details about crash context.
*/
class SWIFT_MISC_EXPORT CCrashInfo : public CValueObject<CCrashInfo>
{
public:
//! Properties by index
enum ColumnIndex
{
IndexUserName = CPropertyIndexRef::GlobalIndexCCrashInfo,
IndexInfo,
IndexSimulatorString,
IndexFlightNetworkInfo
};
//! Default constructor.
CCrashInfo() = default;
//! Get user name
const QString &getUserName() const { return m_userName; }
//! User name
void setUserName(const QString &userName) { m_userName = userName; }
//! Any info available?
bool hasInfo() const { return !m_info.isEmpty(); }
//! Get the info
const QString &getInfo() const { return m_info; }
//! Set info
void setInfo(const QString &info) { m_info = info; }
//! Simulator string
const QString &getSimulatorString() const { return m_simulatorString; }
//! Simulator string
void setSimulatorString(const QString &simString) { m_simulatorString = simString; }
//! Network string
const QString &getFlightNetworkString() const { return m_flightNetwork; }
//! Network string
void setFlightNetworkString(const QString &network) { m_flightNetwork = network; }
//! Append some info
void appendInfo(const QString &extraInfo);
//! Set path and file name
void setLogPathAndFileName(const QString &fileName);
//! \copydoc swift::misc::mixin::String::toQString
QString convertToQString(bool i18n = false) const;
//! \copydoc swift::misc::mixin::Index::propertyByIndex
QVariant propertyByIndex(CPropertyIndexRef index) const;
//! \copydoc swift::misc::mixin::Index::setPropertyByIndex
void setPropertyByIndex(CPropertyIndexRef index, const QVariant &variant);
//! \copydoc swift::misc::mixin::Index::comparePropertyByIndex
int comparePropertyByIndex(CPropertyIndexRef index, const CCrashInfo &compareValue) const;
//! Trigger writing this to file (in background)
void triggerWritingFile() const;
//! Write to file (synchronous)
bool writeToFile() const;
//! Summary
QString summary() const;
private:
QString m_userName;
QString m_info;
QString m_simulatorString;
QString m_flightNetwork;
QString m_logFileAndPath;
SWIFT_METACLASS(
CCrashInfo,
SWIFT_METAMEMBER(userName),
SWIFT_METAMEMBER(info),
SWIFT_METAMEMBER(simulatorString),
SWIFT_METAMEMBER(flightNetwork),
SWIFT_METAMEMBER(logFileAndPath));
};
} // namespace swift::misc
Q_DECLARE_METATYPE(swift::misc::CCrashInfo)
#endif // SWIFT_MISC_CRASHINFO_H