Package org.robwork.sdurw_core

Class PropertyBasePtr

java.lang.Object

org.robwork.sdurw_core.PropertyBasePtr

public class PropertyBasePtr
extends java.lang.Object

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
PropertyBase	__ref__()	Dereferencing operator.
PropertyBase	clone()	Construct a clone of the property.
PropertyBaseCPtr	cptr()
void	delete()
PropertyBase	deref()	The pointer stored in the object.
boolean	equals(PropertyBase p)
static long	getCPtr(PropertyBasePtr obj)
PropertyBase	getDeref()	Member access operator.
java.lang.String	getDescription()	Returns description
java.lang.String	getIdentifier()	Returns the Property identifier
PropertyValueBase	getPropertyValue()	returns reference to the property value
PropertyType	getType()	Returns the PropertyType
boolean	isNull()	checks if the pointer is null
boolean	isShared()	check if this Ptr has shared ownership or none ownership
void	setDescription(java.lang.String desc)	Set description.
void	setDescription(java.lang.String desc, boolean fireChangedEvent)	Set description.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyBasePtr

public PropertyBasePtr(long cPtr,
                       boolean cMemoryOwn)

PropertyBasePtr

public PropertyBasePtr()

Default constructor yielding a NULL-pointer.

PropertyBasePtr

public PropertyBasePtr(PropertyBase ptr)

Do not take ownership of ptr.

ptr can be null.

The constructor is implicit on purpose.

Method Detail

getCPtr

public static long getCPtr(PropertyBasePtr obj)

delete

public void delete()

deref

public PropertyBase deref()

The pointer stored in the object.

__ref__

public PropertyBase __ref__()

Dereferencing operator.

getDeref

public PropertyBase getDeref()

Member access operator.

equals

public boolean equals(PropertyBase 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 PropertyBaseCPtr cptr()

getIdentifier

public java.lang.String getIdentifier()

Returns the Property identifier

Returns:

string identifier

getDescription

public java.lang.String getDescription()

Returns description

Returns:

string description

setDescription

public void setDescription(java.lang.String desc,
                           boolean fireChangedEvent)

Set description.

Parameters:

desc - [in] the new description.

fireChangedEvent - [in] (optional) fire changed event.

setDescription

public void setDescription(java.lang.String desc)

Set description.

Parameters:

desc - [in] the new description.

clone

public PropertyBase clone()

Construct a clone of the property.

getPropertyValue

public PropertyValueBase getPropertyValue()

returns reference to the property value

Returns:

value

getType

public PropertyType getType()

Returns the PropertyType

Returns:

the PropertyType