Package org.robwork.sdurw_simulation
Class SimulatedScanner2DPtr
- java.lang.Object
-
- org.robwork.sdurw_simulation.SimulatedScanner2DPtr
-
public class SimulatedScanner2DPtr extends java.lang.Object
Ptr stores a pointer and optionally takes ownership of the value.
-
-
Constructor Summary
Constructors Constructor Description SimulatedScanner2DPtr()
Default constructor yielding a NULL-pointer.SimulatedScanner2DPtr(long cPtr, boolean cMemoryOwn)
SimulatedScanner2DPtr(SimulatedScanner2D 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 SimulatedScanner2D
__ref__()
Dereferencing operator.void
acquire()
void
close()
SimulatedScanner2DCPtr
cptr()
void
delete()
SimulatedScanner2D
deref()
The pointer stored in the object.boolean
equals(SimulatedScanner2D p)
double
getAngularRange()
static long
getCPtr(SimulatedScanner2DPtr obj)
SimulatedScanner2D
getDeref()
Member access operator.Frame
getFrame()
get frame that this sensor is attached to.double
getFrameRate()
long
getMeasurementCount()
java.lang.String
getName()
get name of this simulated sensorpair_d_d
getRange()
PointCloud
getScan()
Scanner2DPtr
getScanner2DSensor(Simulator instance)
returns a handle to what represents a statefull interface.
The handle will be locked to the simulatorSensorPtr
getSensorHandle(SimulatorPtr sim)
get a handle to controlling an instance of the simulated sensor in a specific
simulatorSensorModelPtr
getSensorModel()
get the sensor model of this simulated sensor.StateStructurePtr
getStateStructure()
Get the state structure.boolean
isNull()
checks if the pointer is nullboolean
isOpen()
boolean
isRegistered()
Check if object has registered its state.boolean
isScanReady()
boolean
isShared()
check if this Ptr has shared ownership or none
ownershipvoid
open()
void
registerIn(State state)
initialize this stateless data to a specific statevoid
registerIn(StateStructurePtr state)
register this stateless object in a statestructure.void
reset(State state)
void
setFrameRate(double rate)
set the framerate in frames per sec.void
unregister()
unregisters all state data of this stateless objectvoid
update(Simulator.UpdateInfo info, State state)
-
-
-
Constructor Detail
-
SimulatedScanner2DPtr
public SimulatedScanner2DPtr(long cPtr, boolean cMemoryOwn)
-
SimulatedScanner2DPtr
public SimulatedScanner2DPtr()
Default constructor yielding a NULL-pointer.
-
SimulatedScanner2DPtr
public SimulatedScanner2DPtr(SimulatedScanner2D ptr)
Do not take ownership of ptr.
ptr can be null.
The constructor is implicit on purpose.
-
-
Method Detail
-
getCPtr
public static long getCPtr(SimulatedScanner2DPtr obj)
-
delete
public void delete()
-
deref
public SimulatedScanner2D deref()
The pointer stored in the object.
-
__ref__
public SimulatedScanner2D __ref__()
Dereferencing operator.
-
getDeref
public SimulatedScanner2D getDeref()
Member access operator.
-
equals
public boolean equals(SimulatedScanner2D 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 SimulatedScanner2DCPtr cptr()
-
setFrameRate
public void setFrameRate(double rate)
set the framerate in frames per sec.- Parameters:
rate
- [in] frames per sec
-
open
public void open()
-
isOpen
public boolean isOpen()
-
close
public void close()
-
acquire
public void acquire()
-
isScanReady
public boolean isScanReady()
-
getRange
public pair_d_d getRange()
-
getFrameRate
public double getFrameRate()
-
getScan
public PointCloud getScan()
-
update
public void update(Simulator.UpdateInfo info, State state)
-
reset
public void reset(State state)
-
getScanner2DSensor
public Scanner2DPtr getScanner2DSensor(Simulator instance)
returns a handle to what represents a statefull interface.
The handle will be locked to the simulator- Returns:
-
getAngularRange
public double getAngularRange()
-
getMeasurementCount
public long getMeasurementCount()
-
getName
public java.lang.String getName()
get name of this simulated sensor
-
getFrame
public Frame getFrame()
get frame that this sensor is attached to.- Returns:
- frame
-
getSensorModel
public SensorModelPtr getSensorModel()
get the sensor model of this simulated sensor.
-
getSensorHandle
public SensorPtr getSensorHandle(SimulatorPtr sim)
get a handle to controlling an instance of the simulated sensor in a specific
simulator- Parameters:
sim
- [in] the simulator in which the handle is active
-
registerIn
public void registerIn(State state)
initialize this stateless data to a specific state- Parameters:
state
- [in] the state in which to register the data.
Note: the data will be registered in the state structure of the state
and any copies or other instances of the state will therefore also
contain the added states.
-
registerIn
public void registerIn(StateStructurePtr state)
register this stateless object in a statestructure.
-
unregister
public void unregister()
unregisters all state data of this stateless object
-
getStateStructure
public StateStructurePtr getStateStructure()
Get the state structure.- Returns:
- the state structure.
-
isRegistered
public boolean isRegistered()
Check if object has registered its state.- Returns:
- true if registered, false otherwise.
-
-