Package org.robwork.sdurw_core

Class Extension

java.lang.Object

org.robwork.sdurw_core.Extension

public class Extension
extends java.lang.Object

The Extension class is used to provide additonal functionality from a
Plugin to other extension points of either the system or other plugins.

%Extension points in %RobWork:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Extension.Descriptor	An extension descriptor. The descriptor holds meta-data for an extension, and makes it possible to do lazy-loading of plugins.

Constructor Summary

Constructors

Constructor	Description
Extension(long cPtr, boolean cMemoryOwn)
Extension(java.lang.String id, java.lang.String point, Plugin owner)	Constructor.
Extension(java.lang.String id, java.lang.String point, Plugin owner, AnyPtr obj)	std::string&,const std::string&,Plugin*)
Extension(Extension.Descriptor desc, Plugin owner)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	delete()
static long	getCPtr(Extension obj)
java.lang.String	getId()	a unique id that uniquely identifies this extension in its owner Plugin
java.lang.String	getName()	a human readable name of this plugin (may contain spaces)
AnyPtr	getObject()	Get the object.
Plugin	getOwner()	get the owner plugin
java.lang.String	getPoint()	a unique global identifier of the extension point that this extension is attached to
PropertyMap	getProperties()	const

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Extension

public Extension(long cPtr,
                 boolean cMemoryOwn)

Extension

public Extension(Extension.Descriptor desc,
                 Plugin owner)

Constructor.

Parameters:

desc - [in] Description and configuration of extension.

owner - [in] the plugin that owns this extension or NULL.

Extension

public Extension(java.lang.String id,
                 java.lang.String point,
                 Plugin owner)

Constructor.

Parameters:

id - [in] a unique id of the extension.

point - [in] the extension point.

owner - [in] the plugin that owns this extension or NULL.

Extension

public Extension(java.lang.String id,
                 java.lang.String point,
                 Plugin owner,
                 AnyPtr obj)

std::string&,const std::string&,Plugin*)

Parameters:

obj - [in] a pointer to the object.

Method Detail

getCPtr

public static long getCPtr(Extension obj)

delete

public void delete()

getId

public java.lang.String getId()

a unique id that uniquely identifies this extension in its owner Plugin

getName

public java.lang.String getName()

a human readable name of this plugin (may contain spaces)

getPoint

public java.lang.String getPoint()

a unique global identifier of the extension point that this extension is attached to

getProperties

public PropertyMap getProperties()

const

getObject

public AnyPtr getObject()

Get the object.

Returns:

the object.

getOwner

public Plugin getOwner()

get the owner plugin