Relay
[Distribution flow solver (radial)]

---

Detailed Description

Implements a relay object.

Functions
EXPORT int	create_relay (OBJECT **obj, OBJECT *parent)
	REQUIRED: allocate and initialize an object.
EXPORT int	init_relay (OBJECT *obj)
	Object initialization is called once after all object have been created.
EXPORT TIMESTAMP	sync_relay (OBJECT *obj, TIMESTAMP t0, PASSCONFIG pass)
	Sync is called when the clock needs to advance on the bottom-up pass (PC_BOTTOMUP).

---

Function Documentation

EXPORT int create_relay	(	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 273 of file relay.cpp.

References relay::create(), gl_create_object, gl_error, gl_set_parent, and OBJECTDATA.

EXPORT int init_relay

(

OBJECT *

obj

)

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

Parameters:

obj

a pointer to this object

Returns:

1 on success, 0 on error

Definition at line 312 of file relay.cpp.

References GL_THROW, relay::init(), and OBJECTDATA.

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

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

Parameters:

	obj	the object we are sync'ing
	t0	this objects current timestamp
	pass	the current pass for this sync call

Returns:

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

Definition at line 333 of file relay.cpp.

References GL_THROW, OBJECTDATA, PC_BOTTOMUP, PC_POSTTOPDOWN, PC_PRETOPDOWN, relay::postsync(), link::presync(), and relay::sync().