Heart 1.3.842.34c2ab5
Heart is base back end library for your c++ Qt projects.
QH::PKG::BigDataHeader Class Reference

The BigDataHeader class is first empty pacakge with information of big data package. More...

#include <bigdataheader.h>

Inheritance diagram for QH::PKG::BigDataHeader:
Inheritance graph
Collaboration diagram for QH::PKG::BigDataHeader:
Collaboration graph

Public Member Functions

 BigDataHeader ()
 
bool isValid () const override
 isValid This method check current object to valid.
 
QString toString () const override
 
int getPackagesCount () const
 getPackagesCount This method return count of parts of bigdata package.
 
void setPackagesCount (int newPackagesCount)
 setPackagesCount This method sets new count of pcakges.
 
unsigned short getCommand () const
 getCommand This method return commnad of moving package.
 
void setCommand (unsigned short newCommand)
 setCommand This method sets new value for package command that will moved
 
- Public Member Functions inherited from QH::PKG::BigDataBase
 BigDataBase ()
 
int packageId () const
 getPackageId This method return package id that this part moving.
 
void setPackageId (int newPackageId)
 setPackageId This method sets new id of package that this package moving
 
QString toString () const override
 
- 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 BigDataHeader class is first empty pacakge with information of big data package.

Transfer algorithm

  1. The big data pacakge converted to bytearray.
  2. Prepare The BigDataHeader pacakge with unique id and count of the parts
  3. Part data pacakages.

Definition at line 28 of file bigdataheader.h.

Constructor & Destructor Documentation

◆ BigDataHeader()

QH::PKG::BigDataHeader::BigDataHeader ( )

Definition at line 13 of file bigdataheader.cpp.

Member Function Documentation

◆ fromStream()

QDataStream & QH::PKG::BigDataHeader::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
streamThis is Qt stream object.
Returns
Qt stream object.

Examle of base simple implementation:

QDataStream &ExampleClass::fromStream(QDataStream &stream) const {
stream >> exampleMember;
return stream;
}
virtual QDataStream & toStream(QDataStream &stream) const =0
fromStream This method should be write all members of the current object to the stream object.

Reimplemented from QH::PKG::BigDataBase.

Definition at line 37 of file bigdataheader.cpp.

Here is the call graph for this function:

◆ getCommand()

unsigned short QH::PKG::BigDataHeader::getCommand ( ) const

getCommand This method return commnad of moving package.

Returns
commnad of moving package.

Definition at line 55 of file bigdataheader.cpp.

◆ getPackagesCount()

int QH::PKG::BigDataHeader::getPackagesCount ( ) const

getPackagesCount This method return count of parts of bigdata package.

Returns
count of parts of bigdata package.

Definition at line 29 of file bigdataheader.cpp.

◆ isValid()

bool QH::PKG::BigDataHeader::isValid ( ) const
overridevirtual

isValid This method check current object to valid.

Returns
True if class isValid.

Reimplemented from QH::PKG::BigDataBase.

Definition at line 17 of file bigdataheader.cpp.

Here is the call graph for this function:

◆ setCommand()

void QH::PKG::BigDataHeader::setCommand ( unsigned short  newCommand)

setCommand This method sets new value for package command that will moved

Parameters
newCommandnew value for package command that will moved

Definition at line 59 of file bigdataheader.cpp.

◆ setPackagesCount()

void QH::PKG::BigDataHeader::setPackagesCount ( int  newPackagesCount)

setPackagesCount This method sets new count of pcakges.

Parameters
newPackagesCountThis is new value of the parts count.

Definition at line 33 of file bigdataheader.cpp.

◆ toStream()

QDataStream & QH::PKG::BigDataHeader::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
streamThis is Qt stream object.
Returns
Qt stream object.

Examle of base simple implementation:

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

Reimplemented from QH::PKG::BigDataBase.

Definition at line 46 of file bigdataheader.cpp.

Here is the call graph for this function:

◆ toString()

QString QH::PKG::BigDataHeader::toString ( ) const
override

Definition at line 21 of file bigdataheader.cpp.

Here is the call graph for this function:

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