Named, parameterised command exchanged with mne_rt_server; supports both JSON and CLI serialisation. More...

#include <command.h>

Public Types
typedef QSharedPointer< Command >	SPtr
typedef QSharedPointer< const Command >	ConstSPtr
Public Types inherited from UTILSLIB::ICommand
typedef QSharedPointer< ICommand >	SPtr
typedef QSharedPointer< const ICommand >	ConstSPtr

Signals
void	executed (Command p_command)

Public Member Functions
	Command (bool p_bIsJson=true, QObject *parent=0)
	Command (const QString &p_sCommand, const QJsonObject &p_qCommandContent, bool p_bIsJson=true, QObject *parent=0)
	Command (const QString &p_sCommand, const QString &p_sDescription, bool p_bIsJson=true, QObject *parent=0)
	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)
	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 ()
QString	command () const
quint32	count () const
QString	description () const
virtual void	execute ()
bool &	isJson ()
QList< QString >	pDescriptions () const
QList< QString >	pNames () const
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
Public Member Functions inherited from UTILSLIB::ICommand
virtual	~ICommand ()

Public Attributes
QString	m_sCommand
QString	m_sDescription
QStringList	m_qListParamNames
QList< QVariant >	m_qListParamValues
QStringList	m_qListParamDescriptions
bool	m_bIsJson

Detailed Description

Named, parameterised command exchanged with mne_rt_server; supports both JSON and CLI serialisation.

Holds the command keyword, description, parallel lists of parameter names / values / descriptions, and a JSON-vs-CLI flag. Constructible either from a parsed QJsonObject (when echoing the server’s advertised command list) or from explicit string/value lists (when authoring a request). Implements UTILSLIB::ICommand so it can be dispatched through CommandManager and surfaces parameter access by both name (operator[](QString)) and index (operator[](qint32)).

Definition at line 86 of file command.h.

Inheritance diagram for COMLIB::Command:

Member Typedef Documentation

◆ ConstSPtr

typedef QSharedPointer<const Command> COMLIB::Command::ConstSPtr

Definition at line 92 of file command.h.

◆ SPtr

typedef QSharedPointer<Command> COMLIB::Command::SPtr

Definition at line 91 of file command.h.

Constructor & Destructor Documentation

◆ Command() [1/6]

Command::Command	(	bool	p_bIsJson = true,
		QObject *	parent = 0 )

explicit

Constructs a Command

Parameters

[in]	p_bIsJson	If is received/should be send as JSON (optional, default true).
[in]	parent	Parent QObject (optional).

Definition at line 47 of file command.cpp.

◆ Command() [2/6]

Command::Command	(	const QString &	p_sCommand,
		const QJsonObject &	p_qCommandContent,
		bool	p_bIsJson = true,
		QObject *	parent = 0 )

explicit

Constructor which parses a command stored in a json object

Parameters

[in]	p_sCommand	Command.
[in]	p_qCommandContent	Content encapsulated in a JsonObject.
[in]	p_bIsJson	If is received/should be send as JSON (optional, default true).
[in]	parent	Parent QObject (optional).

Definition at line 57 of file command.cpp.

◆ Command() [3/6]

Command::Command	(	const QString &	p_sCommand,
		const QString &	p_sDescription,
		bool	p_bIsJson = true,
		QObject *	parent = 0 )

explicit

Constructs a command without parameters

Parameters

[in]	p_sCommand	Command.
[in]	p_sDescription	Command description.
[in]	p_bIsJson	If is received/should be send as JSON (optional, default true).
[in]	parent	Parent QObject (optional).

Definition at line 81 of file command.cpp.

◆ Command() [4/6]

Command::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

Constructor which assembles a command from single parts

Parameters

[in]	p_sCommand	Command.
[in]	p_sDescription	Command description.
[in]	p_qListParamNames	Parameter names.
[in]	p_qListParamValues	Parameter values/types.
[in]	p_bIsJson	If is received/should be send as JSON (optional, default true).
[in]	parent	Parent QObject (optional).

Definition at line 91 of file command.cpp.

◆ Command() [5/6]

Command::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 )

explicit

Constructor which assembles a command from single parts

Parameters

[in]	p_sCommand	Command.
[in]	p_sDescription	Command description.
[in]	p_qListParamNames	Parameter names.
[in]	p_qListParamValues	Parameter values/types.
[in]	p_vecParameterDescriptions	Parameter descriptions;.

Definition at line 107 of file command.cpp.

◆ Command() [6/6]

Command::Command ( const Command & p_Command )

Copy constructor.

Parameters

[in] p_Command Command to be copied.

Definition at line 132 of file command.cpp.

◆ ~Command()

Command::~Command ( )

virtual

Destroys the command

Definition at line 145 of file command.cpp.

Member Function Documentation

◆ command()

QString COMLIB::Command::command ( ) const

inline

Short command for this request

Returns: Short command representation.

Definition at line 328 of file command.h.

◆ count()

quint32 COMLIB::Command::count ( ) const

inline

Returns the number of parameters.

Returns: number of parameters.

Definition at line 335 of file command.h.

