OpenHantek
Public Member Functions
ExporterPrint Class Reference
Inheritance diagram for ExporterPrint:
ExporterInterface

Public Member Functions

virtual void create (ExporterRegistry *registry) override
 
virtual QIcon icon () override
 
virtual QString name () override
 
virtual Type type () override
 
virtual bool samples (const std::shared_ptr< PPresult >data) override
 
virtual bool save () override
 
virtual float progress () override
 The progress of receiving and processing samples. If the exporter returns 1, it will be called back by the GUI via the save() method. More...
 

Additional Inherited Members

- Public Types inherited from ExporterInterface
enum  Type { SnapshotExport, ContinousExport }
 
- Protected Attributes inherited from ExporterInterface
ExporterRegistryregistry
 

Member Function Documentation

◆ create()

void ExporterPrint::create ( ExporterRegistry registry)
overridevirtual

Starts up this exporter. Aquires resources etc. Do not call this directly, it will be called by the exporter registry at some point. Release your resources in the destructor as usual.

Parameters
registryThe exporter registry instance. This is used to obtain a reference to the settings.

Implements ExporterInterface.

◆ icon()

QIcon ExporterPrint::icon ( )
overridevirtual
Returns
Return the icon representation of this exporter. Will be used in graphical interfaces.

Implements ExporterInterface.

◆ name()

QString ExporterPrint::name ( )
overridevirtual
Returns
Return the text representation / name of this exporter. Will be used in graphical interfaces.

Implements ExporterInterface.

◆ progress()

float ExporterPrint::progress ( )
overridevirtual

The progress of receiving and processing samples. If the exporter returns 1, it will be called back by the GUI via the save() method.

Returns
A number between 0..1 indicating the used capacity of this exporter. If this is a snapshot exporter, only 0 for "no samples processed yet" or 1 for "finished" will be returned. A continous exporter may report the used memory / reservered memory ratio here.

Implements ExporterInterface.

◆ samples()

bool ExporterPrint::samples ( const std::shared_ptr< PPresult )
overridevirtual

A new sample set from the ExporterRegistry. The exporter needs to be active to receive samples. If it is a snapshot exporter, only one set of samples will be received.

Returns
Return true if you want to receive another sample or false if you are done (progres()==1).

Implements ExporterInterface.

◆ save()

bool ExporterPrint::save ( )
overridevirtual

Exporter: Save your received data and perform any conversions necessary. This method will be called in the GUI thread context and can create and show dialogs if required.

Returns
Return true if saving succedded otherwise false.

Implements ExporterInterface.

◆ type()

ExporterInterface::Type ExporterPrint::type ( )
overridevirtual
Returns
Return the type of this exporter.
See also
ExporterInterface::Type

Implements ExporterInterface.


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