textmessage.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2013 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_NETWORK_TEXTMESSAGE_H
#define SWIFT_MISC_NETWORK_TEXTMESSAGE_H
 
#include <QMetaType>
#include <QPixmap>
#include <QString>
 
#include "misc/aviation/callsign.h"
#include "misc/metaclass.h"
#include "misc/pq/frequency.h"
#include "misc/pq/units.h"
#include "misc/propertyindexref.h"
#include "misc/statusmessage.h"
#include "misc/swiftmiscexport.h"
#include "misc/timestampbased.h"
#include "misc/valueobject.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::misc::network, CTextMessage)
 
namespace swift::misc::network
{
    class SWIFT_MISC_EXPORT CTextMessage : public CValueObject<CTextMessage>, public ITimestampBased
    {
    public:
        enum ColumnIndex
        {
            IndexSenderCallsign = CPropertyIndexRef::GlobalIndexCTextMessage,
            IndexRecipientCallsign,
            IndexRecipientCallsignOrFrequency,
            IndexMessage
        };
 
        CTextMessage() {}
 
        CTextMessage(const QString &message, const physical_quantities::CFrequency &frequency,
                     const aviation::CCallsign &senderCallsign = {});
 
        CTextMessage(const QString &message, const aviation::CCallsign &senderCallsign,
                     const aviation::CCallsign &recipientCallsign = {});
 
        const aviation::CCallsign &getSenderCallsign() const { return m_senderCallsign; }
 
        void setSenderCallsign(const aviation::CCallsign &callsign) { m_senderCallsign = callsign; }
 
        const aviation::CCallsign &getRecipientCallsign() const { return m_recipientCallsign; }
 
        void setRecipientCallsign(const aviation::CCallsign &callsign) { m_recipientCallsign = callsign; }
 
        QString getRecipientCallsignOrFrequency() const;
 
        bool isSendToFrequency(const physical_quantities::CFrequency &frequency) const;
 
        bool isSendToUnicom() const;
 
        bool hasValidRecipient() const;
 
        const QString &getMessage() const { return m_message; }
 
        bool mentionsCallsign(const aviation::CCallsign &callsign) const;
 
        QString getAsciiOnlyMessage() const;
 
        QString getHtmlEncodedMessage() const;
 
        bool isEmpty() const { return m_message.isEmpty(); }
 
        void setMessage(const QString &message);
 
        const physical_quantities::CFrequency &getFrequency() const { return m_frequency; }
 
        void setFrequency(const physical_quantities::CFrequency &frequency) { m_frequency = frequency; }
 
        bool isPrivateMessage() const;
 
        bool isRadioMessage() const;
 
        bool isServerMessage() const;
 
        bool isBroadcastMessage() const;
 
        bool isWallopMessage() const;
 
        QString asString(bool withSender, bool withRecipient, const QString &separator = ", ") const;
 
        CStatusMessage asStatusMessage(bool withSender, bool withRecipient, const QString &separator = ", ") const;
 
        QString asHtmlSummary(const QString &separator = "<br>") const;
 
        void toggleSenderRecipient();
 
        bool isSelcalMessage() const;
 
        bool isSelcalMessageFor(const QString &selcal) const;
 
        bool isSupervisorMessage() const;
 
        bool wasSent() const { return m_wasSent; }
 
        void markAsSent();
 
        bool isRelayedMessage() const;
 
        void markAsRelayedMessage() { m_relayedMessage = true; }
 
        void markAsBroadcastMessage();
 
        void makeRelayedMessage(const aviation::CCallsign &partnerCallsign);
 
        bool relayedMessageToPrivateMessage();
 
        bool canBeAppended(const CTextMessage &textMessage) const;
 
        bool appendIfPossible(const CTextMessage &textMessage);
 
        QString getSelcalCode() const;
 
        CIcons::IconIndex toIcon() const;
 
        QPixmap toPixmap() const;
 
        QVariant propertyByIndex(swift::misc::CPropertyIndexRef index) const;
 
        void setPropertyByIndex(swift::misc::CPropertyIndexRef index, const QVariant &variant);
 
        int comparePropertyByIndex(CPropertyIndexRef index, const CTextMessage &compareValue) const;
 
        QString convertToQString(bool i18n = false) const;
 
        static const QString &swiftRelayMessage();
 
    private:
        QString m_message;
        aviation::CCallsign m_senderCallsign;
        aviation::CCallsign m_recipientCallsign;
        physical_quantities::CFrequency m_frequency { 0, nullptr };
        bool m_wasSent = false; 
        bool m_relayedMessage = false; 
 
        SWIFT_METACLASS(
            CTextMessage,
            SWIFT_METAMEMBER(message),
            SWIFT_METAMEMBER(timestampMSecsSinceEpoch),
            SWIFT_METAMEMBER(senderCallsign),
            SWIFT_METAMEMBER(recipientCallsign),
            SWIFT_METAMEMBER(frequency));
    };
} // namespace swift::misc::network
 
Q_DECLARE_METATYPE(swift::misc::network::CTextMessage)
 
#endif // SWIFT_MISC_NETWORK_TEXTMESSAGE_H