The Feature class it is atomic type for describe service command. More...

#include <PFeature.h>

Collaboration diagram for Patronum::Feature:

Public Member Functions
	Feature ()=default

	Feature (const QString &cmd, const QString &arg={}, const QString &description="", const QString &example="")

QString	cmd () const
	cmd This method return command of the feature.

void	setCmd (const QString &cmd)
	setCmd This method set new value of the command.

QString	arg () const
	arg This method return argument value. The argument value has a qvariant type, so this object maybe have a list or array type.

void	setArg (const QString &arg)

QString	description () const
	description This method return description message of the command. This string display in a terminal application in the help section.

void	setDescription (const QString &description)
	setDescription This method sets description for command.

QString	example () const
	example This is exmaple of using this command.

void	setExample (const QString &example)
	setExample This method sets a new example.

QString	toString () const
	toString This is general method of the converting command to string.

unsigned int	id () const
	id This method retun id of the feature. The id is qHash from command string.

Friends
PATRONUM_LIBRARYSHARED_EXPORT friend QDataStream &	operator<< (QDataStream &stream, const Feature &obj)

PATRONUM_LIBRARYSHARED_EXPORT friend QDataStream &	operator>> (QDataStream &stream, Feature &obj)

PATRONUM_LIBRARYSHARED_EXPORT friend bool	operator== (const Feature &left, const Feature &right)

Detailed Description

The Feature class it is atomic type for describe service command.

Definition at line 21 of file PFeature.h.

Constructor & Destructor Documentation

◆ Feature() [1/2]

Patronum::Feature::Feature ( )

explicitdefault

◆ Feature() [2/2]

Patronum::Feature::Feature	(	const QString &	cmd,
		const QString &	arg = `{}`,
		const QString &	description = `""`,
		const QString &	example = `""`
	)

explicit

Definition at line 14 of file PFeature.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ arg()

QString Patronum::Feature::arg ( ) const

arg This method return argument value. The argument value has a qvariant type, so this object maybe have a list or array type.

Returns: Argument value.

Definition at line 31 of file PFeature.cpp.

Here is the caller graph for this function:

◆ cmd()

QString Patronum::Feature::cmd ( ) const

cmd This method return command of the feature.

Returns: Command of the feature.

Definition at line 22 of file PFeature.cpp.

Here is the caller graph for this function:

◆ description()

QString Patronum::Feature::description ( ) const

description This method return description message of the command. This string display in a terminal application in the help section.

Returns: Description message of the command.

Definition at line 39 of file PFeature.cpp.

Here is the caller graph for this function:

◆ example()

QString Patronum::Feature::example ( ) const

example This is exmaple of using this command.

Returns: Example of use.

Definition at line 47 of file PFeature.cpp.

Here is the caller graph for this function:

◆ id()

unsigned int Patronum::Feature::id ( ) const

id This method retun id of the feature. The id is qHash from command string.

Returns: id of the feature.

Definition at line 62 of file PFeature.cpp.

Here is the caller graph for this function:

◆ setArg()

void Patronum::Feature::setArg ( const QString & arg )

Definition at line 35 of file PFeature.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCmd()

void Patronum::Feature::setCmd ( const QString & cmd )

setCmd This method set new value of the command.

Parameters

cmd

Definition at line 26 of file PFeature.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDescription()

void Patronum::Feature::setDescription ( const QString & description )

setDescription This method sets description for command.

Parameters

description This is new value of the description command.

Definition at line 43 of file PFeature.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setExample()

void Patronum::Feature::setExample ( const QString & example )

setExample This method sets a new example.

Parameters

example This is a new example value.

Definition at line 51 of file PFeature.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toString()

QString Patronum::Feature::toString ( ) const

toString This is general method of the converting command to string.

Returns: String of all command.

Definition at line 55 of file PFeature.cpp.

Friends And Related Symbol Documentation

◆ operator<<

PATRONUM_LIBRARYSHARED_EXPORT friend QDataStream & operator<<	(	QDataStream &	stream,
		const Feature &	obj
	)

friend

Definition at line 66 of file PFeature.cpp.

◆ operator==

PATRONUM_LIBRARYSHARED_EXPORT friend bool operator==	(	const Feature &	left,
		const Feature &	right
	)

friend

Definition at line 80 of file PFeature.cpp.

◆ operator>>

PATRONUM_LIBRARYSHARED_EXPORT friend QDataStream & operator>>	(	QDataStream &	stream,
		Feature &	obj
	)

friend

Definition at line 72 of file PFeature.cpp.

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

Patronum/src/PFeature.h
Patronum/src/PFeature.cpp

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Feature() [1/2]

◆ Feature() [2/2]

Member Function Documentation

◆ arg()

◆ cmd()

◆ description()

◆ example()

◆ id()

◆ setArg()

◆ setCmd()

◆ setDescription()

◆ setExample()

◆ toString()

Friends And Related Symbol Documentation

◆ operator<<

◆ operator==

◆ operator>>