com.kuka.roboticsAPI.persistenceModel
Interface IApplicationDataSource

All Superinterfaces:

IDataSource

All Known Subinterfaces:

ISaveableApplicationDataSource

All Known Implementing Classes:

XmlApplicationDataSource

public interface IApplicationDataSource
extends IDataSource

Interface for data source dealing with standard application objects such as frames and tool data.

Method Summary

void	addApplicationDataChangedListener(IApplicationDataChanged listener) Registers the given listener for application data changes.
ObjectFrame	addFrame(ObjectFrame parent) Creates an adds a new frame to the data source.
Collection<ToolTemplate>	getToolTemplates() Gets all the tool templates of the data source.
Collection<? extends ObjectFrame>	loadAllFrames() Gets all frames known to the data source.
Collection<IProcessData>	loadAllProcessData() Gets all process data elements known to the data source., The process data will not be in any specific order.
Collection<? extends TemplateElement>	loadAllTemplates() Gets all templates known to the data source.
Collection<ToolData>	loadAllToolDatas() Deprecated. use templates instead
Collection<UserData>	loadAllUserData() Deprecated. use process data instead
ObjectFrame	loadFrame(String name) Loads a frame with the specified path.
ObjectFrame	loadFrameById(String id) Loads a frame with the specified unique id.
IProcessData	loadProcessData(String id) Loads a process data object with the specified identifier.
TemplateElement	loadTemplate(String name) Loads a template with the specified name.
ToolData	loadToolData(String name) Deprecated. use templates instead
UserData	loadUserData(String name) Deprecated. use process data instead
void	removeApplicationDataChangedListener(IApplicationDataChanged listener) Unregisters the given listener for application data changes.
ObjectFrame	tryLoadFrame(String name) Loads a frame with the specified path.
IProcessData	tryLoadProcessData(String id) Loads a process data object with the specified identifier.

Methods inherited from interface com.kuka.roboticsAPI.persistenceModel.IDataSource

close, getContext, getName, isOpen, isReadOnly, open, setContext, setParameters

Method Detail

loadFrame

ObjectFrame loadFrame(String name)

Loads a frame with the specified path. Changes on the reference will affect the data source.

The object should always be the same unless the data source get's closed and re-opened.

Parameters:

name - the path to the frame.

Returns:

the loaded frame.

Throws:

PersistenceException - if the frame was not found

loadFrameById

ObjectFrame loadFrameById(String id)

Loads a frame with the specified unique id. Changes on the reference will affect the data source.

The object should always be the same unless the data source get's closed and re-opened.

Parameters:

id - the unique id to the frame.

Returns:

the loaded frame, or null if a frame with this id is unknown

tryLoadFrame

ObjectFrame tryLoadFrame(String name)

Loads a frame with the specified path. Changes on the reference will affect the data source.

The object should always be the same unless the data source get's closed and re-opened.

Parameters:

name - The path to the frame.

Returns:

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

addFrame

ObjectFrame addFrame(ObjectFrame parent)

Creates an adds a new frame to the data source. The new name will follow the workbench naming convention.

Parameters:

parent - The parent where the given frame should be added.

Returns:

returns a newly created frame.

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.

loadTemplate

TemplateElement loadTemplate(String name)

Loads a template with the specified name. Changes on the template will affect the data source.

The object should always be the same unless the data source get's closed and re-opened.

Parameters:

name - The name of the template.

Returns:

The loaded template.

Throws:

PersistenceException - if the template was not found

loadToolData

@Deprecated
ToolData loadToolData(String name)

Deprecated. use templates instead

Loads tool data with the specified name. Changes on the tool data will affect the data source.

The object should always be the same unless the data source get's closed and re-opened.

Parameters:

name - The name of the tool data.

Returns:

The loaded tool data.

loadUserData

@Deprecated
UserData loadUserData(String name)

Deprecated. use process data instead

Gets the user data stored under the given name. The user data is a simple key-value pair.

Parameters:

name - The name of the user data.

Returns:

The user data.

loadAllFrames

Collection<? extends ObjectFrame> loadAllFrames()

Gets all frames known to the data source.

The frames will not be in any specific order.

Returns:

All frames known to the data source.

This element is not in its final state and might change in future versions.

loadAllTemplates

Collection<? extends TemplateElement> loadAllTemplates()

Gets all templates known to the data source.

The templates will not be in any specific order.

Returns:

All templates known to the data source.

loadAllToolDatas

@Deprecated
Collection<ToolData> loadAllToolDatas()

Deprecated. use templates instead

Gets all tool data known to the data source.

The tool data will not be in any specific order.

Returns:

All tool data known to the data source.

loadAllUserData

@Deprecated
Collection<UserData> loadAllUserData()

Deprecated. use process data instead

Gets all user data keys known to the data source. The values can be requested through the loadUserData method.

The user data will not be in any specific order.

Returns:

All user data known to the data source.

See Also:

loadUserData(String)

getToolTemplates

Collection<ToolTemplate> getToolTemplates()

Gets all the tool templates of the data source.

Returns:

all the tool templates of the data source.

addApplicationDataChangedListener

void addApplicationDataChangedListener(IApplicationDataChanged listener)

Registers the given listener for application data changes.

Parameters:

listener - The listener which should be called after application data has changed.

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.

removeApplicationDataChangedListener

void removeApplicationDataChangedListener(IApplicationDataChanged listener)

Unregisters the given listener for application data changes.

Parameters:

listener - The registered listener which should be unregistered.

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.

loadProcessData

IProcessData loadProcessData(String id)

Loads a process data object with the specified identifier. Changes on the reference will affect the data source.

Parameters:

id - the identifier of the process data object.

Returns:

the loaded process data object.

Throws:

PersistenceException - if the process data identifier was not found

tryLoadProcessData

IProcessData tryLoadProcessData(String id)

Loads a process data object with the specified identifier. Changes on the reference will affect the data source.

Parameters:

id - the identifier of the process data object.

Returns:

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

loadAllProcessData

Collection<IProcessData> loadAllProcessData()

Gets all process data elements known to the data source.,

The process data will not be in any specific order.

Returns:

All process data elements known to the data source.