gridlabd::GridlabD Class Reference
List of all members.
Detailed Description
Provides an interface for the GridLAB-D core functionality and reflects what should be on the other side of the Java-C divide and contains a dictionary of the recognized property types within the core and a list of constants that are otherwise #DEFINE-ed.
Internal classes are used to maintain the modules, classes, properties, and objects published by Java modules.
A number of the long values that appear in the internal classes are pointers to memory allocated by the core. Tinkering with these values is a Bad Idea.
- Author:
- Matthew Hauer <matthew.hauer@pnl.gov>
- Version:
- 1.0
Definition at line 18 of file GridlabD.java.
|
Package Attributes |
| Enumeration< Class > | ec = ctable |
| | The inner Property class is used to cache published properties from classes in Java modules.
|
Member Data Documentation
The inner Property class is used to cache published properties from classes in Java modules.
Builds a Property object and registers it with the core.
- Parameters:
-
| n | Property name |
| t | Property type |
| o | Address of the object registering this property in the core |
- Returns:
- A new Property object. Null return on failure. Builds a Property object within the Java core. Not recommended since it does not work with the core. Internal use only. Contains the properties of GridLAB-D classes registered by Java modules and keys them in a HashTable by name.
- Deprecated:
- Use GClass instead of GridlabD.Class
Registers a new class with the GridLAB-D core.
- Parameters:
-
| n | Name of the new class |
| a | Address of the module this class is registering with. |
| sync | Bitfield of the sync phases for this class. |
- Returns:
- Null on error, Class object on success. Publishes a property in the GridLAB-D core for this class.
- Parameters:
-
| pname | Name of the property to publish |
| ptype | Name of the property type to publish |
- Returns:
- New Property on success, null pointer on error. Fetches a Property object by name from the Class's property table.
- Parameters:
-
| pname | Name of the property to be found. |
- Returns:
- A Property with the same property name, else null. The Module class tracks what classes have been added, and the address for the module in the core. By the time Java code is executed, the module has already been instantiated in the core, but will not have any classes or states registered.
- Deprecated:
- Use GModule instead of GridlabD.Module
Returns the core memory address of the first class that we registered.
- Returns:
- A pointer to the first CLASS registered for this module in the core.
Definition at line 223 of file GridlabD.java.
The documentation for this class was generated from the following file: