Package org.robwork.sdurw_proximity

Class DistanceCalculatorCPtr

java.lang.Object

org.robwork.sdurw_proximity.DistanceCalculatorCPtr

public class DistanceCalculatorCPtr
extends java.lang.Object

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DistanceCalculator	__ref__()	Dereferencing operator.
void	delete()
DistanceCalculator	deref()	The pointer stored in the object.
DistanceStrategy.DistanceStrategyResult	distance(State state)	Calculates the distances between frames in the tree
DistanceStrategy.DistanceStrategyResult	distance(State state, FramePtr frame)	Calculates the distance between frame and the rest of the tree
DistanceStrategy.DistanceStrategyResult	distance(State state, FramePtr frame, DistanceStrategyResultVector result)	Calculates the distance between frame and the rest of the tree
DistanceStrategy.DistanceStrategyResult	distance(State state, DistanceStrategyResultVector result)	Calculates the distances between frames in the tree
DistanceStrategy.DistanceStrategyResult	distanceOMP(State state)
DistanceStrategy.DistanceStrategyResult	distanceOMP(State state, DistanceStrategyResultVector result)
boolean	equals(DistanceCalculator p)
static long	getCPtr(DistanceCalculatorCPtr obj)
DistanceCalculator	getDeref()	Member access operator.
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

DistanceCalculatorCPtr

public DistanceCalculatorCPtr(long cPtr,
                              boolean cMemoryOwn)

DistanceCalculatorCPtr

public DistanceCalculatorCPtr()

Default constructor yielding a NULL-pointer.

DistanceCalculatorCPtr

public DistanceCalculatorCPtr(DistanceCalculator ptr)

Do not take ownership of ptr.

ptr can be null.

The constructor is implicit on purpose.

Method Detail

getCPtr

public static long getCPtr(DistanceCalculatorCPtr obj)

delete

public void delete()

deref

public DistanceCalculator deref()

The pointer stored in the object.

__ref__

public DistanceCalculator __ref__()

Dereferencing operator.

getDeref

public DistanceCalculator getDeref()

Member access operator.

equals

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

distance

public DistanceStrategy.DistanceStrategyResult distance(State state,
                                                        DistanceStrategyResultVector result)

Calculates the distances between frames in the tree

Parameters:

state - [in] The state for which to calculate distances.

result - [out] If non-NULL, the distance results are written
to result.

Returns:

the shortest distance between frame and frame tree

distance

public DistanceStrategy.DistanceStrategyResult distance(State state)

Calculates the distances between frames in the tree

Parameters:

state - [in] The state for which to calculate distances.

Returns:

the shortest distance between frame and frame tree

distance

public DistanceStrategy.DistanceStrategyResult distance(State state,
                                                        FramePtr frame,
                                                        DistanceStrategyResultVector result)

Calculates the distance between frame and the rest of the tree

Parameters:

state - [in] The state for which to calculate distances.

frame - [in] The frame for which distances are to be calculated

result - [out] If non-NULL, the distance results are written
to result.

Returns:

the shortest distance between frame and frame tree

distance

public DistanceStrategy.DistanceStrategyResult distance(State state,
                                                        FramePtr frame)

Calculates the distance between frame and the rest of the tree

Parameters:

state - [in] The state for which to calculate distances.

frame - [in] The frame for which distances are to be calculated

Returns:

the shortest distance between frame and frame tree

distanceOMP

public DistanceStrategy.DistanceStrategyResult distanceOMP(State state,
                                                           DistanceStrategyResultVector result)

distanceOMP

public DistanceStrategy.DistanceStrategyResult distanceOMP(State state)