com.kuka.roboticsAPI.applicationModel
Interface IApplicationData

All Known Implementing Classes:

RoboticsAPIApplicationData

public interface IApplicationData

Interface for application data. This interface contains methods for application data access.

Method Summary

<T extends SpatialObject> T	createFromTemplate(String name) Creates a SpatialObject (or its specialization) from a template.
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.

Method Detail

createFromTemplate

<T extends SpatialObject> T createFromTemplate(String name)

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

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.

Throws:

PersistenceException - if the template name was not found

getFrame

ObjectFrame getFrame(String framePath)

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

Parameters:

framePath - the path of the requested frame.

Returns:

the loaded frame.

Throws:

PersistenceException - if the frame was not found

tryGetFrame

ObjectFrame tryGetFrame(String framePath)

Gets a persistent frame with the given path.

Parameters:

framePath - the path of the requested frame.

Returns:

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

getProcessData

IProcessData getProcessData(String id)

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.

Parameters:

id - the identifier of the requested process data object.

Returns:

the requested process data object.

Throws:

PersistenceException - if the process data identifier was not found.

tryGetProcessData

IProcessData tryGetProcessData(String id)

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

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

void save()

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