org.openpnp.spi.base

Class AbstractAxis

java.lang.Object

org.openpnp.model.AbstractModelObject

org.openpnp.spi.base.AbstractAxis

All Implemented Interfaces:

Identifiable, Named, Solutions.Subject, Axis, PropertySheetHolder, WizardConfigurable

Direct Known Subclasses:

AbstractCoordinateAxis, AbstractTransformedAxis

public abstract class AbstractAxis
extends AbstractModelObject
implements Axis

The Abstract Axis implements the common denominator of all the sub-classes.

Nested Class Summary

Nested classes/interfaces inherited from interface org.openpnp.spi.Axis

Axis.Type

Nested classes/interfaces inherited from interface org.openpnp.spi.PropertySheetHolder

PropertySheetHolder.PropertySheet

Field Summary

Fields

Modifier and Type	Field and Description
javax.swing.Action	deleteAction
protected java.lang.String	id
protected java.lang.String	name
javax.swing.Action	permutateDownAction
javax.swing.Action	permutateUpAction
protected Axis.Type	type

Fields inherited from class org.openpnp.model.AbstractModelObject

propertyChangeSupport

Constructor Summary

Constructors

Constructor and Description
AbstractAxis()

Method Summary

Modifier and Type	Method and Description
PropertySheetHolder[]	getChildPropertySheetHolders()
static AxesLocation	getCoordinateAxes(AbstractAxis axis, Machine machine)
abstract AxesLocation	getCoordinateAxes(Machine machine)
java.lang.String	getId()
java.lang.String	getName()
javax.swing.Action[]	getPropertySheetHolderActions()
javax.swing.Icon	getPropertySheetHolderIcon()
java.lang.String	getPropertySheetHolderTitle()
PropertySheetHolder.PropertySheet[]	getPropertySheets()
Axis.Type	getType()
void	setName(java.lang.String name)
void	setType(Axis.Type type)
abstract AxesLocation	toRaw(AxesLocation location, Locatable.LocationOption... options) Transform the specified transformed coordinate taken from the specified location into the raw coordinate embedded into the returned location.
java.lang.String	toString()
abstract AxesLocation	toTransformed(AxesLocation location, Locatable.LocationOption... options) Transform the raw axis coordinate(s) taken from the specified location into the transformed coordinate embedded into the returned location.

Methods inherited from class org.openpnp.model.AbstractModelObject

addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, firePropertyChange, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openpnp.spi.WizardConfigurable

getConfigurationWizard

Methods inherited from interface org.openpnp.model.Solutions.Subject

findIssues, getSubjectIcon, getSubjectText

Field Detail

id

protected java.lang.String id

name

protected java.lang.String name

type

protected Axis.Type type

deleteAction

public javax.swing.Action deleteAction

permutateUpAction

public javax.swing.Action permutateUpAction

permutateDownAction

public javax.swing.Action permutateDownAction

Constructor Detail

AbstractAxis

public AbstractAxis()

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface Identifiable

getName

public java.lang.String getName()

Specified by:

getName in interface Named

setName

public void setName(java.lang.String name)

Specified by:

setName in interface Named

getType

public Axis.Type getType()

Specified by:

getType in interface Axis

setType

public void setType(Axis.Type type)

Specified by:

setType in interface Axis

getCoordinateAxes

public abstract AxesLocation getCoordinateAxes(Machine machine)

Parameters:

machine - The Machine with the axes to be considered.

Returns:

The set of ControllerAxes that are the ultimate input axes of the axis stack.

getCoordinateAxes

public static AxesLocation getCoordinateAxes(AbstractAxis axis,
                                             Machine machine)

toTransformed

public abstract AxesLocation toTransformed(AxesLocation location,
                                           Locatable.LocationOption... options)

Transform the raw axis coordinate(s) taken from the specified location into the transformed coordinate embedded into the returned location. The transformed location is what the user sees, while the raw location is what the motion controller sees. Some transformations handle multiple axes, therefore the full location is passed through. A ControllerAxis will just return the unchanged coordinate.

Parameters:

location -

Returns:

the transformed axis coordinate.

Throws:

java.lang.Exception

toRaw

public abstract AxesLocation toRaw(AxesLocation location,
                                   Locatable.LocationOption... options)
                            throws java.lang.Exception

Transform the specified transformed coordinate taken from the specified location into the raw coordinate embedded into the returned location. The transformed location is what the user sees, while the raw location is what the motion controller sees. Some transformations handle multiple axes, therefore the full Location is passed through. A ControllerAxis will just return the unchanged coordinate.

Parameters:

location -

Returns:

the raw axis coordinate in the LengthUnit of the given Location.

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPropertySheets

public PropertySheetHolder.PropertySheet[] getPropertySheets()

Specified by:

getPropertySheets in interface PropertySheetHolder

getPropertySheetHolderActions

public javax.swing.Action[] getPropertySheetHolderActions()

Specified by:

getPropertySheetHolderActions in interface PropertySheetHolder

getPropertySheetHolderIcon

public javax.swing.Icon getPropertySheetHolderIcon()

Specified by:

getPropertySheetHolderIcon in interface PropertySheetHolder

getChildPropertySheetHolders

public PropertySheetHolder[] getChildPropertySheetHolders()

Specified by:

getChildPropertySheetHolders in interface PropertySheetHolder

getPropertySheetHolderTitle

public java.lang.String getPropertySheetHolderTitle()

Specified by:

getPropertySheetHolderTitle in interface PropertySheetHolder