refs #396 BlackMisc: nw* goes to network/, hw* goes to hardware/

src/blackmisc/network/textmessagelist.h

@@ -0,0 +1,107 @@
+/* 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 BLACKMISC_NETWORK_TEXTMESSAGELIST_H
+#define BLACKMISC_NETWORK_TEXTMESSAGELIST_H
+
+#include "blackmisc/network/textmessage.h"
+#include "blackmisc/timestampobjectlist.h"
+#include "blackmisc/collection.h"
+#include "blackmisc/sequence.h"
+#include <QObject>
+#include <QString>
+#include <QList>
+
+namespace BlackMisc
+{
+    namespace Network
+    {
+        /*!
+         * Value object encapsulating a list of text messages
+         */
+        class CTextMessageList :
+            public CSequence<CTextMessage>,
+            public BlackMisc::ITimestampObjectList<CTextMessage, CTextMessageList>
+        {
+        public:
+            //! Default constructor.
+            CTextMessageList();
+
+            //! Constructor, single private message
+            CTextMessageList(const QString &message, const BlackMisc::Aviation::CCallsign &recipientCallsign);
+
+            //! Constructor, single private message
+            CTextMessageList(const QString &message, const BlackMisc::Aviation::CCallsign &senderCallsign, const BlackMisc::Aviation::CCallsign &recipientCallsign);
+
+            //! Constructor, single radio message
+            CTextMessageList(const QString &message, const BlackMisc::PhysicalQuantities::CFrequency &frequency, const BlackMisc::Aviation::CCallsign &senderCallsign = BlackMisc::Aviation::CCallsign());
+
+            //! Constructor, single message
+            CTextMessageList(const CTextMessage &message);
+
+            //! Constructor, multi-frequency radio messages
+            CTextMessageList(const QString &message, const QList<BlackMisc::PhysicalQuantities::CFrequency> &frequencies, const BlackMisc::Aviation::CCallsign &sender = BlackMisc::Aviation::CCallsign());
+
+            //! Construct from a base class object.
+            CTextMessageList(const CSequence<CTextMessage> &other);
+
+            //! Private messages
+            CTextMessageList getPrivateMessages() const;
+
+            //! Contains private messages?
+            bool containsPrivateMessages() const;
+
+            //! Public messages
+            CTextMessageList getRadioMessages() const;
+
+            //! Supervisor messages
+            CTextMessageList getSupervisorMessages() const;
+
+            //! Contains radio messages?
+            bool containsRadioMessages() const;
+
+            //! Contains supervisor message
+            CTextMessageList containsSupervisorMessages() const;
+
+            //! Find by frequency
+            CTextMessageList findByFrequency(const BlackMisc::PhysicalQuantities::CFrequency &frequency) const;
+
+            //! Toggle all sender receivers
+            void toggleSenderRecipients();
+
+            //! Mark all messages as sent
+            void markAsSent();
+
+            //! \copydoc CValueObject::toQVariant
+            virtual QVariant toQVariant() const override { return QVariant::fromValue(*this); }
+
+            //! \copydoc CValueObject::convertFromQVariant
+            virtual void convertFromQVariant(const QVariant &variant) override { BlackMisc::setFromQVariant(this, variant); }
+
+            //! Register metadata
+            static void registerMetadata();
+
+        protected:
+            //! Myself
+            virtual const CTextMessageList &container() const override { return *this; }
+
+            //! Myself
+            virtual CTextMessageList &container() override { return *this; }
+
+        };
+    } //namespace
+} // namespace
+
+Q_DECLARE_METATYPE(BlackMisc::Network::CTextMessageList)
+Q_DECLARE_METATYPE(BlackMisc::CCollection<BlackMisc::Network::CTextMessage>)
+Q_DECLARE_METATYPE(BlackMisc::CSequence<BlackMisc::Network::CTextMessage>)
+
+#endif //guard