HxmField Class

class hexaly.modeler.HxmField

An HxmField represents a field belonging to a modeler class. It can be used to get or set the value of a field on objects of the associated class.

Unlike properties, fields are always readable and writable. Furthermore, modifying or reading a field has no side-effects other than changing a value.

Since:

13.0

Summary

Methods

get

Returns the value of this field for the object given as parameter.

set

Sets the value of this field for the object given as parameter.

Instance methods

HxmField.get(obj)

Returns the value of this field for the object given as parameter. The object passed as parameter must be an instance of the class to which this field belongs.

Parameters:

obj – Object on which to retrieve the field value.

Returns:

The value of the field on the given object.

HxmField.set(obj, value)

Sets the value of this field for the object given as parameter. The object passed as parameter must be an instance of the class to which this field belongs.

This method accepts values of the following types:

Parameters:

  • obj (HxmValue) – Object on which to set the field value.

  • value – New value of the field.