Package org.robwork.sdurw_simulation
Class SimulatedScanner2DPtr
- java.lang.Object
- 
- org.robwork.sdurw_simulation.SimulatedScanner2DPtr
 
- 
 public class SimulatedScanner2DPtr extends java.lang.ObjectPtr stores a pointer and optionally takes ownership of the value.
- 
- 
Constructor SummaryConstructors 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 SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SimulatedScanner2D__ref__()Dereferencing operator.voidacquire()voidclose()SimulatedScanner2DCPtrcptr()voiddelete()SimulatedScanner2Dderef()The pointer stored in the object.booleanequals(SimulatedScanner2D p)doublegetAngularRange()static longgetCPtr(SimulatedScanner2DPtr obj)SimulatedScanner2DgetDeref()Member access operator.FramegetFrame()get frame that this sensor is attached to.doublegetFrameRate()longgetMeasurementCount()java.lang.StringgetName()get name of this simulated sensorpair_d_dgetRange()PointCloudgetScan()Scanner2DPtrgetScanner2DSensor(Simulator instance)returns a handle to what represents a statefull interface.
 The handle will be locked to the simulatorSensorPtrgetSensorHandle(SimulatorPtr sim)get a handle to controlling an instance of the simulated sensor in a specific
 simulatorSensorModelPtrgetSensorModel()get the sensor model of this simulated sensor.StateStructurePtrgetStateStructure()Get the state structure.booleanisNull()checks if the pointer is nullbooleanisOpen()booleanisRegistered()Check if object has registered its state.booleanisScanReady()booleanisShared()check if this Ptr has shared ownership or none
 ownershipvoidopen()voidregisterIn(State state)initialize this stateless data to a specific statevoidregisterIn(StateStructurePtr state)register this stateless object in a statestructure.voidreset(State state)voidsetFrameRate(double rate)set the framerate in frames per sec.voidunregister()unregisters all state data of this stateless objectvoidupdate(Simulator.UpdateInfo info, State state)
 
- 
- 
- 
Constructor Detail- 
SimulatedScanner2DPtrpublic SimulatedScanner2DPtr(long cPtr, boolean cMemoryOwn)
 - 
SimulatedScanner2DPtrpublic SimulatedScanner2DPtr() Default constructor yielding a NULL-pointer.
 - 
SimulatedScanner2DPtrpublic SimulatedScanner2DPtr(SimulatedScanner2D ptr) Do not take ownership of ptr.
 
 ptr can be null.
 
 The constructor is implicit on purpose.
 
- 
 - 
Method Detail- 
getCPtrpublic static long getCPtr(SimulatedScanner2DPtr obj) 
 - 
deletepublic void delete() 
 - 
derefpublic SimulatedScanner2D deref() The pointer stored in the object.
 - 
__ref__public SimulatedScanner2D __ref__() Dereferencing operator.
 - 
getDerefpublic SimulatedScanner2D getDeref() Member access operator.
 - 
equalspublic boolean equals(SimulatedScanner2D p) 
 - 
isSharedpublic 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.
 
 - 
isNullpublic boolean isNull() checks if the pointer is null- Returns:
- Returns true if the pointer is null
 
 - 
cptrpublic SimulatedScanner2DCPtr cptr() 
 - 
setFrameRatepublic void setFrameRate(double rate) set the framerate in frames per sec.- Parameters:
- rate- [in] frames per sec
 
 - 
openpublic void open() 
 - 
isOpenpublic boolean isOpen() 
 - 
closepublic void close() 
 - 
acquirepublic void acquire() 
 - 
isScanReadypublic boolean isScanReady() 
 - 
getRangepublic pair_d_d getRange() 
 - 
getFrameRatepublic double getFrameRate() 
 - 
getScanpublic PointCloud getScan() 
 - 
updatepublic void update(Simulator.UpdateInfo info, State state) 
 - 
resetpublic void reset(State state) 
 - 
getScanner2DSensorpublic Scanner2DPtr getScanner2DSensor(Simulator instance) returns a handle to what represents a statefull interface.
 The handle will be locked to the simulator- Returns:
 
 - 
getAngularRangepublic double getAngularRange() 
 - 
getMeasurementCountpublic long getMeasurementCount() 
 - 
getNamepublic java.lang.String getName() get name of this simulated sensor
 - 
getFramepublic Frame getFrame() get frame that this sensor is attached to.- Returns:
- frame
 
 - 
getSensorModelpublic SensorModelPtr getSensorModel() get the sensor model of this simulated sensor.
 - 
getSensorHandlepublic 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
 
 - 
registerInpublic 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.
 
 - 
registerInpublic void registerIn(StateStructurePtr state) register this stateless object in a statestructure.
 - 
unregisterpublic void unregister() unregisters all state data of this stateless object
 - 
getStateStructurepublic StateStructurePtr getStateStructure() Get the state structure.- Returns:
- the state structure.
 
 - 
isRegisteredpublic boolean isRegistered() Check if object has registered its state.- Returns:
- true if registered, false otherwise.
 
 
- 
 
-