labplot  2.8.2
About: LabPlot is an application for plotting and analysis of 2D and 3D functions and data. It is a complete rewrite of LabPlot1 and lacks in the first release a lot of features available in the predecessor. On the other hand, the GUI and the usability is more superior.
  Fossies Dox: labplot-2.8.2.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

MQTTTopic Class Reference

Represents a topic of a subscription made in MQTTClient. More...

#include <MQTTTopic.h>

Inheritance diagram for MQTTTopic:
[legend]
Collaboration diagram for MQTTTopic:
[legend]

Public Slots

void read ()
 Reads every message from the message puffer. More...
 
- Public Slots inherited from Spreadsheet
void appendRows (int)
 
void appendRow ()
 
void appendColumns (int)
 
void appendColumn ()
 
void prependColumns (int)
 
void setColumnCount (int)
 
void setRowCount (int)
 
void clear ()
 
void clearMasks ()
 
void moveColumn (int from, int to)
 
void sortColumns (Column *leading, const QVector< Column * > &, bool ascending)
 
- Public Slots inherited from AbstractAspect
bool setName (const QString &, bool autoUnique=true)
 AbstractAspect::setName sets the name of the abstract aspect. More...
 
void setComment (const QString &)
 
void remove ()
 Remove me from my parent's list of children. More...
 

Signals

void readOccured ()
 
- Signals inherited from Spreadsheet
void requestProjectContextMenu (QMenu *)
 
void columnSelected (int)
 
void columnDeselected (int)
 
void rowCountChanged (int)
 
void columnCountChanged (int)
 
- Signals inherited from AbstractPart
void showRequested ()
 
void importFromFileRequested ()
 
void importFromSQLDatabaseRequested ()
 
void exportRequested ()
 
void printRequested ()
 
void printPreviewRequested ()
 
- Signals inherited from AbstractAspect
void aspectDescriptionAboutToChange (const AbstractAspect *)
 Emitted before the name, comment or caption spec is changed. More...
 
void aspectDescriptionChanged (const AbstractAspect *)
 Emitted after the name, comment or caption spec have changed. More...
 
void aspectAboutToBeAdded (const AbstractAspect *parent, const AbstractAspect *before, const AbstractAspect *child)
 Emitted before a new child is inserted. More...
 
void aspectAdded (const AbstractAspect *)
 Emitted after a new Aspect has been added to the tree. More...
 
void aspectAboutToBeRemoved (const AbstractAspect *)
 Emitted before an aspect is removed from its parent. More...
 
void aspectRemoved (const AbstractAspect *parent, const AbstractAspect *before, const AbstractAspect *child)
 Emitted from the parent after removing a child. More...
 
void aspectHiddenAboutToChange (const AbstractAspect *)
 Emitted before the hidden attribute is changed. More...
 
void aspectHiddenChanged (const AbstractAspect *)
 Emitted after the hidden attribute has changed. More...
 
void statusInfo (const QString &)
 Emitted whenever some aspect in the tree wants to give status information to the user. More...
 
void renameRequested ()
 
void selected (const AbstractAspect *)
 
void deselected (const AbstractAspect *)
 
void childAspectSelectedInView (const AbstractAspect *)
 
void childAspectDeselectedInView (const AbstractAspect *)
 

Public Member Functions

 MQTTTopic (const QString &name, MQTTSubscription *subscription, bool loading=false)
 
 ~MQTTTopic () override
 
void setFilter (AsciiFilter *)
 Sets the MQTTTopic's filter The ownership of the filter is passed to MQTTTopic. More...
 
AsciiFilterfilter () const
 Returns the MQTTTopic's filter. More...
 
QIcon icon () const override
 Returns the MQTTTopic's icon. More...
 
QMenu * createContextMenu () override
 Adds an action to the MQTTTopic's context menu in the project explorer. More...
 
QWidget * view () const override
 Construct a primary view on me. More...
 
QString topicName () const
 Returns the name of the MQTTTopic. More...
 
MQTTClientmqttClient () const
 Returns the MQTTClient the topic belongs to. More...
 
void newMessage (const QString &)
 Adds a message received by the topic to the message puffer. More...
 
void save (QXmlStreamWriter *) const override
 
