org.openpnp.spi

Interface CoordinateAxis

All Superinterfaces:

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

All Known Subinterfaces:

ControllerAxis

All Known Implementing Classes:

AbstractControllerAxis, AbstractCoordinateAxis, ReferenceControllerAxis, ReferenceVirtualAxis

public interface CoordinateAxis
extends Axis

A CoordinateAxis is an axis which can store a coordinate either physically or virtually.

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

Method Summary

Modifier and Type	Method and Description
boolean	coordinatesMatch(double coordinateA, double coordinateB)
boolean	coordinatesMatch(Length coordinateA, Length coordinateB)
double	getCoordinate()
Length	getHomeCoordinate()
Length	getLengthCoordinate()
boolean	isInSafeZone(Length coordinate)
void	setCoordinate(double coordinate)
void	setHomeCoordinate(Length homeCoordinate)
void	setLengthCoordinate(Length coordinate)

Methods inherited from interface org.openpnp.spi.Axis

getType, setType

Methods inherited from interface org.openpnp.model.Identifiable

getId

Methods inherited from interface org.openpnp.model.Named

getName, setName

Methods inherited from interface org.openpnp.spi.WizardConfigurable

getConfigurationWizard

Methods inherited from interface org.openpnp.spi.PropertySheetHolder

getChildPropertySheetHolders, getPropertySheetHolderActions, getPropertySheetHolderIcon, getPropertySheetHolderTitle, getPropertySheets

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

findIssues, getSubjectIcon, getSubjectText

Method Detail

getCoordinate

double getCoordinate()

Returns:

The coordinate that was last sent to the MotionPlanner either through a moveTo() or other operations, such as homing. This coordinate may not yet be sent to the driver and even less likely reflect the physical machine position. Only after a waitForCompletion() on the MotionPlanner, can you be sure that the coordinate is in sync with the machine. The coordinate is always in AxesLocation.getUnits() i.e. in Millimeters.

getLengthCoordinate

Length getLengthCoordinate()

Returns:

The coordinate that was last sent to the MotionPlanner either through a moveTo() or other operations, such as homing. This coordinate may not yet be sent to the driver and even less likely reflect the physical machine position. Only after a waitForCompletion() on the MotionPlanner, can you be sure that the coordinate is in sync with the machine. The coordinate is always in AxesLocation.getUnits() i.e. in Millimeters.

setCoordinate

void setCoordinate(double coordinate)

setLengthCoordinate

void setLengthCoordinate(Length coordinate)

coordinatesMatch

boolean coordinatesMatch(Length coordinateA,
                         Length coordinateB)

Parameters:

coordinateA -

coordinateB -

Returns:

Whether the coordinates match in their native unit length and resolution as determined by the sub-class and possibly by a driver.

coordinatesMatch

boolean coordinatesMatch(double coordinateA,
                         double coordinateB)

Parameters:

coordinateA -

coordinateB -

Returns:

Whether the coordinates match in their native unit length and resolution as determined by the sub-class and possibly by a driver.

getHomeCoordinate

Length getHomeCoordinate()

setHomeCoordinate

void setHomeCoordinate(Length homeCoordinate)

isInSafeZone

boolean isInSafeZone(Length coordinate)