ExporterImage Class Reference

#include <exportimage.h>

Inheritance diagram for ExporterImage:

Public Member Functions
	ExporterImage ()
void	create (ExporterRegistry *newRegistry) override
int	faIcon () override
QString	name () override
Type	type () override
bool	samples (const std::shared_ptr< PPresult >newData) override
bool	save () override
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...

Private Attributes
std::shared_ptr< PPresult >	data

Additional Inherited Members
Public Types inherited from ExporterInterface
enum	Type { Type::SnapshotExport, Type::ContinousExport }
Protected Attributes inherited from ExporterInterface
ExporterRegistry *	registry

Constructor & Destructor Documentation

ExporterImage()

ExporterImage::ExporterImage

(

)

Member Function Documentation

create()

void ExporterImage::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

registry

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

Implements ExporterInterface.

faIcon()

int ExporterImage::faIcon ( )

overridevirtual

Returns

Return the icon representation of this exporter. Will be used in graphical interfaces.

Implements ExporterInterface.

name()

QString ExporterImage::name ( )

overridevirtual

Returns

Return the text representation / name of this exporter. Will be used in graphical interfaces.

Implements ExporterInterface.

progress()

float ExporterImage::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 ExporterImage::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 ExporterImage::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 ExporterImage::type ( )

overridevirtual

Returns

Return the type of this exporter.

See also

ExporterInterface::Type

Implements ExporterInterface.

Field Documentation

data

std::shared_ptr<PPresult> ExporterImage::data

private

---

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

• exporting/exportimage.h
• exporting/exportimage.cpp