Package org.robwork.sdurw_simulation
Class SimulatedSensorPtr
- java.lang.Object
-
- org.robwork.sdurw_simulation.SimulatedSensorPtr
-
public class SimulatedSensorPtr extends java.lang.Object
Ptr stores a pointer and optionally takes ownership of the value.
-
-
Constructor Summary
Constructors Constructor Description SimulatedSensorPtr()
Default constructor yielding a NULL-pointer.SimulatedSensorPtr(long cPtr, boolean cMemoryOwn)
SimulatedSensorPtr(SimulatedSensor 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 SimulatedSensor
__ref__()
Dereferencing operator.void
delete()
SimulatedSensor
deref()
The pointer stored in the object.boolean
equals(SimulatedSensor p)
static long
getCPtr(SimulatedSensorPtr obj)
SimulatedSensor
getDeref()
Member access operator.Frame
getFrame()
get frame that this sensor is attached to.java.lang.String
getName()
get name of this simulated sensorSensorPtr
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
isRegistered()
Check if object has registered its state.boolean
isShared()
check if this Ptr has shared ownership or none
ownershipvoid
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)
Resets the state of the SimulatedSensor to that of statevoid
unregister()
unregisters all state data of this stateless objectvoid
update(Simulator.UpdateInfo info, State state)
steps the the SimulatedSensor with time dt and saves any state
changes in state.
-
-
-
Constructor Detail
-
SimulatedSensorPtr
public SimulatedSensorPtr(long cPtr, boolean cMemoryOwn)
-
SimulatedSensorPtr
public SimulatedSensorPtr()
Default constructor yielding a NULL-pointer.
-
SimulatedSensorPtr
public SimulatedSensorPtr(SimulatedSensor ptr)
Do not take ownership of ptr.
ptr can be null.
The constructor is implicit on purpose.
-
-
Method Detail
-
getCPtr
public static long getCPtr(SimulatedSensorPtr obj)
-
delete
public void delete()
-
deref
public SimulatedSensor deref()
The pointer stored in the object.
-
__ref__
public SimulatedSensor __ref__()
Dereferencing operator.
-
getDeref
public SimulatedSensor getDeref()
Member access operator.
-
equals
public boolean equals(SimulatedSensor 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
-
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
-
update
public void update(Simulator.UpdateInfo info, State state)
steps the the SimulatedSensor with time dt and saves any state
changes in state.- Parameters:
info
- [in] update information related to the time step.state
- [out] changes of the SimulatedSensor is saved in state.
-
reset
public void reset(State state)
Resets the state of the SimulatedSensor to that of state- Parameters:
state
- [in] the state that the sensor is reset too.
-
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.
-
-