Package org.robwork.sdurw

Class ControllerModel

java.lang.Object

org.robwork.sdurw_kinematics.Stateless

org.robwork.sdurw.ControllerModel

public class ControllerModel
extends Stateless

Interface to allow modelling of different types of controllers.
A controller is an instance that takes an input manipulates it to an output
that in effect controls something. As such controllers vary greatly and have
only little in common.

Constructor Summary

Constructors

Constructor	Description
ControllerModel(long cPtr, boolean cMemoryOwn)
ControllerModel(java.lang.String name, Frame frame)	constructor
ControllerModel(java.lang.String name, Frame frame, java.lang.String description)	constructor

Method Summary

Modifier and Type	Method	Description
void	attachTo(Frame frame)	Sets the frame to which the controllermodel should be attached
void	delete()
static long	getCPtr(ControllerModel obj)
java.lang.String	getDescription()	returns a description of this controllermodel
Frame	getFrame()	The frame to which the controllermodel is attached. The frame can be NULL.
java.lang.String	getName()	returns the name of this controllermodel
PropertyMap	getPropertyMap()	gets the propertymap of this controllermodel
void	setDescription(java.lang.String description)	sets the description of this controllermodel
void	setName(java.lang.String name)	sets the name of this controllermodel

Methods inherited from class org.robwork.sdurw_kinematics.Stateless

getCPtr, getStateStructure, isRegistered, registerIn, registerIn, unregister

Methods inherited from class java.lang.Object

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

Constructor Detail

ControllerModel

public ControllerModel(long cPtr,
                       boolean cMemoryOwn)

ControllerModel

public ControllerModel(java.lang.String name,
                       Frame frame)

constructor

Parameters:

name - [in] the name of this controllermodel

frame - [in] the frame to which this controller is attached/associated.

ControllerModel

public ControllerModel(java.lang.String name,
                       Frame frame,
                       java.lang.String description)

constructor

Parameters:

name - [in] the name of this controllermodel

frame - [in] the frame to which this controller is attached/associated.

description - [in] description of the controller

Method Detail

getCPtr

public static long getCPtr(ControllerModel obj)

delete

public void delete()

Overrides:

delete in class Stateless

setName

public void setName(java.lang.String name)

sets the name of this controllermodel

Parameters:

name - [in] name of this controllermodel

setDescription

public void setDescription(java.lang.String description)

sets the description of this controllermodel

Parameters:

description - [in] description of this controllermodel

getName

public java.lang.String getName()

returns the name of this controllermodel

Returns:

name of controllermodel

getDescription

public java.lang.String getDescription()

returns a description of this controllermodel

Returns:

reference to this controllermodels description

getFrame

public Frame getFrame()

The frame to which the controllermodel is attached.

The frame can be NULL.

attachTo

public void attachTo(Frame frame)

Sets the frame to which the controllermodel should be attached

Parameters:

frame - The frame, which can be NULL

getPropertyMap

public PropertyMap getPropertyMap()

gets the propertymap of this controllermodel