Allows support to be added for custom reporters. More...

#include <Workspace/Provenance/provenancereporter.h>

Inheritance diagram for ProvenanceReporter::Reporter:

Classes
struct	ReportConfig

Public Member Functions
	Reporter ()=default

	~Reporter () override=default

Reporter *	clone () const override=0

virtual QString	generateAndSubmitReport (const ReportConfig &config)=0

virtual QString	getName () const =0

Public Member Functions inherited from Clonable
virtual	~Clonable ()=default

virtual Clonable *	clone () const =0

Protected Member Functions
	Reporter (const Reporter &other)

Reporter &	operator= (const Reporter &other)

Detailed Description

Developers can create an Operation that outputs a Reporter object. This object can then be connected to the GenerateProvenanceReport operation in their workflow to allow reporting to a custom provenance system.

Constructor & Destructor Documentation

◆ Reporter() [1/2]

Reporter ( const Reporter & other )

protected

◆ Reporter() [2/2]

Reporter ( )

default

◆ ~Reporter()

~Reporter ( )

overridedefault

Member Function Documentation

◆ clone()

Reporter * clone ( ) const

overridepure virtual

Returns: A clone of this object.

Note: Subclasses would normally return their own type rather than the Clonable type. The C++ language rules allow a more derived type to be returned from a virtual function and the compiler will still treat it as a valid override.

Implements Clonable.

◆ generateAndSubmitReport()

virtual QString generateAndSubmitReport ( const ReportConfig & config )

pure virtual

Returns: A string indicating the location of the successfully generate report or empty string if the report failed.

◆ getName()

virtual QString getName ( ) const