Package org.robwork.sdurw_core

Class Property_f

java.lang.Object

org.robwork.sdurw_core.PropertyBase

org.robwork.sdurw_core.Property_f

public class Property_f
extends PropertyBase

Property class
The Property class is a template to support properties of any type. A Property
is characterized by a string identifier, string description and a value of the
template specified type.

Constructor Summary

Constructors

Constructor	Description
Property_f(long cPtr, boolean cMemoryOwn)
Property_f(java.lang.String identifier, java.lang.String description, float value)	Constructs Property. Constructs a Property and tries to auto detect the type.
Property_f(java.lang.String identifier, java.lang.String description, PropertyType type, float value)	Constructs Property.

Method Summary

Modifier and Type	Method	Description
PropertyBase	clone()	Construct a clone of the property.
void	delete()
static long	getCPtr(Property_f obj)
PropertyValueBase	getPropertyValue()	returns reference to the property value
SWIGTYPE_p_float	getValue()	Returns a reference to the property value. Note: Changing the value returned by reference will NOT fire the changed event.
void	setValue(float value)	Sets the property value. This function will fire the changed event.

Methods inherited from class org.robwork.sdurw_core.PropertyBase

getCPtr, getDescription, getIdentifier, getType, setDescription, setDescription

Methods inherited from class java.lang.Object

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

Constructor Detail

Property_f

public Property_f(long cPtr,
                  boolean cMemoryOwn)

Property_f

public Property_f(java.lang.String identifier,
                  java.lang.String description,
                  float value)

Constructs Property.

Constructs a Property and tries to auto detect the type.

Parameters:

identifier - [in] identifier

description - [in] description

value - [in] value

Property_f

public Property_f(java.lang.String identifier,
                  java.lang.String description,
                  PropertyType type,
                  float value)

Constructs Property.

Parameters:

identifier - [in] identifier

description - [in] description

type - [in] type of property

value - [in] value

Method Detail

getCPtr

public static long getCPtr(Property_f obj)

delete

public void delete()

Overrides:

delete in class PropertyBase

getValue

public SWIGTYPE_p_float getValue()

Returns a reference to the property value.

Note: Changing the value returned by reference will NOT fire the
changed event. Please consider using the setValue function if
possible, or fire the event manually on change, by calling
changedEvent().fire()

Returns:

reference to the property value.

getPropertyValue

public PropertyValueBase getPropertyValue()

returns reference to the property value

Overrides:

getPropertyValue in class PropertyBase

Returns:

value

setValue

public void setValue(float value)

Sets the property value.

This function will fire the changed event.

Parameters:

value - [in] the new value of the Property

clone

public PropertyBase clone()

Description copied from class: PropertyBase

Construct a clone of the property.

Overrides:

clone in class PropertyBase