bool load (XmlStreamReader *, bool preview) override
 
- Public Member Functions inherited from Spreadsheet
 Spreadsheet (const QString &name, bool loading=false, AspectType type=AspectType::Spreadsheet)
 
QIcon icon () const override
 
QMenu * createContextMenu () override
 
QWidget * view () const override
 
bool exportView () const override
 
bool printView () override
 
bool printPreview () const override
 
void setModel (SpreadsheetModel *)
 
SpreadsheetModelmodel ()
 
void updateHorizontalHeader ()
 
void updateLocale ()
 
int columnCount () const
 
int columnCount (AbstractColumn::PlotDesignation) const
 
Columncolumn (int index) const
 
Columncolumn (const QString &) const
 
int rowCount () const
 
void removeRows (int first, int count)
 
void insertRows (int before, int count)
 
void removeColumns (int first, int count)
 
void insertColumns (int before, int count)
 
int colX (int col)
 
int colY (int col)
 
QString text (int row, int col) const
 
void copy (Spreadsheet *other)
 
void save (QXmlStreamWriter *) const override
 
bool load (XmlStreamReader *, bool preview) override
 
void setColumnSelectedInView (int index, bool selected)
 
void emitRowCountChanged ()
 
void emitColumnCountChanged ()
 
int prepareImport (std::vector< void * > &dataContainer, AbstractFileFilter::ImportMode, int rows, int cols, QStringList colNameList, QVector< AbstractColumn::ColumnMode >) override
 
void finalizeImport (int columnOffset, int startColumn, int endColumn, const QString &dateTimeFormat, AbstractFileFilter::ImportMode) override
 
int resize (AbstractFileFilter::ImportMode, QStringList colNameList, int cols)
 
- Public Member Functions inherited from AbstractDataSource
 AbstractDataSource (const QString &name, AspectType type)
 
 ~AbstractDataSource () override=default
 
void clear ()
 
- Public Member Functions inherited from AbstractPart
 AbstractPart (const QString &name, AspectType type)
 
 ~AbstractPart () override
 
void deleteView () const
 
PartMdiViewmdiSubWindow () const
 Wrap the view() into a PartMdiView. More...
 
bool hasMdiSubWindow () const
 
bool isDraggable () const override
 
QVector< AspectTypedropableOn () const override
 
virtual void registerShortcuts ()
 
virtual void unregisterShortcuts ()
 
- Public Member Functions inherited from AbstractAspect
 AbstractAspect (const QString &name, AspectType type)
 
 ~AbstractAspect () override
 
QString name () const
 
QString comment () const
 
void setCreationTime (const QDateTime &)
 
QDateTime creationTime () const
 
virtual Projectproject ()
 Return the Project this Aspect belongs to, or 0 if it is currently not part of one. More...
 
virtual QString path () const
 Return the path that leads from the top-most Aspect (usually a Project) to me. More...
 
void setHidden (bool)
 Set "hidden" property, i.e. whether to exclude this aspect from being shown in the explorer. More...
 
bool hidden () const
 
void setIsLoading (bool)
 
bool isLoading () const
 
AspectType type () const
 
bool inherits (AspectType type) const
 
AbstractAspectparentAspect () const
 Return my parent Aspect or 0 if I currently don't have one. More...
 
AbstractAspectparent (AspectType type) const
 In the parent-child hierarchy, return the first parent of type. More...
 
void setParentAspect (AbstractAspect *)
 
Folderfolder ()
 Return the folder the Aspect is contained in or 0 if there is none. More...
 
bool isDescendantOf (AbstractAspect *other)
 Return whether the there is a path upwards to the given aspect. More...
 
void addChild (AbstractAspect *)
 Add the given Aspect to my list of children. More...
 
void addChildFast (AbstractAspect *)
 Add the given Aspect to my list of children without any checks and without putting this step onto the undo-stack. More...
 
virtual void finalizeAdd ()
 
QVector< AbstractAspect * > children (AspectType type, ChildIndexFlags flags={}) const
 
void insertChildBefore (AbstractAspect *child, AbstractAspect *before)
 Insert the given Aspect at a specific position in my list of children. More...
 
void insertChildBeforeFast (AbstractAspect *child, AbstractAspect *before)
 Insert the given Aspect at a specific position in my list of children.without any checks and without putting this step onto the undo-stack. More...
 
void reparent (AbstractAspect *newParent, int newIndex=-1)
 Move a child to another parent aspect and transfer ownership. More...
 
void removeChild (AbstractAspect *)
 Remove the given Aspect from my list of children. More...
 
void removeAllChildren ()
 Remove all child Aspects. More...
 
virtual QVector< AbstractAspect * > dependsOn () const
 
virtual void processDropEvent (const QVector< quintptr > &)
 
template<class T >
T * ancestor () const
 Return the closest ancestor of class T (or NULL if none found). More...
 
template<class T >
QVector< T * > children (ChildIndexFlags flags={}) const
 
template<class T >
T * child (int index, ChildIndexFlags flags={}) const
 
template<class T >
T * child (const QString &name) const
 Get child by name and class. More...
 
template<class T >
int childCount (ChildIndexFlags flags={}) const
 Return the number of child Aspects inheriting from given class. More...
 
template<class T >
int indexOfChild (const AbstractAspect *child, ChildIndexFlags flags={}) const
 Return (0 based) index of child in the list of children inheriting from class T. More...
 
void setSelected (bool)
 
void setUndoAware (bool)
 
virtual QUndoStack * undoStack () const
 Return the undo stack of the Project, or 0 if this Aspect is not part of a Project. More...
 
void exec (QUndoCommand *)
 Execute the given command, pushing it on the undoStack() if available. More...
 
void exec (QUndoCommand *command, const char *preChangeSignal, const char *postChangeSignal, QGenericArgument val0=QGenericArgument(), QGenericArgument val1=QGenericArgument(), QGenericArgument val2=QGenericArgument(), QGenericArgument val3=QGenericArgument())
 Execute command and arrange for signals to be sent before/after it is redone or undone. More...
 
void beginMacro (const QString &text)
 Begin an undo stack macro (series of commands) More...
 
void endMacro ()
 End the current undo stack macro. More...
 

Private Slots

void plotData ()
 Plots the data stored in MQTTTopic. More...
 

Private Member Functions

void initActions ()
 Initializes the actions of MQTTTopic. More...
 

Private Attributes

QString m_topicName
 
MQTTClientm_MQTTClient
 
AsciiFilterm_filter
 
QVector< QString > m_messagePuffer
 
QAction * m_plotDataAction
 

Additional Inherited Members

- Public Types inherited from AbstractAspect
enum class  ChildIndexFlag { IncludeHidden = 0x01 , Recursive = 0x02 , Compress = 0x04 }
 Flags which control numbering scheme of children. More...
 
- Protected Slots inherited from AbstractAspect
virtual void childSelected (const AbstractAspect *)
 
virtual void childDeselected (const AbstractAspect *)
 
- Protected Member Functions inherited from AbstractAspect
void info (const QString &text)
 Implementations should call this whenever status information should be given to the user. More...
 
bool readBasicAttributes (XmlStreamReader *)
 Load name and creation time from XML. More...
 
void writeBasicAttributes (QXmlStreamWriter *) const
 Save name and creation time to XML. More...
 
void writeCommentElement (QXmlStreamWriter *) const
 Save the comment to XML. More...
 
bool readCommentElement (XmlStreamReader *)
 Load comment from an XML element. More...
 
- Protected Attributes inherited from Spreadsheet
SpreadsheetViewm_view {nullptr}
 
- Protected Attributes inherited from AbstractPart
QWidget * m_partView {nullptr}
 
- Protected Attributes inherited from AbstractAspect
const AspectType m_type
 

Detailed Description

Represents a topic of a subscription made in MQTTClient.

File : MQTTTopic.cpp Project : LabPlot

Description : Represents a topic of a MQTTSubscription

Copyright : (C) 2018 Kovacs Ferencz (kferi.nosp@m.ke98.nosp@m.@gmai.nosp@m.l.co.nosp@m.m)

  • This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. *
  • This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. *
  • You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, * Boston, MA 02110-1301 USA *

Definition at line 39 of file MQTTTopic.h.

Constructor & Destructor Documentation

◆ MQTTTopic()

◆ ~MQTTTopic()

MQTTTopic::~MQTTTopic ( )
override

