API Reference
The InterPSS API documentation provides comprehensive coverage of all classes, interfaces, and methods available in the InterPSS library.
Online API Documentation
📖 Browse Complete API Documentation
Quick Links
Core Modules
| Module | Description | Documentation |
|---|---|---|
| Core | Core power system analysis functionality | com.interpss.core |
| ACLF | AC Load Flow analysis | com.interpss.core.aclf |
| DC Analysis | DC load flow and sensitivity | com.interpss.dc |
| Optimal Power Flow | OPF algorithms | com.interpss.opf |
| Dynamic Stability | Transient stability analysis | com.interpss.dstab |
Key Factory Classes
- CoreObjectFactory - Main factory for creating core objects
- DclfAlgoObjectFactory - DC load flow algorithm factory
- DstabFactory - Dynamic stability object factory
Network Models
- AclfNetwork - AC load flow network model
- AclfBus - AC load flow bus model
- AclfBranch - AC load flow branch model
Algorithm Classes
- LoadflowAlgorithm - Load flow solver
- SenAnalysisAlgorithm - Sensitivity analysis (LODF, GSF)
- ContingencyAnalysisAlgorithm - Contingency analysis
Documentation Usage
The API documentation is generated using Javadoc and includes:
- Class hierarchies and inheritance relationships
- Method signatures with parameter types and return values
- Code examples and usage patterns
- Cross-references between related classes
- Search functionality for finding specific classes or methods
Getting Started
- Browse by package using the package list
- Search for classes using the alphabetical index
- Find specific methods using the search functionality
- Follow inheritance chains using the class hierarchy trees
Last updated: August 2025