xmog_float Class Reference

A wrapper type for float proxies. This type wraps the Java float type in a proxy type that uses the JNI jfloat type to repesent the Java type. Conversion operators allow convenient usage while the get/set methods take an optional xmog_localenv argument for better performance (by saving at least a threadlocal memory access). More...

#include <xmog_java_field.h>

Inheritance diagram for xmog_float:

[legend]Collaboration diagram for xmog_float:

[legend]List of all members.

Public Member Functions
	xmog_float (xmog_java_array *_ref, jint _index)
	Creates an instance that acts as a proxy for an element of a float array.
	xmog_float (xmog_java_ref *_clazz_ref_array, xmog_java_dynamic *_dynamic, xmog_flags _flags=0)
	Creates an instance that acts as a proxy for an indirect element of float type.
	operator jfloat () const
	A conversion operator to the float type.
jfloat	operator * () const
	The dereference operator converts to the jfloat type.
xmog_float &	operator= (jfloat)
	An assignment operator from the jfloat type.
xmog_float &	operator+= (jfloat)
	The additive assignment operator from the jfloat type.
xmog_float &	operator-= (jfloat)
	The subtractive assignment operator from the jfloat type.
xmog_float &	operator *= (jfloat)
	The multiplicative assignment operator from the jfloat type.
xmog_float &	operator/= (jfloat)
	The divisive assignment operator from the jfloat type.
jfloat	get (xmog_localenv *env=NULL, bool readThrough=false) const
	Returns the value of a float proxy instance.
void	set (jfloat f, xmog_localenv *env=NULL, bool writeThrough=false)
	Sets the value of a float proxy.

---

Detailed Description

A wrapper type for float proxies. This type wraps the Java float type in a proxy type that uses the JNI jfloat type to repesent the Java type. Conversion operators allow convenient usage while the get/set methods take an optional xmog_localenv argument for better performance (by saving at least a threadlocal memory access).

---

Constructor & Destructor Documentation

xmog_float::xmog_float (  xmog_java_array *  _ref, jint  _index )

Creates an instance that acts as a proxy for an element of a float array. Parameters: _ref  a pointer to an array proxy element. _index  the index of the element.

xmog_float::xmog_float (  xmog_java_ref *  _clazz_ref_array, xmog_java_dynamic *  _dynamic, xmog_flags  _flags = 0 )

Creates an instance that acts as a proxy for an indirect element of float type. Parameters: _clazz_ref_array  a pointer to the owner of the primitive value. _dynamic  the algorithm to access the value. _flags  additional processing arguments.

---

Member Function Documentation

jfloat xmog_float::get (  xmog_localenv *  env = NULL, bool  readThrough = false )  const

Returns the value of a float proxy instance. This method takes two optional arguments that can be used to improve overall performance or force a read from the Java side even if a cached value is available. Parameters: env  a local environment pointer. May be NULL. readThrough  true if the value should be read from the Java side unconditionally, false if a cached value should be used if available. This flag is ignored if the instance does not use caching or if it does not yet have a cached value.

jfloat xmog_float::operator * (   )  const

The dereference operator converts to the jfloat type. This operator is declared to support array iterators.

xmog_float& xmog_float::operator *= (  jfloat   )

The multiplicative assignment operator from the jfloat type. This operator allows the use of proxy instances of this type in any place where the compiler expects a primitive jfloat lhs-value. You can achieve better performance by using the set(jbyte,xmog_localenv*,bool) method with the proper arguments.

xmog_float::operator jfloat (   )  const

A conversion operator to the float type. This operator allows the use of proxy instances of this type in any place where the compiler expects a primitive jfloat (float) rhs-value. You can achieve better performance by using the get(xmog_localenv*,bool) method with the proper arguments.

xmog_float& xmog_float::operator+= (  jfloat   )

The additive assignment operator from the jfloat type. This operator allows the use of proxy instances of this type in any place where the compiler expects a primitive jfloat lhs-value. You can achieve better performance by using the set(jbyte,xmog_localenv*,bool) method with the proper arguments.

xmog_float& xmog_float::operator-= (  jfloat   )

The subtractive assignment operator from the jfloat type. This operator allows the use of proxy instances of this type in any place where the compiler expects a primitive jfloat lhs-value. You can achieve better performance by using the set(jbyte,xmog_localenv*,bool) method with the proper arguments.

xmog_float& xmog_float::operator/= (  jfloat   )

The divisive assignment operator from the jfloat type. This operator allows the use of proxy instances of this type in any place where the compiler expects a primitive jfloat lhs-value. You can achieve better performance by using the set(jbyte,xmog_localenv*,bool) method with the proper arguments.

xmog_float& xmog_float::operator= (  jfloat   )

An assignment operator from the jfloat type. This operator allows the use of proxy instances of this type in any place where the compiler expects a primitive jfloat lhs-value. You can achieve better performance by using the set(jfloat,xmog_localenv*,bool) method with the proper arguments.

void xmog_float::set (  jfloat  f, xmog_localenv *  env = NULL, bool  writeThrough = false )

Sets the value of a float proxy. This method takes two optional arguments that can be used to improve overall performance or force a write to the Java side even if the CACHE_LAZY_WRITE policy is in effect for this instance. Parameters: f  the new value. env  a local environment pointer. May be NULL. writeThrough  true if the value should be written to the Java side unconditionally, false if only the cached value should be updated. This flag is ignored if the instance does not use caching.

---

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

• xmog_java_field.h

---