◆ description()

QString COMLIB::Command::description ( ) const

inline

Gets the help text or description of this command.

Returns: Help text.

Definition at line 342 of file command.h.

◆ execute()

void Command::execute ( )

virtual

Inherited by ICommand

Returns: emits received.

Implements UTILSLIB::ICommand.

Definition at line 151 of file command.cpp.

◆ executed

void COMLIB::Command::executed ( Command p_command )

signal

Signal which is emitted when command patterns execute method is processed.

Parameters

[in] p_command the executed command.

◆ isJson()

bool & COMLIB::Command::isJson ( )

inline

If received command was Json fomratted or triggered command should be Json formatted.

Returns: Json formatted.

Definition at line 349 of file command.h.

◆ operator=()

Command & Command::operator= ( const Command & rhs )

Assignment Operator

Parameters

[in] rhs Command which should be assigned.

Definition at line 243 of file command.cpp.

◆ operator[]() [1/3]

QVariant & Command::operator[] ( const QString & key )

Subscript operator [] to access parameter values by name

Parameters

[in] key the parameter name.

Returns: Parameter value related to the parameter name.

Definition at line 259 of file command.cpp.

◆ operator[]() [2/3]

const QVariant Command::operator[] ( const QString & key ) const

Subscript operator []

Parameters

[in] key the parameter name.

Returns: Parameter value related to the parameter name.

Definition at line 279 of file command.cpp.

◆ operator[]() [3/3]

QVariant & Command::operator[] ( qint32 idx )

Subscript operator [] to access parameter values by index

Parameters

[in] idx the parameter index.

Returns: Parameter value related to the parameter index.

Definition at line 269 of file command.cpp.

◆ pDescriptions()

QList< QString > COMLIB::Command::pDescriptions ( ) const

inline

Get parameter descriptions

Returns: parameter descriptions.

Definition at line 356 of file command.h.

◆ pNames()

QList< QString > COMLIB::Command::pNames ( ) const

inline

Get parameter names

Returns: parameter names.

Definition at line 363 of file command.h.

◆ pValues()

QList< QVariant > & COMLIB::Command::pValues ( )

inline

Returns parameter values

Returns: parameter values.

Definition at line 370 of file command.h.

◆ reply()

void Command::reply ( const QString & p_sReply )

Inherited command reply channel.

Parameters

[in] p_sReply command reply.

Definition at line 158 of file command.cpp.

◆ send()

void Command::send ( )

Sender slot which emmits triggered signal

Definition at line 169 of file command.cpp.

◆ toJsonObject()

QJsonObject Command::toJsonObject ( ) const

Creates a JSON Command Object

Returns: Command converted to a JSON Object.

Definition at line 180 of file command.cpp.

◆ toStringList()

QStringList Command::toStringList ( ) const

Creates a StringList with three items. First item is the command, second the parameter list and thrid the description.

Returns: Command as a StringList.

Definition at line 200 of file command.cpp.

◆ toStringReadySend()

QString Command::toStringReadySend ( ) const

Creates a string JSON formatted ready send command.

Returns: Command as a JSON formatted string which contains parameter values too.

Definition at line 222 of file command.cpp.

Member Data Documentation

◆ m_bIsJson

bool COMLIB::Command::m_bIsJson

True when the command was parsed from JSON.

Definition at line 321 of file command.h.

◆ m_qListParamDescriptions

QStringList COMLIB::Command::m_qListParamDescriptions

Per-parameter description strings.

Definition at line 320 of file command.h.

◆ m_qListParamNames

QStringList COMLIB::Command::m_qListParamNames

Parameter names (positional order).

Definition at line 318 of file command.h.

◆ m_qListParamValues

QList<QVariant> COMLIB::Command::m_qListParamValues

Current parameter values (same order as names).

Definition at line 319 of file command.h.

◆ m_sCommand

QString COMLIB::Command::m_sCommand

The command keyword.

Definition at line 316 of file command.h.

◆ m_sDescription

QString COMLIB::Command::m_sDescription

Human-readable description of the command.

Definition at line 317 of file command.h.

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

src/libraries/com/rt_command/command.h
src/libraries/com/rt_command/command.cpp

Public Types

Signals

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ ConstSPtr

◆ SPtr

Constructor & Destructor Documentation

◆ Command() [1/6]

◆ Command() [2/6]

◆ Command() [3/6]

◆ Command() [4/6]

◆ Command() [5/6]

◆ Command() [6/6]

◆ ~Command()

Member Function Documentation

◆ command()

◆ count()

◆ description()

◆ execute()

◆ executed

◆ isJson()

◆ operator=()

◆ operator[]() [1/3]

◆ operator[]() [2/3]

◆ operator[]() [3/3]

◆ pDescriptions()

◆ pNames()

◆ pValues()

◆ reply()

◆ send()

◆ toJsonObject()

◆ toStringList()

◆ toStringReadySend()

Member Data Documentation

◆ m_bIsJson

◆ m_qListParamDescriptions

◆ m_qListParamNames

◆ m_qListParamValues

◆ m_sCommand

◆ m_sDescription