Package org.robwork.sdurw_pathplanning

Class QToQSamplerPlannerPtr

java.lang.Object

org.robwork.sdurw_pathplanning.QToQSamplerPlannerPtr

public class QToQSamplerPlannerPtr
extends java.lang.Object

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
QToQSamplerPlanner	__ref__()	Dereferencing operator.
QToQSamplerPlannerCPtr	cptr()
void	delete()
QToQSamplerPlanner	deref()	The pointer stored in the object.
boolean	equals(QToQSamplerPlanner p)
static long	getCPtr(QToQSamplerPlannerPtr obj)
QToQSamplerPlanner	getDeref()	Member access operator.
PropertyMap	getProperties()	Property map for the planner.
boolean	isNull()	checks if the pointer is null
boolean	isShared()	check if this Ptr has shared ownership or none ownership
boolean	query(Q from, QSampler to, SWIGTYPE_p_rw__trajectory__PathT_rw__math__Q_t path)	Plan a path from the configuration from to the destination to. The planner runs until it gives up (which may be never).
boolean	query(Q from, QSampler to, SWIGTYPE_p_rw__trajectory__PathT_rw__math__Q_t path, double time)	Plan a path from the configuration from to the destination to.
boolean	query(Q from, QSampler to, SWIGTYPE_p_rw__trajectory__PathT_rw__math__Q_t path, StopCriteria stop)	Plan a path from the configuration from to the destination to.

Methods inherited from class java.lang.Object

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

Constructor Detail

QToQSamplerPlannerPtr

public QToQSamplerPlannerPtr(long cPtr,
                             boolean cMemoryOwn)

QToQSamplerPlannerPtr

public QToQSamplerPlannerPtr()

Default constructor yielding a NULL-pointer.

QToQSamplerPlannerPtr

public QToQSamplerPlannerPtr(QToQSamplerPlanner ptr)

Do not take ownership of ptr.

ptr can be null.

The constructor is implicit on purpose.

Method Detail

getCPtr

public static long getCPtr(QToQSamplerPlannerPtr obj)

delete

public void delete()

deref

public QToQSamplerPlanner deref()

The pointer stored in the object.

__ref__

public QToQSamplerPlanner __ref__()

Dereferencing operator.

getDeref

public QToQSamplerPlanner getDeref()

Member access operator.

equals

public boolean equals(QToQSamplerPlanner 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 QToQSamplerPlannerCPtr cptr()

query

public boolean query(Q from,
                     QSampler to,
                     SWIGTYPE_p_rw__trajectory__PathT_rw__math__Q_t path,
                     StopCriteria stop)

Plan a path from the configuration from to the destination
to.

Parameters:

from - [in] start configuration for path.

to - [in] end destination of path.

path - [out] a collision free path connecting from to to.

stop - [in] Abort the planning when stop returns true.

Returns:

true if a path between from from to to was found and
false otherwise.

query

public boolean query(Q from,
                     QSampler to,
                     SWIGTYPE_p_rw__trajectory__PathT_rw__math__Q_t path,
                     double time)

Plan a path from the configuration from to the destination
to.

Parameters:

from - [in] start configuration for path.

to - [in] end destination of path.

path - [out] a collision free path connecting from to to.

time - [in] Abort the planning after time seconds.

Returns:

true if a path between from from to to was found and
false otherwise.

query

public boolean query(Q from,
                     QSampler to,
                     SWIGTYPE_p_rw__trajectory__PathT_rw__math__Q_t path)

Plan a path from the configuration from to the destination
to.

The planner runs until it gives up (which may be never).

Parameters:

from - [in] start configuration for path.

to - [in] end destination of path.

path - [out] a collision free path connecting from to to.

Returns:

true if a path between from from to to was found and
false otherwise.

getProperties

public PropertyMap getProperties()

Property map for the planner.