Definition at line 87 of file MQTTTopic.cpp.

References m_filter, and m_topicName.

Member Function Documentation

◆ createContextMenu()

QMenu * MQTTTopic::createContextMenu ( )
overridevirtual

Adds an action to the MQTTTopic's context menu in the project explorer.

Reimplemented from AbstractPart.

Definition at line 120 of file MQTTTopic.cpp.

References AbstractPart::createContextMenu(), and m_plotDataAction.

◆ filter()

AsciiFilter * MQTTTopic::filter ( ) const

Returns the MQTTTopic's filter.

Definition at line 106 of file MQTTTopic.cpp.

References m_filter.

◆ icon()

QIcon MQTTTopic::icon ( ) const
overridevirtual

Returns the MQTTTopic's icon.

Reimplemented from AbstractAspect.

Definition at line 113 of file MQTTTopic.cpp.

◆ initActions()

void MQTTTopic::initActions ( )
private

Initializes the actions of MQTTTopic.

Definition at line 159 of file MQTTTopic.cpp.

References i18n, m_plotDataAction, and plotData().

Referenced by MQTTTopic().

◆ load()

◆ mqttClient()

MQTTClient * MQTTTopic::mqttClient ( ) const

Returns the MQTTClient the topic belongs to.

Definition at line 167 of file MQTTTopic.cpp.

References m_MQTTClient.

Referenced by GuiObserver::selectedAspectsChanged(), and MQTTClient::statistics().

◆ newMessage()

void MQTTTopic::newMessage ( const QString &  message)

Adds a message received by the topic to the message puffer.

Definition at line 145 of file MQTTTopic.cpp.

References m_messagePuffer.

◆ plotData

void MQTTTopic::plotData ( )
privateslot

Plots the data stored in MQTTTopic.

Definition at line 178 of file MQTTTopic.cpp.

Referenced by initActions().

◆ read

void MQTTTopic::read ( )
slot

Reads every message from the message puffer.

Definition at line 186 of file MQTTTopic.cpp.

References m_filter, m_messagePuffer, and m_topicName.

Referenced by MQTTTopic().

◆ readOccured

void MQTTTopic::readOccured ( )
signal

◆ save()

void MQTTTopic::save ( QXmlStreamWriter *  writer) const
overridevirtual

◆ setFilter()

void MQTTTopic::setFilter ( AsciiFilter f)

Sets the MQTTTopic's filter The ownership of the filter is passed to MQTTTopic.

Parameters
filter

Definition at line 98 of file MQTTTopic.cpp.

References m_filter.

◆ topicName()

QString MQTTTopic::topicName ( ) const

Returns the name of the MQTTTopic.

Definition at line 152 of file MQTTTopic.cpp.

References m_topicName.

◆ view()

QWidget * MQTTTopic::view ( ) const
overridevirtual

Construct a primary view on me.

The caller receives ownership of the view.

This method may be called multiple times during the life time of a Part, or it might not get called at all. Parts must not depend on the existence of a view for their operation.

Implements AbstractPart.

Definition at line 136 of file MQTTTopic.cpp.

References AbstractPart::m_partView.

Member Data Documentation

◆ m_filter

AsciiFilter* MQTTTopic::m_filter
private

Definition at line 65 of file MQTTTopic.h.

Referenced by filter(), load(), MQTTTopic(), read(), save(), setFilter(), and ~MQTTTopic().

◆ m_messagePuffer

QVector<QString> MQTTTopic::m_messagePuffer
private

Definition at line 66 of file MQTTTopic.h.

Referenced by load(), newMessage(), read(), and save().

◆ m_MQTTClient

MQTTClient* MQTTTopic::m_MQTTClient
private

Definition at line 64 of file MQTTTopic.h.

Referenced by mqttClient(), and MQTTTopic().

◆ m_plotDataAction

QAction* MQTTTopic::m_plotDataAction
private

Definition at line 67 of file MQTTTopic.h.

Referenced by createContextMenu(), and initActions().

◆ m_topicName

QString MQTTTopic::m_topicName
private

Definition at line 63 of file MQTTTopic.h.

Referenced by load(), MQTTTopic(), read(), save(), topicName(), and ~MQTTTopic().


The documentation for this class was generated from the following files: