com.kuka.roboticsAPI.controllerModel
Class ControllerInformation

java.lang.Object
  com.kuka.roboticsAPI.controllerModel.ControllerInformation

public final class ControllerInformation
extends Object

This class holds some additional information for a controller. Each concrete controller may modify the parameter of this class in order to provide some additional information.

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.

Method Summary

static ControllerInformation	getDefault() Gets a new default controller information instance.
String	getDescription() Gets some description text of the controller.
String	getId() Gets the id of the controller.
String	getName() Gets the name of the controller.
com.kuka.common.ParameterSet	getParameters() Gets the parameter map with which the attached controller was configured.
String	getVersion() Gets version information about the controller.
void	setDescription(String description) Sets the description text of the controller.
void	setVersion(String version) Sets version information for this controller.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Gets the name of the controller.

Returns:

The name of the controller.

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.

getId

public String getId()

Gets the id of the controller. This is actually the class name of the controller.

Returns:

The id of the controller. This is actually the class name of the controller.

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.

getParameters

public com.kuka.common.ParameterSet getParameters()

Gets the parameter map with which the attached controller was configured.

Returns:

The parameter map with which the attached controller was configured.

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.

getDescription

public String getDescription()

Gets some description text of the controller.

Returns:

Some description text of the controller.

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.

setDescription

public void setDescription(String description)

Sets the description text of the controller.

Parameters:

description - The description text of the controller.

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.

getVersion

public String getVersion()

Gets version information about the controller.

Returns:

Version information about the controller.

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.

setVersion

public void setVersion(String version)

Sets version information for this controller.

Parameters:

version - Version information for this controller.

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.

getDefault

public static ControllerInformation getDefault()

Gets a new default controller information instance.

Returns:

A new default controller information instance.

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.

toString

public String toString()

Overrides:

toString in class Object

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.