command.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef COMMAND_H
#define COMMAND_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "../communication_global.h"
 
#include <utils/generics/commandpattern.h>
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QObject>
#include <QList>
#include <QString>
#include <QVariant>
#include <QJsonObject>
#include <QSharedPointer>
#include <QDebug>
#include <QPair>
#include <QStringList>
 
//=============================================================================================================
// DEFINE NAMESPACE COMMUNICATIONLIB
//=============================================================================================================
 
namespace COMMUNICATIONLIB
{
 
static QVariant defaultVariant;
 
//=============================================================================================================
class COMMUNICATIONSHARED_EXPORT Command: public QObject, public UTILSLIB::ICommand
{
Q_OBJECT
 
public:
    typedef QSharedPointer<Command> SPtr;
    typedef QSharedPointer<const Command> ConstSPtr;
 
    //=========================================================================================================
    explicit Command(bool p_bIsJson = true, QObject *parent = 0);
 
    //=========================================================================================================
    explicit Command(const QString &p_sCommand, const QJsonObject &p_qCommandContent, bool p_bIsJson = true, QObject *parent = 0);
 
    //=========================================================================================================
    explicit Command(const QString &p_sCommand, const QString &p_sDescription, bool p_bIsJson = true, QObject *parent = 0);
 
    //=========================================================================================================
    explicit Command(const QString &p_sCommand, const QString &p_sDescription,
                     const QStringList &p_qListParamNames, const QList<QVariant> &p_qListParamValues, bool p_bIsJson = true, QObject *parent = 0);
 
    //=========================================================================================================
    explicit Command(const QString &p_sCommand, const QString &p_sDescription,
                     const QStringList &p_qListParamNames, const QList<QVariant> &p_qListParamValues, const QStringList &p_vecParameterDescriptions, bool p_bIsJson = true, QObject *parent = 0);
 
    //=========================================================================================================
    Command(const Command &p_Command);
 
    //=========================================================================================================
    virtual ~Command();
 
    //=========================================================================================================
    inline QString command() const;
 
    //=========================================================================================================
    inline quint32 count() const;
 
    //=========================================================================================================
    inline QString description() const;
 
    //=========================================================================================================
    virtual void execute();
 
    //=========================================================================================================
    inline bool& isJson();
 
    //=========================================================================================================
    inline QList<QString> pDescriptions() const;
 
    //=========================================================================================================
    inline QList<QString> pNames() const;
 
    //=========================================================================================================
    inline QList<QVariant>& pValues();
 
    //=========================================================================================================
    void reply(const QString &p_sReply);
 
    //=========================================================================================================
    void send();
 
    //=========================================================================================================
    QJsonObject toJsonObject() const;
 
    //=========================================================================================================
    QStringList toStringList() const;
 
    //=========================================================================================================
    QString toStringReadySend() const;
 
    //=========================================================================================================
    Command& operator= (const Command &rhs);
 
    //=========================================================================================================
    QVariant& operator[] (const QString &key);
 
    //=========================================================================================================
    QVariant& operator[] (qint32 idx);
 
    //=========================================================================================================
    const QVariant operator[] (const QString &key) const;
 
signals:
    //=========================================================================================================
    void executed(Command p_command);
 
public:
    QString             m_sCommand;
    QString             m_sDescription;
    QStringList         m_qListParamNames;
    QList<QVariant>     m_qListParamValues;
    QStringList         m_qListParamDescriptions;
    bool                m_bIsJson;
};
 
//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
 
inline QString Command::command() const
{
    return m_sCommand;
}
 
//=============================================================================================================
 
inline quint32 Command::count() const
{
    return m_qListParamValues.size();
}
 
//=============================================================================================================
 
inline QString Command::description() const
{
    return m_sDescription;
}
 
//=============================================================================================================
 
inline bool& Command::isJson()
{
    return m_bIsJson;
}
 
//=============================================================================================================
 
inline QList<QString> Command::pDescriptions() const
{
    return m_qListParamDescriptions;
}
 
//=============================================================================================================
 
inline QList<QString> Command::pNames() const
{
    return m_qListParamNames;
}
 
//=============================================================================================================
 
inline QList<QVariant>& Command::pValues()
{
    return m_qListParamValues;
}
} // NAMESPACE
 
#endif // COMMAND_H