Package org.robwork.sdurw_sensor

Class Scanner2DModelCPtr

java.lang.Object

org.robwork.sdurw_sensor.Scanner2DModelCPtr

public class Scanner2DModelCPtr
extends java.lang.Object

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Scanner2DModel	__ref__()	Dereferencing operator.
void	delete()
Scanner2DModel	deref()	The pointer stored in the object.
boolean	equals(Scanner2DModel p)
pair_d_d	getAngularRange()	Returns the min and max angular range of the scanner, where the angles represent the beginning and end of scanning in the z-x plane. Hence, angles represent rotation of z-axis around the y-axis.
static long	getCPtr(Scanner2DModelCPtr obj)
Scanner2DModel	getDeref()	Member access operator.
java.lang.String	getDescription()	returns a description of this sensor
pair_d_d	getDistanceRange()	get the min an max range in meters that is scannable by the 2D scanner
Frame	getFrame()	The frame to which the sensor is attached. The frame can be NULL.
long	getMeasurementCount()	Returns the number of scan points
java.lang.String	getName()	returns the name of this sensor
boolean	isNull()	checks if the pointer is null
boolean	isShared()	check if this Ptr has shared ownership or none ownership

Methods inherited from class java.lang.Object

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

Constructor Detail

Scanner2DModelCPtr

public Scanner2DModelCPtr(long cPtr,
                          boolean cMemoryOwn)

Scanner2DModelCPtr

public Scanner2DModelCPtr()

Default constructor yielding a NULL-pointer.

Scanner2DModelCPtr

public Scanner2DModelCPtr(Scanner2DModel ptr)

Do not take ownership of ptr.

ptr can be null.

The constructor is implicit on purpose.

Method Detail

getCPtr

public static long getCPtr(Scanner2DModelCPtr obj)

delete

public void delete()

deref

public Scanner2DModel deref()

The pointer stored in the object.

__ref__

public Scanner2DModel __ref__()

Dereferencing operator.

getDeref

public Scanner2DModel getDeref()

Member access operator.

equals

public boolean equals(Scanner2DModel 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

getAngularRange

public pair_d_d getAngularRange()

Returns the min and max angular range of the scanner, where
the angles represent the beginning and end of scanning in the z-x plane.
Hence, angles represent rotation of z-axis around the y-axis. Normally range would
be something like -170 to 170 degree for a Hokyo or Sick scanner

Returns:

Angular range in radians

getMeasurementCount

public long getMeasurementCount()

Returns the number of scan points

getDistanceRange

public pair_d_d getDistanceRange()

get the min an max range in meters that is scannable by the 2D scanner

Returns:

range in meters

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.