Package org.robwork.sdurw_sensor
Class Scanner1DPtr
- java.lang.Object
-
- org.robwork.sdurw_sensor.Scanner1DPtr
-
public class Scanner1DPtr extends java.lang.Object
Ptr stores a pointer and optionally takes ownership of the value.
-
-
Constructor Summary
Constructors Constructor Description Scanner1DPtr()
Default constructor yielding a NULL-pointer.Scanner1DPtr(long cPtr, boolean cMemoryOwn)
Scanner1DPtr(Scanner1D 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 Scanner1D
__ref__()
Dereferencing operator.void
acquire()
Acquires datavoid
close()
Closes the connection to the scannerScanner1DCPtr
cptr()
void
delete()
Scanner1D
deref()
The pointer stored in the object.boolean
equals(Scanner1D p)
static long
getCPtr(Scanner1DPtr obj)
Scanner1D
getDeref()
Member access operator.java.lang.String
getDescription()
returns a description of this sensordouble
getFrameRate()
returns the framerate that this camera is setup withjava.lang.String
getName()
returns the name of this sensorPropertyMap
getPropertyMap()
gets the propertymap of this sensorpair_d_d
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 acquiredboolean
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
-
Scanner1DPtr
public Scanner1DPtr(long cPtr, boolean cMemoryOwn)
-
Scanner1DPtr
public Scanner1DPtr()
Default constructor yielding a NULL-pointer.
-
Scanner1DPtr
public Scanner1DPtr(Scanner1D ptr)
Do not take ownership of ptr.
ptr can be null.
The constructor is implicit on purpose.
-
-
Method Detail
-
getCPtr
public static long getCPtr(Scanner1DPtr obj)
-
delete
public void delete()
-
deref
public Scanner1D deref()
The pointer stored in the object.
-
__ref__
public Scanner1D __ref__()
Dereferencing operator.
-
getDeref
public Scanner1D getDeref()
Member access operator.
-
equals
public boolean equals(Scanner1D 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 Scanner1DCPtr cptr()
-
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
-
-