ExternalApplicationManager

Manages an external application. More...

Public Member Functions
	ExternalApplicationManager (const FileFormat &format, QTModelManager *manager)
	Constructs an ExternalApplicationManager for the given file format.
virtual	~ExternalApplicationManager ()
	Virtual destructor.
ApplicationLauncherButtonManager *	createAppLauncher ()
	Creates and returns an ApplicationLauncherButtonManager for this application.
Button *	createLauncherButton ()
	Creates a Button widget that launches the external application.
bool	hasActiveInstallation () const
	Checks whether the external application has an active installation on the system.
virtual FactoryOptions	options (bool is_read, const FactoryParameters &params) const
	Returns factory options for reading or writing with this application's format.
void	setAdditionalArgs (const StringView &args)
	Sets additional command-line arguments to pass to the external application.
void	setLauncher (const File &f)
	Sets the executable file used to launch the external application.
void	setupForApp ()
	Performs setup required before launching the external application.
void	setWriteCameras (bool write_cameras)
	Sets whether camera data should be written when launching the application.

Detailed Description

Manages an external application.

---

This application may be run as a child process of the NDEVR API. For example a CAD session or a program to setup a GPS device. Programs often interact via a shared file which is handled through the IOFactory interface.

Definition at line 15 of file ExternalApplicationManager.h.

Constructor & Destructor Documentation

ExternalApplicationManager()

ExternalApplicationManager::ExternalApplicationManager	(	const FileFormat &	format,
		QTModelManager *	manager )

Constructs an ExternalApplicationManager for the given file format.

Parameters

[in]	format	The file format associated with the external application.
[in]	manager	The QTModelManager providing access to the data model.

Member Function Documentation

createAppLauncher()

ApplicationLauncherButtonManager * ExternalApplicationManager::createAppLauncher

(

)

Creates and returns an ApplicationLauncherButtonManager for this application.

Returns

A pointer to the newly created ApplicationLauncherButtonManager.

createLauncherButton()

Button * ExternalApplicationManager::createLauncherButton

(

)

Creates a Button widget that launches the external application.

Returns

A pointer to the newly created launcher Button.

hasActiveInstallation()

bool ExternalApplicationManager::hasActiveInstallation

(

)

const

Checks whether the external application has an active installation on the system.

Returns

True if the application is installed and available.

options()

virtual FactoryOptions ExternalApplicationManager::options ( bool is_read, const FactoryParameters & params ) const

virtual

Returns factory options for reading or writing with this application's format.

Parameters

[in]	is_read	True if the operation is a read, false for write.
[in]	params	The factory parameters to use.

Returns

The configured FactoryOptions.

setAdditionalArgs()

void ExternalApplicationManager::setAdditionalArgs

(

const StringView &

args

)

Sets additional command-line arguments to pass to the external application.

Parameters

[in]

args

The additional arguments string.

setLauncher()

void ExternalApplicationManager::setLauncher

(

const File &

f

)

Sets the executable file used to launch the external application.

Parameters

[in]

f

The path to the launcher executable.

setWriteCameras()

void ExternalApplicationManager::setWriteCameras

(

bool

write_cameras

)

Sets whether camera data should be written when launching the application.

Parameters

[in]

write_cameras

True to include camera data in the exported file.

---

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

• NDEVR/Headers/ExternalApplicationManager.h