QH::PKG::Ping Class Reference

The Ping class - test class for translate data on network. More...

#include <ping.h>

Inheritance diagram for QH::PKG::Ping:

Collaboration diagram for QH::PKG::Ping:

Public Member Functions
	Ping ()
	Ping (const Package &from)
bool	isValid () const override
	isValid - Check this package if valid.
bool	ansver () const
	answer This is bool value for check this object that it is answer or request. Using on tests.
void	setAnsver (bool ansver)
	setAnsver - Set the answer option.
Public Member Functions inherited from QH::PKG::AbstractData
	~AbstractData () override
virtual unsigned short	cmd () const =0
	cmd - This is command of this object, (for generate cmd use macross QH_PACKAGE)
virtual QString	cmdString () const =0
	cmdString - This is command string of this object, (for generate cmd use macross QH_PACKAGE)
virtual bool	toPackage (Package &package, const DistVersion &reqVersion, unsigned int triggerHash=0) const
	toPackage This method convert this class object to the package. For more info see Package class.
QString	toString () const override
	toString - Return a string implementation for this object.
template<class C , class... Args>
C *	create (Args &&... args) const
	create - This is factory method for create a new object.
void	fromPakcage (const Package &pkg)
	fromPakcage - This method initialize the current object from a package class object.
Public Member Functions inherited from QH::StreamBase
	StreamBase ()
virtual	~StreamBase ()
bool	fromBytes (const QByteArray &data)
	fromBytes This method provide initialization of object from byte array.
QByteArray	toBytes () const
	toBytes This method convert a current object to bytes array.
bool	fromBase64 (const QString &data)
	fromBase64 This method provide initialization of object from the base64 string.
bool	fromBase64 (const QByteArray &data)
	fromBase64 This method provide initialization of object from the base64 string.
QByteArray	toBase64 () const
	toBase64 This method convert a current object to the base64 string.
template<class T >
T &	copy (const StreamBase &right)
	copy This is base copy method for all StreamBase structures. Default implementation it is copy from byteArray.
template<class T >
bool	compare (const T &right)
	compare This method compare array signatures of this and right objects.

Protected Member Functions
QDataStream &	fromStream (QDataStream &stream) override
	fromStream This method should be read all bytes from the stream object and full the current object.
QDataStream &	toStream (QDataStream &stream) const override
	fromStream This method should be write all members of the current object to the stream object.
Protected Member Functions inherited from QH::PKG::AbstractData
	AbstractData ()
	AbstractData - Base constructor of this object.
Protected Member Functions inherited from QH::StreamBase
virtual int	parsingVersion () const
	parsingVersion this method return parsing version of Qt. By Default is 0 (last available parsing). see https://doc.qt.io/qt-6/qdatastream.html#Version-enum
virtual unsigned int	typeId () const
	typeId This method return id of type.

Additional Inherited Members
Static Public Member Functions inherited from QH::PKG::AbstractData
static unsigned int	command ()
	command This static method that return glaball code of this object.
static QString	commandText ()
	commandText This method return text of package command

Detailed Description

The Ping class - test class for translate data on network.

Definition at line 21 of file ping.h.

Constructor & Destructor Documentation

Ping() [1/2]

QH::PKG::Ping::Ping

(

)

Definition at line 15 of file ping.cpp.

Ping() [2/2]

QH::PKG::Ping::Ping

(

const Package &

from

)

Definition at line 19 of file ping.cpp.

Here is the call graph for this function:

Member Function Documentation

ansver()

bool QH::PKG::Ping::ansver

(

)

const

answer This is bool value for check this object that it is answer or request. Using on tests.

Returns

True if this object is answer from server.

Definition at line 27 of file ping.cpp.

Here is the caller graph for this function:

fromStream()

QDataStream & QH::PKG::Ping::fromStream ( QDataStream &  stream )

overrideprotectedvirtual

fromStream This method should be read all bytes from the stream object and full the current object.

Note

The implementation of this method should be invoke a method of base class.

Parameters

stream

This is Qt stream object.

Returns

Qt stream object.

Examle of base simple implementation:

QDataStream &ExampleClass::fromStream(QDataStream &stream) const {
    StreamBase::toStream(stream);
    stream >> exampleMember;
    return stream;
}

Implements QH::StreamBase.

Definition at line 35 of file ping.cpp.

isValid()

bool QH::PKG::Ping::isValid ( ) const

overridevirtual

isValid - Check this package if valid.

Returns

True if package is valid.

Reimplemented from QH::PKG::AbstractData.

Definition at line 23 of file ping.cpp.

Here is the call graph for this function:

setAnsver()

void QH::PKG::Ping::setAnsver

(

bool

ansver

)

setAnsver - Set the answer option.

Parameters

ansver

- New answer value.

Definition at line 31 of file ping.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

toStream()

QDataStream & QH::PKG::Ping::toStream ( QDataStream &  stream ) const

overrideprotectedvirtual

fromStream This method should be write all members of the current object to the stream object.

Note

The implementation of this method should be invoke a method of base class.

Parameters

stream

This is Qt stream object.

Returns

Qt stream object.

Examle of base simple implementation:

QDataStream &ExampleClass::toStream(QDataStream &stream) const {
    StreamBase::toStream(stream);
    stream << exampleMember;
    return stream;
}

Implements QH::StreamBase.

Definition at line 42 of file ping.cpp.

---

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

• src/public/packages/ping.h
• src/public/packages/ping.cpp