urbi.UVar Class Reference

UVar class definition. More...

Inheritance diagram for urbi.UVar:

Collaboration diagram for urbi.UVar:

List of all members.

Public Types
enum	RtpMode { RTP_DEFAULT, RTP_YES, RTP_NO }
Public Member Functions
	UVar (long cPtr, boolean cMemoryOwn)
	UVar ()
	Creates an unbound UVar. Call init() to bind it.
	UVar (String arg0, UContextImpl arg1)
	Creates an unbound UVar. Call init() to bind it.
	UVar (String arg0)
	Creates an unbound UVar. Call init() to bind it.
	UVar (String arg0, String arg1, UContextImpl arg2)
	Creates an unbound UVar. Call init() to bind it.
	UVar (String arg0, String arg1)
	Creates an unbound UVar. Call init() to bind it.
	UVar (UObjectCPP arg0, String arg1, UContextImpl arg2)
	Creates an unbound UVar. Call init() to bind it.
	UVar (UObjectCPP arg0, String arg1)
	Creates an unbound UVar. Call init() to bind it.
	UVar (UVar arg0)
	Creates an unbound UVar. Call init() to bind it.
boolean	booleanValue ()
void	check ()
synchronized void	delete ()
double	doubleValue ()
boolean	get_local ()
UVar.RtpMode	get_rtp ()
boolean	get_temp ()
UVarImpl	getImpl_ ()
String	getName ()
boolean	getOwned ()
UValue	getProp (UProperty prop)
UValue	getUValue ()
void	init (String varname, UContextImpl arg1)
void	init (String varname)
void	init (String object, String slot, UContextImpl arg2)
void	init (String object, String slot)
int	intValue ()
void	keepSynchronized ()
	Keep this UVar synchronized with kernel value.
void	reset (double arg0)
void	set_local (boolean v)
void	set_rtp (UVar.RtpMode v)
void	set_temp (boolean v)
boolean	setBypass (boolean enable)
	Enable bypass-mode for this UVar.
boolean	setBypass ()
	Enable bypass-mode for this UVar.
void	setImpl_ (UVarImpl value)
void	setName (String name)
void	setOwned ()
void	setOwned (boolean value)
void	setProp (UProperty prop, UValue v)
void	setProp (UProperty prop, double v)
void	setProp (UProperty prop, String v)
UVar	setValue (double arg0)
UVar	setValue (String arg0)
UVar	setValue (UBinary arg0)
	Deep copy.
UVar	setValue (UImage i)
	Deep copy.
UVar	setValue (USound s)
	Deep copy.
UVar	setValue (UList l)
UVar	setValue (UDictionary d)
UVar	setValue (UValue v)
String	stringValue ()
void	syncValue ()
	Request the current value, wait until it is available.
long	timestamp ()
UDataType	type ()
	The type of the current content.
UBinary	ubinaryValue ()
UDictionary	udictionaryValue ()
UImage	uimageValue ()
UList	ulistValue ()
void	unnotify ()
	Deactivate all callbacks associated with this UVar and stop synchro.
void	useRTP (boolean enable)
	Use RTP mode to transmit this variable if possible.
void	useRTP ()
	Use RTP mode to transmit this variable if possible.
USound	usoundValue ()
UValue	val ()
Static Public Member Functions
static long	getCPtr (UVar obj)
Protected Member Functions
void	finalize ()

---

Detailed Description

UVar class definition.

Each UVar instance corresponds to one URBI variable. The class provides access to the variable properties, and reading/writing the value to/from all known types.

Definition at line 16 of file UVar.java.

---

Member Function Documentation

boolean urbi.UVar.setBypass

(

boolean

enable

)

Enable bypass-mode for this UVar.

Plugin-mode only. In bypass mode, if the UVar contains binary data, the data is never copied. The consequence is that the data is only accessible from notifyChange callbacks (urbiScript or C++): it is invalidated as soon as all callbacks have returned.

Definition at line 231 of file UVar.java.

boolean urbi.UVar.setBypass

(

)

Enable bypass-mode for this UVar.

Plugin-mode only. In bypass mode, if the UVar contains binary data, the data is never copied. The consequence is that the data is only accessible from notifyChange callbacks (urbiScript or C++): it is invalidated as soon as all callbacks have returned.

Definition at line 240 of file UVar.java.

---

The documentation for this class was generated from the following file:

• UVar.java