org.openpnp.spi.base

Class AbstractCamera

java.lang.Object

org.openpnp.model.AbstractModelObject

org.openpnp.spi.base.AbstractCamera

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Identifiable, Named, Camera, HeadMountable, Locatable, Movable, PropertySheetHolder, WizardConfigurable

Direct Known Subclasses:

ReferenceCamera

public abstract class AbstractCamera
extends AbstractModelObject
implements Camera

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractCamera.ListenerEntry

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

Camera.Looking

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

PropertySheetHolder.PropertySheet

Field Summary

Fields

Modifier and Type	Field and Description
protected Head	head
protected java.lang.Integer	height
protected java.lang.String	id
protected java.util.Set<AbstractCamera.ListenerEntry>	listeners
protected Camera.Looking	looking
protected java.lang.String	name
protected long	settleTimeMs
protected Location	unitsPerPixel
protected VisionProvider	visionProvider
protected java.lang.Integer	width

Fields inherited from class org.openpnp.model.AbstractModelObject

propertyChangeSupport

Constructor Summary

Constructors

Constructor and Description
AbstractCamera()

Method Summary

Modifier and Type	Method and Description
protected void	broadcastCapture(java.awt.image.BufferedImage img)
Head	getHead() Gets the Head that this HeadMountable is attached to.
java.lang.String	getId()
Camera.Looking	getLooking() Get the direction the Camera is looking.
java.lang.String	getName()
javax.swing.Icon	getPropertySheetHolderIcon()
long	getSettleTimeMs() Get the time in milliseconds that the Camera should be allowed to settle before images are captured for vision operations.
Location	getUnitsPerPixel() The number of X and Y units per pixel this camera shows when in perfect focus.
VisionProvider	getVisionProvider() Get the VisionProvider that is attached to this Camera, if any.
void	moveTo(Location location)
void	moveToSafeZ()
void	setHead(Head head) Set the Head that this HeadMountable is attached to.
void	setLooking(Camera.Looking looking)
void	setName(java.lang.String name)
void	setSettleTimeMs(long settleTimeMs)
java.awt.image.BufferedImage	settleAndCapture() Same as capture(), but waits the settle time before capturing.
void	setUnitsPerPixel(Location unitsPerPixel)
void	setVisionProvider(VisionProvider visionProvider)
void	startContinuousCapture(CameraListener listener) Registers a listener to receive continuous images from the camera.
void	stopContinuousCapture(CameraListener listener) Requests that the continuous capture be stopped for the previously registered listener.
java.lang.String	toString()

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.Camera

capture, getHeight, getWidth

Methods inherited from interface org.openpnp.spi.Movable

moveTo, moveToSafeZ

Methods inherited from interface org.openpnp.spi.Locatable

getLocation

Methods inherited from interface org.openpnp.spi.WizardConfigurable

getConfigurationWizard

Methods inherited from interface org.openpnp.spi.PropertySheetHolder

getChildPropertySheetHolders, getPropertySheetHolderActions, getPropertySheetHolderTitle, getPropertySheets

Methods inherited from interface java.io.Closeable

close

Field Detail

id

protected java.lang.String id

name

protected java.lang.String name

looking

protected Camera.Looking looking

unitsPerPixel

protected Location unitsPerPixel

visionProvider

protected VisionProvider visionProvider

settleTimeMs

protected long settleTimeMs

listeners

protected java.util.Set<AbstractCamera.ListenerEntry> listeners

head

protected Head head

width

protected java.lang.Integer width

height

protected java.lang.Integer height

Constructor Detail

AbstractCamera

public AbstractCamera()

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

getHead

public Head getHead()

Description copied from interface: HeadMountable

Gets the Head that this HeadMountable is attached to. If it is not attached to a Head this method returns null.

Specified by:

getHead in interface HeadMountable

Returns:

setHead

public void setHead(Head head)

Description copied from interface: HeadMountable

Set the Head that this HeadMountable is attached to. Called by the Head when the HeadMountable is added to it.

Specified by:

setHead in interface HeadMountable

getUnitsPerPixel

public Location getUnitsPerPixel()

Description copied from interface: Camera

The number of X and Y units per pixel this camera shows when in perfect focus. Location isn't a great datatype for this, but it gets the job done.

Specified by:

getUnitsPerPixel in interface Camera

Returns:

setUnitsPerPixel

public void setUnitsPerPixel(Location unitsPerPixel)

Specified by:

setUnitsPerPixel in interface Camera

setLooking

public void setLooking(Camera.Looking looking)

Specified by:

setLooking in interface Camera

getLooking

public Camera.Looking getLooking()

Description copied from interface: Camera

Get the direction the Camera is looking.

Specified by:

getLooking in interface Camera

Returns:

startContinuousCapture

public void startContinuousCapture(CameraListener listener)

Description copied from interface: Camera

Registers a listener to receive continuous images from the camera.

Specified by:

startContinuousCapture in interface Camera

stopContinuousCapture

public void stopContinuousCapture(CameraListener listener)

Description copied from interface: Camera

Requests that the continuous capture be stopped for the previously registered listener. If the Camera has other listeners they should still receive updates.

Specified by:

stopContinuousCapture in interface Camera

setVisionProvider

public void setVisionProvider(VisionProvider visionProvider)

Specified by:

setVisionProvider in interface Camera

getVisionProvider

public VisionProvider getVisionProvider()

Description copied from interface: Camera

Get the VisionProvider that is attached to this Camera, if any.

Specified by:

getVisionProvider in interface Camera

Returns:

settleAndCapture

public java.awt.image.BufferedImage settleAndCapture()

Description copied from interface: Camera

Same as capture(), but waits the settle time before capturing.

Specified by:

settleAndCapture in interface Camera

Returns:

broadcastCapture

protected void broadcastCapture(java.awt.image.BufferedImage img)

getSettleTimeMs

public long getSettleTimeMs()

Description copied from interface: Camera

Get the time in milliseconds that the Camera should be allowed to settle before images are captured for vision operations.

Specified by:

getSettleTimeMs in interface Camera

Returns:

setSettleTimeMs

public void setSettleTimeMs(long settleTimeMs)

Specified by:

setSettleTimeMs in interface Camera

getPropertySheetHolderIcon

public javax.swing.Icon getPropertySheetHolderIcon()

Specified by:

getPropertySheetHolderIcon in interface PropertySheetHolder

moveTo

public void moveTo(Location location)
            throws java.lang.Exception

Specified by:

moveTo in interface Movable

Throws:

java.lang.Exception

moveToSafeZ

public void moveToSafeZ()
                 throws java.lang.Exception

Specified by:

moveToSafeZ in interface Movable

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object