ImFusion::Robotics::RoboticsPlugin Class Reference

#include <RoboticsPlugin/Include/ImFusion/Robotics/RoboticsPlugin.h>

Plugin for generic Robotics functionality. More...

Inheritance diagram for ImFusion::Robotics::RoboticsPlugin:

Detailed Description

Plugin for generic Robotics functionality.

Public Member Functions
const AlgorithmFactory *	getAlgorithmFactory () override
	Get algorithm factory for algorithms hosted by plugin.
const AlgorithmControllerFactory *	getAlgorithmControllerFactory () override
	Get algorithm controller factory for algorithms hosted by plugin.
std::string	pluginName () const override
	Return the name of the plugin.
Public Member Functions inherited from ImFusion::ImFusionPlugin
virtual const DataAnnotationFactory *	getDataAnnotationFactory ()
	Get data GL annotation factory for annotations hosted by plugin.
virtual std::vector< WorkspaceConversionFunction >	getWorkspaceConversionFunctions ()
	Return a list of workspace conversion functions and the corresponding workspace versions they apply to.
Public Member Functions inherited from ImFusion::ImFusionLibPlugin
virtual void	setApplicationController (ApplicationController &)
	Gives the plugin access to the application controller.
Public Member Functions inherited from ImFusion::PluginBase
std::string	pluginId () const
	Convenience function to query the plugin ID of a concrete instance at runtime.
PluginManager::PluginStatus	pluginStatus () const
	Convenience function to query the plugin status of a concrete instance at runtime.
virtual std::string	author () const =0
	Name of the author of the plugin for informative purposes.
virtual std::string	description () const =0
	Description of the plugin purpose/functionality for informative purposes.
Utils::Version	version () const
	Convenience function to query the version number of the plugin for informative purposes.
virtual std::vector< std::string >	dependencies () const
	Optional list of plugin IDs on which this plugin depends.

Additional Inherited Members
Public Types inherited from ImFusion::PluginBase
enum class	Status { Success = 0 , LicenseCheckFailed , Unsupported , UnknownError }
	Enumeration of status codes for plugin initialization. More...
Protected Member Functions inherited from ImFusion::ImFusionLibPlugin
bool	isLicensed (const std::string &entitlementName) const
	Helper function to check whether entitlementName is included in the currently activated license.
void	registerFactories (std::unique_ptr< AlgorithmFactory > algorithmFactory, std::unique_ptr< AlgorithmControllerFactory > controllerFactory, std::unique_ptr< DataAnnotationFactory > annotationFactory)
	Helper function to register the given factories with the FactoryRegistry.
Protected Member Functions inherited from ImFusion::PluginBase
virtual Status	init ()=0
	Perform plugin initialization, for instance by populating factories and registering custom types with the host application.

Member Function Documentation

getAlgorithmFactory()

const AlgorithmFactory * ImFusion::Robotics::RoboticsPlugin::getAlgorithmFactory ( )

overridevirtual

Get algorithm factory for algorithms hosted by plugin.

Implements ImFusion::ImFusionPlugin.

getAlgorithmControllerFactory()

const AlgorithmControllerFactory * ImFusion::Robotics::RoboticsPlugin::getAlgorithmControllerFactory ( )

overridevirtual

Get algorithm controller factory for algorithms hosted by plugin.

Implements ImFusion::ImFusionPlugin.

pluginName()

std::string ImFusion::Robotics::RoboticsPlugin::pluginName ( ) const

inlineoverridevirtual

Return the name of the plugin.

Note

When implementing this method, make sure to use a unique identifier to avoid conflicts with other plugins.

Reimplemented from ImFusion::ImFusionPlugin.

---

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

• RoboticsPlugin/Include/ImFusion/Robotics/RoboticsPlugin.h