Property management
[Runtime module API]

---

Detailed Description

Use the property management functions to provide and gain access to published variables from other modules.

This include getting property information and unit conversion.

Defines
#define	gl_convert   (*callback->unit_convert)
	Convert the units of a property using unit name.
#define	gl_convert_ex   (*callback->unit_convert_ex)
	Convert the units of a property using unit data.
#define	gl_get_complex   (*callback->objvar.complex_var)
	Retrieve the complex value associated with the property.
#define	gl_get_complex_by_name   (*callback->objvarname.complex_var)
#define	gl_get_double   (*callback->objvar.double_var)
#define	gl_get_double_by_name   (*callback->objvarname.double_var)
#define	gl_get_int16   (*callback->objvar.int16_var)
#define	gl_get_int16_by_name   (*callback->objvarname.int16_var)
#define	gl_get_int32   (*callback->objvar.int32_var)
#define	gl_get_int32_by_name   (*callback->objvarname.int32_var)
#define	gl_get_int64   (*callback->objvar.int64_var)
#define	gl_get_int64_by_name   (*callback->objvarname.int64_var)
#define	gl_get_object   (*callback->get_object)
#define	gl_get_object_prop   (*callback->objvar.object_var)
#define	gl_get_property   (*callback->properties.get_property)
	Get a property of an object.
#define	gl_get_reference   (*callback->properties.get_reference)
	Get a reference to another object.
#define	gl_get_string   (*callback->objvar.string_var)
#define	gl_get_string_by_name   (*callback->objvarname.string_var)
#define	gl_get_unit   (*callback->properties.get_unit)
	Get unit of property.
#define	gl_get_value   (*callback->properties.get_value_by_addr)
	Get the value of a property in an object.
#define	gl_get_value_by_name   (*callback->properties.get_value_by_name)
	Get the value of a property in an object.
#define	gl_publish_delegate   (*callback->define_type)
	Publish an delegate property type for a class.
#define	gl_register_type   (*callback->register_type)
	Create an object.
#define	gl_set_value   (*callback->properties.set_value_by_addr)
	Set the value of a property in an object.
#define	gl_set_value_by_name   (*callback->properties.set_value_by_name)
	Set the value of a property in an object.

---

Define Documentation

#define gl_convert   (*callback->unit_convert)

Convert the units of a property using unit name.

See also:

unit_convert()

Definition at line 511 of file gridlabd.h.

Referenced by climate::init(), and climate_module_test::test_tmy2().

#define gl_convert_ex   (*callback->unit_convert_ex)

Convert the units of a property using unit data.

See also:

unit_convert_ex()

Definition at line 516 of file gridlabd.h.

#define gl_get_complex   (*callback->objvar.complex_var)

Retrieve the complex value associated with the property.

See also:

object_get_complex()

Definition at line 525 of file gridlabd.h.

#define gl_get_property   (*callback->properties.get_property)

Get a property of an object.

See also:

object_get_property()

Definition at line 450 of file gridlabd.h.

Referenced by create_player(), create_recorder(), house::get_complex(), machine::init(), office::init(), house::init_climate(), link_properties(), sync_player(), sync_shaper(), plc_module_test::test_create(), and climate_module_test::test_create().

#define gl_get_reference   (*callback->properties.get_reference)

Get a reference to another object.

See also:

object_get_reference()

Definition at line 483 of file gridlabd.h.

#define gl_get_unit   (*callback->properties.get_unit)

Get unit of property.

See also:

object_get_unit()

Definition at line 506 of file gridlabd.h.

#define gl_get_value   (*callback->properties.get_value_by_addr)

Get the value of a property in an object.

See also:

object_get_value_by_addr()

Definition at line 464 of file gridlabd.h.

Referenced by read_properties().

#define gl_get_value_by_name   (*callback->properties.get_value_by_name)

Get the value of a property in an object.

See also:

object_get_value_by_name()

Definition at line 495 of file gridlabd.h.

#define gl_publish_delegate   (*callback->define_type)

Publish an delegate property type for a class.

Note:

This is not supported in Version 1.

Definition at line 440 of file gridlabd.h.

#define gl_register_type   (*callback->register_type)

Create an object.

See also:

class_register()

Definition at line 435 of file gridlabd.h.

Referenced by generator::generator().

#define gl_set_value   (*callback->properties.set_value_by_addr)

Set the value of a property in an object.

See also:

object_set_value_by_addr()

Definition at line 477 of file gridlabd.h.

Referenced by sync_player().

#define gl_set_value_by_name   (*callback->properties.set_value_by_name)

Set the value of a property in an object.

See also:

object_set_value_by_name()

Definition at line 501 of file gridlabd.h.

---

GridLAB-D^TM Version 1.0

An open-source project initiated by the US Department of Energy