Load objects represent static loads and export both voltages and current.
More...
Functions |
EXPORT int | create_load (OBJECT **obj, OBJECT *parent) |
| REQUIRED: allocate and initialize an object.
|
EXPORT int | init_load (OBJECT *obj) |
| Object initialization is called once after all object have been created.
|
EXPORT TIMESTAMP | sync_load (OBJECT *obj, TIMESTAMP t0, PASSCONFIG pass) |
| Sync is called when the clock needs to advance on the bottom-up pass (PC_BOTTOMUP).
|
Detailed Description
Load objects represent static loads and export both voltages and current.
Function Documentation
EXPORT int create_load |
( |
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 3147 of file load.cpp.
EXPORT int init_load |
( |
OBJECT * |
obj |
) |
|
Object initialization is called once after all object have been created.
- Parameters:
-
| obj | a pointer to the object to be initialized |
- Returns:
- 1 on success, 0 on error
Definition at line 3170 of file load.cpp.
EXPORT TIMESTAMP sync_load |
( |
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 3187 of file load.cpp.