Package org.robwork.sdurw_proximity

Class ProximityModelPtr

java.lang.Object

org.robwork.sdurw_proximity.ProximityModelPtr

public class ProximityModelPtr
extends java.lang.Object

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ProximityModel	__ref__()	Dereferencing operator.
boolean	addGeometry(Geometry geom)	adds geometry
boolean	addGeometry(GeometryPtr geom)	adds geometry using pointer
boolean	addGeometry(GeometryPtr geom, boolean forceCopy)	adds geometry using pointer
ProximityModelCPtr	cptr()
void	delete()
ProximityModel	deref()	The pointer stored in the object.
boolean	equals(ProximityModel p)
static long	getCPtr(ProximityModelPtr obj)
ProximityModel	getDeref()	Member access operator.
Frame	getFrame()	return pointer to the associated frame
VectorGeometryPtr	getGeometries()	get the associated Geometries
vector_s	getGeometryIDs()	return vector of names for the geometries added to this ProximityModel
ProximityStrategy	getOwner()
boolean	isNull()	checks if the pointer is null
boolean	isShared()	check if this Ptr has shared ownership or none ownership
boolean	removeGeometry(java.lang.String geoid)	removes a geometry from the ProximityModel
void	setFrame(FramePtr frame)	sets the associated frame
void	setOwner(ProximityStrategy value)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProximityModelPtr

public ProximityModelPtr(long cPtr,
                         boolean cMemoryOwn)

ProximityModelPtr

public ProximityModelPtr()

Default constructor yielding a NULL-pointer.

ProximityModelPtr

public ProximityModelPtr(ProximityModel ptr)

Do not take ownership of ptr.

ptr can be null.

The constructor is implicit on purpose.

Method Detail

getCPtr

public static long getCPtr(ProximityModelPtr obj)

delete

public void delete()

deref

public ProximityModel deref()

The pointer stored in the object.

__ref__

public ProximityModel __ref__()

Dereferencing operator.

getDeref

public ProximityModel getDeref()

Member access operator.

equals

public boolean equals(ProximityModel 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 ProximityModelCPtr cptr()

getGeometryIDs

public vector_s getGeometryIDs()

return vector of names for the geometries added to this ProximityModel

getGeometries

public VectorGeometryPtr getGeometries()

get the associated Geometries

Returns:

a list of Geomety pointers beloninh to the model

addGeometry

public boolean addGeometry(Geometry geom)

adds geometry

Parameters:

geom - the geometry to add

addGeometry

public boolean addGeometry(GeometryPtr geom,
                           boolean forceCopy)

adds geometry using pointer

Parameters:

geom - [in] the geometry to add

forceCopy - [in]

addGeometry

public boolean addGeometry(GeometryPtr geom)

adds geometry using pointer

Parameters:

geom - [in] the geometry to add

removeGeometry

public boolean removeGeometry(java.lang.String geoid)

removes a geometry from the ProximityModel

Parameters:

geoid - name of geometry to remove

Returns:

bool

getFrame

public Frame getFrame()

return pointer to the associated frame

setFrame

public void setFrame(FramePtr frame)

sets the associated frame

Parameters:

frame - frame to set

setOwner

public void setOwner(ProximityStrategy value)

getOwner

public ProximityStrategy getOwner()