com.kuka.roboticsAPI.applicationModel
Class RoboticsAPIApplicationData

java.lang.Object
  com.kuka.roboticsAPI.applicationModel.RoboticsAPIApplicationData

All Implemented Interfaces:

IApplicationData, IFinalizableObject

public class RoboticsAPIApplicationData
extends Object
implements IApplicationData, IFinalizableObject

Class to get a robotics API application data.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

Constructor Summary

RoboticsAPIApplicationData(RoboticsAPIContext context)
Creates a new RoboticsAPIApplicationData.

Method Summary

<T extends SpatialObject> T	createFromTemplate(String name) Creates a SpatialObject (or its specialization) from a template.
void	dispose() Clean-up process data when the application gets disposed.
void	finalizeObject() Do finalization (cleanup) actions here.
ObjectFrame	getFrame(String framePath) Gets a persistent frame with the given path.
IProcessData	getProcessData(String id) Requests the process data object with the given identifier from the data source.
void	save() Saves all changes to the application data in the data source.
ObjectFrame	tryGetFrame(String framePath) Gets a persistent frame with the given path.
IProcessData	tryGetProcessData(String id) Requests the process data object with the given identifier from the data source.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoboticsAPIApplicationData

public RoboticsAPIApplicationData(RoboticsAPIContext context)

Creates a new RoboticsAPIApplicationData.

Parameters:

context - The context for this application data. null is not allowed.

Method Detail

createFromTemplate

public <T extends SpatialObject> T createFromTemplate(String name)

Description copied from interface: IApplicationData

Creates a SpatialObject (or its specialization) from a template.

Specified by:

createFromTemplate in interface IApplicationData

Type Parameters:

T - the specialization of the SpatialObject

Parameters:

name - the name of the requested template.

Returns:

the new spatial object instance based on the given template and specialization type.

getFrame

public final ObjectFrame getFrame(String framePath)

Description copied from interface: IApplicationData

Gets a persistent frame with the given path. Will throw an exception if the frame was not found.

Specified by:

getFrame in interface IApplicationData

Parameters:

framePath - the path of the requested frame.

Returns:

the loaded frame.

tryGetFrame

public final ObjectFrame tryGetFrame(String framePath)

Description copied from interface: IApplicationData

Gets a persistent frame with the given path.

Specified by:

tryGetFrame in interface IApplicationData

Parameters:

framePath - the path of the requested frame.

Returns:

the loaded frame or null if the frame was not found.

getProcessData

public final IProcessData getProcessData(String id)

Description copied from interface: IApplicationData

Requests the process data object with the given identifier from the data source. Will throw an exception if the process data object was not found.

Specified by:

getProcessData in interface IApplicationData

Parameters:

id - the identifier of the requested process data object.

Returns:

the requested process data object.

tryGetProcessData

public final IProcessData tryGetProcessData(String id)

Description copied from interface: IApplicationData

Requests the process data object with the given identifier from the data source.

Specified by:

tryGetProcessData in interface IApplicationData

Parameters:

id - the identifier of the requested process data object.

Returns:

the loaded process data object or null if the process data object was not found.

save

public final void save()

Description copied from interface: IApplicationData

Saves all changes to the application data in the data source. This is also performed automatically when the application terminates.

Specified by:

save in interface IApplicationData

finalizeObject

public void finalizeObject()

Description copied from interface: IFinalizableObject

Do finalization (cleanup) actions here.

Specified by:

finalizeObject in interface IFinalizableObject

dispose

public void dispose()

Clean-up process data when the application gets disposed.