ExecutableResource Class Reference

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

#include <PlugInResource.h>

Inheritance diagram for ExecutableResource:

List of all members.

Public Member Functions
	ExecutableResource (Progress *pProgress=NULL, bool batch=true)
	ExecutableResource (const std::string &plugInName, const std::string &menuCommand=std::string(), Progress *pProgress=NULL, bool batch=true)
	ExecutableResource (PlugIn *pPlugIn, const std::string &menuCommand=std::string(), Progress *pProgress=NULL, bool batch=true)

---

Detailed Description

This is a helper class when using the Executable interface.

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

See also:

ExecutableAgent, Executable

Examples:

Tutorial/Tutorial2.cpp.

Definition at line 134 of file PlugInResource.h.

---

Constructor & Destructor Documentation

ExecutableResource::ExecutableResource	(	Progress *	pProgress = NULL,
		bool	batch = true
	)			[explicit]

Creates an invalid object for delayed initialization of a ExecutableAgent.

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

Parameters:

	pProgress	The progress object to pass into the plug-in. If NULL is passed in, a progress object is obtained by calling PlugInManagerServices::getProgress().
	batch	Set this value to true to execute the plug-in in batch mode or to false to execute the plug-in in interactive mode. Background plug-ins executed in interactive mode are automatically added to the Background Plug-In Window.

Exceptions:

std::logic_error

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

ExecutableAgent

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

Definition at line 145 of file PlugInResource.h.

ExecutableResource::ExecutableResource	(	const std::string &	plugInName,
		const std::string &	menuCommand = std::string(),
		Progress *	pProgress = NULL,
		bool	batch = true
	)			[explicit]

Creates a Executable to execute.

Parameters:

	plugInName	The name of the Executable to create and execute.
	menuCommand	The menu command name from which the plug-in is executed. The menu command name is set into an arg with "Menu Command" as its name and "string" as its type. If this arg does not exist in the arg list of the given plug-in, this parameter is ignored. If an empty string is passed in, no arg value is set.
	pProgress	The progress object to pass into the plug-in. If NULL is passed in, a progress object is obtained by calling PlugInManagerServices::getProgress().
	batch	Set this value to true to execute the plug-in in batch mode or to false to execute the plug-in in interactive mode. Background plug-ins executed in interactive mode are automatically added to the Background Plug-In Window.

Exceptions:

std::logic_error

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

ExecutableAgent

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

Definition at line 162 of file PlugInResource.h.

ExecutableResource::ExecutableResource	(	PlugIn *	pPlugIn,
		const std::string &	menuCommand = std::string(),
		Progress *	pProgress = NULL,
		bool	batch = true
	)			[explicit]

Uses an Executable to execute.

Parameters:

	pPlugIn	The plug-in to execute. The agent assumes ownership of the given plug-in and will destroy it as necessary upon destruction.
	menuCommand	The menu command name from which the plug-in is executed. The menu command name is set into an arg with "Menu Command" as its name and "string" as its type. If this arg does not exist in the arg list of the given plug-in, this parameter is ignored. If an empty string is passed in, no arg value is set.
	pProgress	The progress object to pass into the plug-in. If NULL is passed in, a progress object is obtained by calling PlugInManagerServices::getProgress().
	batch	Set this value to true to execute the plug-in in batch mode or to false to execute the plug-in in interactive mode. Background plug-ins executed in interactive mode are automatically added to the Background Plug-In Window.

Exceptions:

std::logic_error

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

ExecutableAgent

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

Definition at line 180 of file PlugInResource.h.