Scanner (RobWork Java API Documentation)

java.lang.Object
- org.robwork.sdurw_sensor.Sensor
- - org.robwork.sdurw_sensor.Scanner

Direct Known Subclasses:

Scanner1D, Scanner25D, Scanner2D
```
public class Scanner
extends Sensor
```
this interface describe a generic range scanning class.

Constructor Summary

Constructors
Constructor Description

Scanner(long cPtr, boolean cMemoryOwn)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`acquire()`	Acquires data
`void`	`close()`	Closes the connection to the scanner
`void`	`delete()`
`static long`	`getCPtr(Scanner obj)`
`double`	`getFrameRate()`	returns the framerate that this camera is setup with
`pair_d_d`	`getRange()`	Returns the min and max range of this Scanner
`boolean`	`isOpen()`	Returns whether the scanner has been opened
`boolean`	`isScanReady()`	tests whether an image has been acquired
`void`	`open()`	Opens connection to the scanner

Methods inherited from class org.robwork.sdurw_sensor.Sensor
getCPtr, getDescription, getName, getPropertyMap, getSensorModel, setSensorModel

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Scanner
```
public Scanner(long cPtr,
               boolean cMemoryOwn)
```
- Method Detail
  - getCPtr
```
public static long getCPtr(Scanner obj)
```
  - delete
```
public void delete()
```
    Overrides:
    
    delete in class Sensor
  - open
```
public void open()
```
    Opens connection to the scanner
  - isOpen
```
public boolean isOpen()
```
    Returns whether the scanner has been opened
    
    Returns:
    
    true if scanner is opened
  - close
```
public void close()
```
    Closes the connection to the scanner
  - acquire
```
public void acquire()
```
    Acquires data
  - isScanReady
```
public boolean isScanReady()
```
    tests whether an image has been acquired
    
    Returns:
    
    true if an image has been acquired, false otherwise.
  - getRange
```
public pair_d_d getRange()
```
    Returns the min and max range of this Scanner
    
    Returns:
    
    min and max range
  - getFrameRate
```
public double getFrameRate()
```
    returns the framerate that this camera is setup with
    
    Returns:
    
    the framerate in frames per second