Package org.robwork.sdurw_sensor

Class Scanner25DModelPtr

java.lang.Object

org.robwork.sdurw_sensor.Scanner25DModelPtr

public class Scanner25DModelPtr
extends java.lang.Object

Ptr stores a pointer and optionally takes ownership of the value.

Constructor Summary

Constructors

Constructor	Description
Scanner25DModelPtr()	Default constructor yielding a NULL-pointer.
Scanner25DModelPtr(long cPtr, boolean cMemoryOwn)
Scanner25DModelPtr(Scanner25DModel ptr)	Do not take ownership of ptr. ptr can be null. The constructor is implicit on purpose.

Method Summary

Modifier and Type	Method	Description
Scanner25DModel	__ref__()	Dereferencing operator.
void	attachTo(FramePtr frame)	Sets the frame to which the sensor should be attached
Scanner25DModelCPtr	cptr()
void	delete()
Scanner25DModel	deref()	The pointer stored in the object.
boolean	equals(Scanner25DModel p)
static long	getCPtr(Scanner25DModelPtr obj)
Scanner25DModel	getDeref()	Member access operator.
java.lang.String	getDescription()	returns a description of this sensor
Frame	getFrame()	The frame to which the sensor is attached. The frame can be NULL.
int	getHeight()	height of images taken with 25 sensor
java.lang.String	getName()	returns the name of this sensor
PropertyMap	getPropertyMap()	gets the propertymap of this sensor
pair_d_d	getRange()	get the min and maximum depth of this scanner in meters
PointCloud	getScan(State state)	get handle to point cloud data in state.
StateStructurePtr	getStateStructure()	Get the state structure.
int	getWidth()	width of images taken with 25 sensor
boolean	isNull()	checks if the pointer is null
boolean	isRegistered()	Check if object has registered its state.
boolean	isShared()	check if this Ptr has shared ownership or none ownership
void	registerIn(State state)	initialize this stateless data to a specific state
void	registerIn(StateStructurePtr state)	register this stateless object in a statestructure.
void	setDescription(java.lang.String description)	sets the description of this sensor
void	setName(java.lang.String name)	sets the name of this sensor
void	setRange(double min, double max)	set the min and maximum depth of this scanner in meters
void	setRange(pair_d_d range)	set the min and maximum depth of this scanner in meters
void	setScan(PointCloud data, State state)	set point cloud data in state
void	unregister()	unregisters all state data of this stateless object

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Scanner25DModelPtr

public Scanner25DModelPtr(long cPtr,
                          boolean cMemoryOwn)

Scanner25DModelPtr

public Scanner25DModelPtr()

Default constructor yielding a NULL-pointer.

Scanner25DModelPtr

public Scanner25DModelPtr(Scanner25DModel ptr)

Do not take ownership of ptr.

ptr can be null.

The constructor is implicit on purpose.

Method Detail

getCPtr

public static long getCPtr(Scanner25DModelPtr obj)

delete

public void delete()

deref

public Scanner25DModel deref()

The pointer stored in the object.

__ref__

public Scanner25DModel __ref__()

Dereferencing operator.

getDeref

public Scanner25DModel getDeref()

Member access operator.

equals

public boolean equals(Scanner25DModel 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 Scanner25DModelCPtr cptr()

getScan

public PointCloud getScan(State state)

get handle to point cloud data in state.

Parameters:

state - [in] the state with point cloud data

setScan

public void setScan(PointCloud data,
                    State state)

set point cloud data in state

Parameters:

data - [in] point cloud data to set

state - [in] state in which to set the point cloud

getWidth

public int getWidth()

width of images taken with 25 sensor

getHeight

public int getHeight()

height of images taken with 25 sensor

getRange

public pair_d_d getRange()

get the min and maximum depth of this scanner in meters

setRange

public void setRange(double min,
                     double max)

set the min and maximum depth of this scanner in meters

setRange

public void setRange(pair_d_d range)

set the min and maximum depth of this scanner in meters

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.