Voltage regulator
[Distribution flow solver (network), Transmission flow solver (network)]

Modules
	Regulator_configuration
Functions
int	regulator::create (void)
EXPORT int	create_regulator (OBJECT **obj, OBJECT *parent)
	REQUIRED: allocate and initialize an object.
int	regulator::init (void)
EXPORT int	init_regulator (OBJECT *obj)
	Object initialization is called once after all object have been created.
int	regulator::isa (char *classname)
EXPORT int	isa_regulator (OBJECT *obj, char *classname)
	regulator::regulator (MODULE *mod)
TIMESTAMP	regulator::sync (TIMESTAMP t0)
EXPORT TIMESTAMP	sync_regulator (OBJECT *obj, TIMESTAMP t0)
EXPORT TIMESTAMP	sync_regulator (OBJECT *obj, TIMESTAMP t0, PASSCONFIG pass)
	Sync is called when the clock needs to advance on the bottom-up pass (PC_BOTTOMUP).
Variables
static regulator *	regulator::defaults = NULL
static CLASS *	regulator::oclass = NULL
static CLASS *	regulator::pclass = NULL

---

Function Documentation

EXPORT int create_regulator	(	OBJECT **	obj,
		OBJECT *	parent
	)

REQUIRED: allocate and initialize an object.

Parameters:

	obj	a pointer to a pointer of the last object in the list
	parent	a pointer to the parent of this object

Returns:

1 for a successfully created object, 0 for error

Definition at line 193 of file regulator.cpp.

References create(), gl_create_object, gl_error, gl_set_parent, OBJECTDATA, and oclass.

EXPORT int init_regulator

(

OBJECT *

obj

)

Object initialization is called once after all object have been created.

Parameters:

parent

a pointer to this object's parent

Returns:

1 on success, 0 on error

Definition at line 218 of file regulator.cpp.

References powerflow_object::get_id(), powerflow_object::get_name(), GL_THROW, init(), and OBJECTDATA.

EXPORT TIMESTAMP sync_regulator	(	OBJECT *	obj,
		TIMESTAMP	t0,
		PASSCONFIG	pass
	)

Sync is called when the clock needs to advance on the bottom-up pass (PC_BOTTOMUP).

Parameters:

	t0	this objects current timestamp
	t1	the timestamp which the object should move forward to

Returns:

t2, where t2>t1 on success, t2=t1 for retry, t2<t1 on failure

Definition at line 238 of file regulator.cpp.

References s_object_list::clock, powerflow_object::get_id(), powerflow_object::get_name(), GL_THROW, OBJECTDATA, PC_BOTTOMUP, link::postsync(), and sync().

---

GridLAB-D^TM Version 1.0

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