Package org.robwork.sdurw_sensor
Class Scanner2DPtr
- java.lang.Object
-
- org.robwork.sdurw_sensor.Scanner2DPtr
-
public class Scanner2DPtr extends java.lang.ObjectPtr stores a pointer and optionally takes ownership of the value.
-
-
Constructor Summary
Constructors Constructor Description Scanner2DPtr()Default constructor yielding a NULL-pointer.Scanner2DPtr(long cPtr, boolean cMemoryOwn)Scanner2DPtr(Scanner2D 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 Scanner2D__ref__()Dereferencing operator.voidacquire()Acquires datavoidclose()Closes the connection to the scannerScanner2DCPtrcptr()voiddelete()Scanner2Dderef()The pointer stored in the object.booleanequals(Scanner2D p)doublegetAngularRange()Returns the angular range of the scanner.
static longgetCPtr(Scanner2DPtr obj)Scanner2DgetDeref()Member access operator.java.lang.StringgetDescription()returns a description of this sensordoublegetFrameRate()returns the framerate that this camera is setup withlonggetMeasurementCount()Returns the number of scan pointsjava.lang.StringgetName()returns the name of this sensorPropertyMapgetPropertyMap()gets the propertymap of this sensorpair_d_dgetRange()Returns the min and max range of this ScannerPointCloudgetScan()gets the last acquired scan as a depth image
of height 1.SensorModelPtrgetSensorModel()The frame to which the sensor is attached.
The frame can be NULL.booleanisNull()checks if the pointer is nullbooleanisOpen()Returns whether the scanner has been opened
booleanisScanReady()tests whether an image has been acquiredbooleanisShared()check if this Ptr has shared ownership or none
ownershipvoidopen()Opens connection to the scannervoidsetSensorModel(SensorModelPtr smodel)Sets the frame to which the sensor should be attached
-
-
-
Constructor Detail
-
Scanner2DPtr
public Scanner2DPtr(long cPtr, boolean cMemoryOwn)
-
Scanner2DPtr
public Scanner2DPtr()
Default constructor yielding a NULL-pointer.
-
Scanner2DPtr
public Scanner2DPtr(Scanner2D ptr)
Do not take ownership of ptr.
ptr can be null.
The constructor is implicit on purpose.
-
-
Method Detail
-
getCPtr
public static long getCPtr(Scanner2DPtr obj)
-
delete
public void delete()
-
deref
public Scanner2D deref()
The pointer stored in the object.
-
__ref__
public Scanner2D __ref__()
Dereferencing operator.
-
getDeref
public Scanner2D getDeref()
Member access operator.
-
equals
public boolean equals(Scanner2D 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
-
cptr
public Scanner2DCPtr cptr()
-
getScan
public PointCloud getScan()
gets the last acquired scan as a depth image
of height 1.
-
getAngularRange
public double getAngularRange()
Returns the angular range of the scanner.
- Returns:
- Angular range in radians
-
getMeasurementCount
public long getMeasurementCount()
Returns the number of scan points
-
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
-
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.
-
setSensorModel
public void setSensorModel(SensorModelPtr smodel)
Sets the frame to which the sensor should be attached
- Parameters:
smodel-
-
getPropertyMap
public PropertyMap getPropertyMap()
gets the propertymap of this sensor
-
-