ExporterResource Class Reference

This is a helper class when using the Exporter interface. More...

#include <PlugInResource.h>

Inheritance diagram for ExporterResource:

List of all members.

Public Member Functions
	ExporterResource (Progress *pProgress=NULL, bool batch=true)
	ExporterResource (std::string exporterName, Progress *pProgress=NULL, bool batch=true)
	ExporterResource (PlugIn *pPlugIn, Progress *pProgress=NULL, bool batch=true)
	ExporterResource (std::string exporterName, SessionItem *pItem, FileDescriptor *pFileDescriptor, Progress *pProgress=NULL, bool batch=true)
	ExporterResource (PlugIn *pPlugIn, SessionItem *pItem, FileDescriptor *pFileDescriptor, Progress *pProgress=NULL, bool batch=true)

---

Detailed Description

This is a helper class when using the Exporter interface.

This class manages an instance of an ExportAgent that provides the actual helper methods when working with instances of Exporter plug-ins.

See also:

ExportAgent, Exporter

Definition at line 318 of file PlugInResource.h.

---

Constructor & Destructor Documentation

ExporterResource::ExporterResource	(	Progress *	pProgress = NULL,
		bool	batch = true
	)

Creates an invalid object for delayed initialization of an ExportAgent.

Creates an invalid object where no exporter is initially created. The exporter can then be initialized later by calling setPlugIn().

Parameters:

	pProgress	The progress object to pass into the exporter. If NULL is passed in, a progress object is obtained by calling PlugInManagerServices::getProgress().
	batch	Set this value to true to execute the exporter in batch mode or to false to execute the exporter in interactive mode.

Exceptions:

std::logic_error

Thrown if the instantiate() method is called more than once on a instance.

ExportAgent

This class simply allocates and controls the lifecycle of an ExportAgent object. You can use -> to access any of the methods available on ExportAgent.

Definition at line 329 of file PlugInResource.h.

ExporterResource::ExporterResource	(	std::string	exporterName,
		Progress *	pProgress = NULL,
		bool	batch = true
	)

Creates an exporter to export data.

Creates the exporter but does not specify the data to export. This method can be used if the exporter does not need a specific data value, or one will be provided later through setItem().

Parameters:

	exporterName	The name of the exporter to create and execute.
	pProgress	The progress object to pass into the exporter. If NULL is passed in, a progress object is obtained by calling PlugInManagerServices::getProgress().
	batch	Set this value to true to execute the exporter in batch mode or to false to execute the exporter in interactive mode.

Exceptions:

std::logic_error

Thrown if the instantiate() method is called more than once on a instance.

ExportAgent

This class simply allocates and controls the lifecycle of an ExportAgent object. You can use -> to access any of the methods available on ExportAgent.

Definition at line 346 of file PlugInResource.h.

ExporterResource::ExporterResource	(	PlugIn *	pPlugIn,
		Progress *	pProgress = NULL,
		bool	batch = true
	)

Uses an existing exporter to export data.

Parameters:

	pPlugIn	The exporter to execute. The agent assumes ownership of the exporter and will destroy it as necessary upon agent destruction.
	pProgress	The progress object to pass into the exporter. If NULL is passed in, a progress object is obtained by calling PlugInManagerServices::getProgress().
	batch	Set this value to true to execute the exporter in batch mode or to false to execute the exporter in interactive mode.

Exceptions:

std::logic_error

Thrown if the instantiate() method is called more than once on a instance.

ExportAgent

This class simply allocates and controls the lifecycle of an ExportAgent object. You can use -> to access any of the methods available on ExportAgent.

Definition at line 363 of file PlugInResource.h.

ExporterResource::ExporterResource	(	std::string	exporterName,
		SessionItem *	pItem,
		FileDescriptor *	pFileDescriptor,
		Progress *	pProgress = NULL,
		bool	batch = true
	)

Creates an exporter to export a view.

Parameters:

	exporterName	The name of the exporter to create and execute.
	pItem	The item to pass into the exporter.
	pFileDescriptor	The file descriptor describing how the exporter should save the data to disk.
	pProgress	The progress object to pass into the exporter. If NULL is passed in, a progress object is obtained by calling PlugInManagerServices::getProgress().
	batch	Set this value to true to execute the exporter in batch mode or to false to execute the exporter in interactive mode.

Exceptions:

std::logic_error

Thrown if the instantiate() method is called more than once on a instance.

ExportAgent

This class simply allocates and controls the lifecycle of an ExportAgent object. You can use -> to access any of the methods available on ExportAgent.

Definition at line 380 of file PlugInResource.h.

ExporterResource::ExporterResource	(	PlugIn *	pPlugIn,
		SessionItem *	pItem,
		FileDescriptor *	pFileDescriptor,
		Progress *	pProgress = NULL,
		bool	batch = true
	)

Uses an existing exporter to export a session item.

Parameters:

	pPlugIn	The exporter to execute. The agent assumes ownership of the exporter and will destroy it as necessary upon agent destruction.
	pItem	The item to pass into the exporter.
	pFileDescriptor	The file descriptor describing how the exporter should save the data to disk.
	pProgress	The progress object to pass into the exporter. If NULL is passed in, a progress object is obtained by calling PlugInManagerServices::getProgress().
	batch	Set this value to true to execute the exporter in batch mode or to false to execute the exporter in interactive mode.

Exceptions:

std::logic_error

Thrown if the instantiate() method is called more than once on a instance.

ExportAgent

This class simply allocates and controls the lifecycle of an ExportAgent object. You can use -> to access any of the methods available on ExportAgent.

Definition at line 398 of file PlugInResource.h.