Package org.robwork.sdurw_sensor
Class SensorModelPtr
- java.lang.Object
-
- org.robwork.sdurw_sensor.SensorModelPtr
-
public class SensorModelPtr extends java.lang.Object
Ptr stores a pointer and optionally takes ownership of the value.
-
-
Constructor Summary
Constructors Constructor Description SensorModelPtr()
Default constructor yielding a NULL-pointer.SensorModelPtr(long cPtr, boolean cMemoryOwn)
SensorModelPtr(SensorModel 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 SensorModel
__ref__()
Dereferencing operator.void
attachTo(FramePtr frame)
Sets the frame to which the sensor should be attached
SensorModelCPtr
cptr()
void
delete()
SensorModel
deref()
The pointer stored in the object.boolean
equals(SensorModel p)
static long
getCPtr(SensorModelPtr obj)
SensorModel
getDeref()
Member access operator.java.lang.String
getDescription()
returns a description of this sensorFrame
getFrame()
The frame to which the sensor is attached.
The frame can be NULL.java.lang.String
getName()
returns the name of this sensorPropertyMap
getPropertyMap()
gets the propertymap of this sensorStateStructurePtr
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
setDescription(java.lang.String description)
sets the description of this sensorvoid
setName(java.lang.String name)
sets the name of this sensorvoid
unregister()
unregisters all state data of this stateless object
-
-
-
Constructor Detail
-
SensorModelPtr
public SensorModelPtr(long cPtr, boolean cMemoryOwn)
-
SensorModelPtr
public SensorModelPtr()
Default constructor yielding a NULL-pointer.
-
SensorModelPtr
public SensorModelPtr(SensorModel ptr)
Do not take ownership of ptr.
ptr can be null.
The constructor is implicit on purpose.
-
-
Method Detail
-
getCPtr
public static long getCPtr(SensorModelPtr obj)
-
delete
public void delete()
-
deref
public SensorModel deref()
The pointer stored in the object.
-
__ref__
public SensorModel __ref__()
Dereferencing operator.
-
getDeref
public SensorModel getDeref()
Member access operator.
-
equals
public boolean equals(SensorModel 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 SensorModelCPtr cptr()
-
setName
public void setName(java.lang.String name)
sets the name of this sensor- Parameters:
name
- [in] name of this sensor
-
setDescription
public void setDescription(java.lang.String description)
sets the description of this sensor- Parameters:
description
- [in] description of this sensor
-
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
-
getFrame
public Frame getFrame()
The frame to which the sensor is attached.
The frame can be NULL.
-
attachTo
public void attachTo(FramePtr frame)
Sets the frame to which the sensor should be attached
- Parameters:
frame
- The frame, which can be NULL
-
getPropertyMap
public PropertyMap getPropertyMap()
gets the propertymap of this sensor
-
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.
-
-