xmog_field_t< FieldType > Class Template Reference

A template type that is used to represent instance fields in generated proxy classes. More...

#include <xmog_java_field.h>

Inheritance diagram for xmog_field_t< FieldType >:

[legend]Collaboration diagram for xmog_field_t< FieldType >:

[legend]List of all members.

Public Member Functions
FieldType	operator * () const
	The dereference operator converts to the FieldType type.
	operator FieldType ()
	The non-constant conversion operator to template type.
	operator FieldType () const
	The constant conversion operator to template type.
FieldType	operator= (const xmog_null &_null_inst)
	The assignment from null operator.
FieldType	operator= (const FieldType &_inst)
	The assignment operator.
	xmog_field_t (xmog_java_ref *_inst, xmog_java_dynamic *_dynamic, xmog_flags _flags=xmog_base::GLOBAL)
	The constructor of a field template instance.

---

Detailed Description

template<class FieldType>
class xmog_field_t< FieldType >

A template type that is used to represent instance fields in generated proxy classes.

This template is used to prevent several problems related to instance fields. Its main characteristic is a conversion operator to its template argument type. This allows instances of this type to be used in every place where a right-hand-side instance of type FieldType is expected. The assignment operators enable left-hand-side use of instace fields, i.e. the assignment of new values into instance fields.

---

Constructor & Destructor Documentation

template<class FieldType> xmog_field_t< FieldType >::xmog_field_t (  xmog_java_ref *  _inst, xmog_java_dynamic *  _dynamic, xmog_flags  _flags = xmog_base::GLOBAL )  [inline]

The constructor of a field template instance. Parameters: _inst  the owner of the field. _dynamic  the field instance providing the instructions of how to access the field. _flags  the optional access flags. Defaults to GLOBAL.

---

Member Function Documentation

template<class FieldType> FieldType xmog_field_t< FieldType >::operator * (   )  const [inline]

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

template<class FieldType> FieldType xmog_field_t< FieldType >::operator= (  const xmog_null &  _null_inst  )  [inline]

The assignment from null operator. Parameters: _null_inst  null.

template<class FieldType> FieldType xmog_field_t< FieldType >::operator= (  const FieldType &  _inst  )  [inline]

The assignment operator. Parameters: _inst  the template argument type instance assigned to this field.

---

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

• xmog_java_field.h

---