Package org.robwork.sdurw
Class ScannerPtr
- java.lang.Object
-
- org.robwork.sdurw.ScannerPtr
-
public class ScannerPtr extends java.lang.Object
Ptr stores a pointer and optionally takes ownership of the value.
-
-
Constructor Summary
Constructors Constructor Description ScannerPtr()
Default constructor yielding a NULL-pointer.ScannerPtr(long cPtr, boolean cMemoryOwn)
ScannerPtr(Scanner ptr)
Do not take ownership of ptr.
ptr can be null.
The constructor is implicit on purpose.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Scanner
__ref__()
Dereferencing operator.void
acquire()
Acquires datavoid
close()
Closes the connection to the scannervoid
delete()
Scanner
deref()
The pointer stored in the object.boolean
equals(Scanner p)
static long
getCPtr(ScannerPtr obj)
Scanner
getDeref()
Member access operator.java.lang.String
getDescription()
returns a description of this sensor
double
getFrameRate()
returns the framerate that this camera is setup with
java.lang.String
getName()
returns the name of this sensor
PropertyMap
getPropertyMap()
gets the propertymap of this sensorpairDoubleDouble
getRange()
Returns the min and max range of this ScannerSensorModelPtr
getSensorModel()
The frame to which the sensor is attached.
The frame can be NULL.boolean
isNull()
checks if the pointer is nullboolean
isOpen()
Returns whether the scanner has been opened
boolean
isScanReady()
tests whether an image has been acquired
boolean
isShared()
check if this Ptr has shared ownership or none
ownershipvoid
open()
Opens connection to the scannervoid
setSensorModel(SensorModelPtr smodel)
Sets the frame to which the sensor should be attached
-
-
-
Constructor Detail
-
ScannerPtr
public ScannerPtr(long cPtr, boolean cMemoryOwn)
-
ScannerPtr
public ScannerPtr()
Default constructor yielding a NULL-pointer.
-
ScannerPtr
public ScannerPtr(Scanner ptr)
Do not take ownership of ptr.
ptr can be null.
The constructor is implicit on purpose.
-
-
Method Detail
-
getCPtr
public static long getCPtr(ScannerPtr obj)
-
delete
public void delete()
-
deref
public Scanner deref()
The pointer stored in the object.
-
__ref__
public Scanner __ref__()
Dereferencing operator.
-
getDeref
public Scanner getDeref()
Member access operator.
-
equals
public boolean equals(Scanner p)
-
isShared
public boolean isShared()
check if this Ptr has shared ownership or none
ownership- Returns:
- true if Ptr has shared ownership, false if it has no ownership.
-
isNull
public boolean isNull()
checks if the pointer is null- Returns:
- Returns true if the pointer is null
-
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 pairDoubleDouble 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
-
getName
public java.lang.String getName()
returns the name of this sensor
- Returns:
- name of sensor
-
getDescription
public java.lang.String getDescription()
returns a description of this sensor
- Returns:
- reference to this sensors description
-
getSensorModel
public SensorModelPtr getSensorModel()
The frame to which the sensor is attached.
The frame can be NULL.- Returns:
- pointer to sensor model
-
setSensorModel
public void setSensorModel(SensorModelPtr smodel)
Sets the frame to which the sensor should be attached
- Parameters:
smodel
- set the sensor model
-
getPropertyMap
public PropertyMap getPropertyMap()
gets the propertymap of this sensor
-
-