Crate powerio_capi

Expand description

PowerIO C ABI, version 7.

The ABI exposes the same four representation operations as Rust: pio_parse, pio_emit, pio_module_serialize, and pio_module_deserialize. Files and memory enter through PioSource; files, directories, and memory output use PioDestination. Values are identified by canonical structural type names rather than an ordinal enum.

Modules§

diagnostics: The codes the language boundary itself emits, and the workspace gates.

Structs§

PioAcBusSpecificationView: One bus boundary specification in an AC power flow instance.
PioAcDcConverterView: One source neutral AC/DC converter.
PioAcOpfBranchView: One active branch row in an AC OPF preparation.
PioAcOpfBusView: One dense bus row in an AC OPF preparation.
PioAcOpfGeneratorView: One generator row in an AC OPF preparation.
PioAcOpfPreparation: Owned AC OPF preparation whose borrowed row views remain valid until release.
PioAcOpfPreparationView: Shape and conventions of one prepared AC OPF calculation.
PioAcOpfStorageView: One storage row in an AC OPF preparation.
PioActiveConstraintView: One active constraint family and its element selection.
PioActiveControlView: One active multiconductor equipment control.
PioActivePower: Active power replacement with an explicit unit.
PioActivePowerControlView: Governor and distributed slack settings for a generator or storage element.
PioApparentPower: Apparent power replacement with an explicit unit.
PioArtifact: Owner-rooted emitted artifact.
PioBalancedAreaView: One balanced control area.
PioBalancedBranchView: One balanced branch or two winding transformer.
PioBalancedBusView: One balanced bus. String and coefficient spans borrow from the network.
PioBalancedGeneratorView: One balanced generator.
PioBalancedGeoView: Coordinate metadata for a balanced network.
PioBalancedHvdcConverterView: One AC terminal converter station of a balanced HVDC line.
PioBalancedHvdcView: One balanced two terminal HVDC line.
PioBalancedLoadView: One balanced load.
PioBalancedLoadVoltageModelView: Voltage dependence attached to one balanced load.
PioBalancedLocationView: One point in a balanced network coordinate space.
PioBalancedNetwork: Owner-rooted balanced network view.
PioBalancedShuntView: One balanced shunt.
PioBalancedStaticVarCompensatorView: One balanced static VAR compensator.
PioBalancedStorageView: One balanced storage element.
PioBalancedSwitchView: One balanced transmission switch.
PioBalancedThreeWindingTransformerView: One balanced three winding transformer.
PioBoundaryLineGenerationView: Optional generation attached to one PowSybl boundary line.
PioBoundaryLineView: One PowSybl boundary line retained beside the balanced calculation view.
PioBranchRatingView: One named branch MVA rating beyond rating A, B, and C.
PioBusBreakerBusView: One configured bus in bus breaker topology.
PioBusbarSectionView: One source neutral busbar section.
PioByteView: Borrowed binary bytes.
PioCalculatedBusView: One calculated bus explicitly recorded in node breaker topology.
PioCalculationInstance: Owner-rooted calculation instance view.
PioCalculationSolution: Owner-rooted calculation solution view.
PioCalculationUpdate: Typed update to a calculation instance.
PioCaseMetadataView: Source neutral case metadata attached to one subnetwork.
PioComponentAliasView: One source neutral component alias.
PioComponentId: Stable, type-qualified component identity.
PioComponentIdView: Borrowed stable component identity.
PioComponentMetadataView: Source neutral metadata attached to one stable component identity.
PioConnectivityNodeView: One source neutral connectivity node.
PioControlProfileView: One inverter control profile.
PioDcBusSpecificationView: One bus boundary specification in a DC power flow instance.
PioDcConverterUnitView: One source neutral DC converter unit.
PioDcEquipmentView: One source neutral DC conducting equipment record.
PioDcNodeView: One physical or energized node in source neutral DC connectivity.
PioDcOpfBranchView: One active branch row in a DC OPF preparation.
PioDcOpfBusView: One dense bus row in a DC OPF preparation.
PioDcOpfGeneratorView: One generator row in a DC OPF preparation.
PioDcOpfPreparation: Owned DC OPF preparation whose borrowed row views remain valid until release.
PioDcOpfPreparationView: Shape and conventions of one prepared DC OPF calculation.
PioDcTerminalView: One terminal of source neutral DC conducting equipment.
PioDestination: File, directory, or memory output destination.
PioDetailedConnectivity: Owner-rooted source neutral hierarchy and detailed connectivity view.
PioDetailedConnectivityCountsView: Exact table lengths in source neutral detailed connectivity.
PioDetailedTerminalView: One source neutral AC terminal.
PioDiagnosticSpanView: One borrowed source byte range from a diagnostic.
PioDiagnostics: Immutable diagnostic list.
PioDroopCurveSegmentView: One segment of an AC/DC converter DC voltage droop curve.
PioEmitResult: Completed artifact inventory and emission diagnostics.
PioEquipmentReactiveLimitsView: Reactive limits retained for one equipment record.
PioError: Structured operation failure.
PioExternalIdentifierView: One source neutral external component identifier.
PioF64View: Borrowed double values.
PioGeneratorCapabilityView: One optional generator capability or ramp field.
PioGeneratorCostView: One generator cost curve.
PioGeoApplyReport: Counts and notes from applying one geographic layer.
PioGeoLayer: Parsed geographic sidecar.
PioInternalConnectionView: One permanent connection between two node breaker connectivity nodes.
PioInverterBasedResourceView: One inverter based resource.
PioIsolatedTerminalView: One isolated multiconductor terminal.
PioJsonObjectEntryView: One key and value type in a structured JSON object.
PioJsonValue: Owner-rooted structured value from module history or extensions.
PioJsonValueView: One structured JSON value stored in module history or extensions.
PioJunctionView: One source neutral CIM junction.
PioModule: PowerIO value with diagnostics, source mappings, and history.
PioModuleExtensionView: One namespaced structured module extension.
PioModuleHistoryEntryView: One operation recorded in module history.
PioModuleHistoryParameterView: One named structured parameter in a module history entry.
PioModuleProducerView: Program identity recorded with one module.
PioModuleSourceMapEntryView: One typed value target and its relation to source bytes.
PioModuleSourceView: One durable source descriptor recorded with a module.
PioMulticonductorBusView: One multiconductor bus.
PioMulticonductorCapacitorView: One multiconductor capacitor.
PioMulticonductorCommandView: One retained source command.
PioMulticonductorGeneratorView: One multiconductor generator.
PioMulticonductorGeoView: Coordinate metadata for a multiconductor network.
PioMulticonductorLineCodeView: One multiconductor line code.
PioMulticonductorLineView: One multiconductor line.
PioMulticonductorLoadView: One multiconductor load.
PioMulticonductorLocationView: One point in a multiconductor network coordinate space.
PioMulticonductorNetwork: Owner-rooted multiconductor network view.
PioMulticonductorNetworkCountsView: Exact table lengths in a multiconductor network.
PioMulticonductorShuntView: One multiconductor shunt.
PioMulticonductorSwitchView: One multiconductor switch.
PioMulticonductorTransformerView: One multiconductor transformer.
PioMulticonductorTransformerWindingView: One winding of a multiconductor transformer.
PioMulticonductorUntypedObjectView: One source object retained without a typed PowerIO representation.
PioMulticonductorUntypedPropertyView: One property of an untyped source object.
PioNetworkUpdate: Typed update to physical network data.
PioObjectiveTermView: One typed objective term.
PioOmittedFieldView: One source field that was absent rather than explicitly assigned a value.
PioOperatingPoint: Owner-rooted operating point view.
PioOperatingPointUpdate: Typed update to an operating point.
PioOperationalLimitGroupView: One named source neutral loading limit set at an equipment terminal.
PioPrescribedSourceVoltageView: One prescribed multiconductor source terminal voltage.
PioPrescribedTerminalPowerView: One prescribed multiconductor load terminal power.
PioReactiveCapabilityCurvePointView: One point of a reactive capability curve.
PioReactiveLimitsView: Min/max or active power dependent reactive limits.
PioReactivePower: Reactive power replacement with an explicit unit.
PioScenarioSetHandle: Owner-rooted scenario set view.
PioScucActiveReservePeriodView: One period of an active power reserve zone.
PioScucActiveReserveZoneView: One active power reserve zone.
PioScucBranchSwitchingCostView: Connection and disconnection costs for one switchable AC branch.
PioScucContingencyComponentView: One component removed by a SCUC contingency.
PioScucContingencyView: One named SCUC contingency.
PioScucDevicePeriodView: One SCUC device period.
PioScucDeviceView: One SCUC producer or consumer.
PioScucDimensionsView: Set sizes and time horizon of one AC SCUC instance.
PioScucEnergyCostBlockView: One piecewise linear active energy cost block.
PioScucEnergyRequirementView: One energy requirement over a time window, in per unit as defined by GOC3.
PioScucInitialCommitmentView: Initial commitment durations for one SCUC device.
PioScucRampLimitsView: Active power ramp limits for one SCUC device, in per unit per hour.
PioScucReactiveCapabilityView: Additional active and reactive power capability relation for one device.
PioScucReactiveReservePeriodView: One period of a reactive power reserve zone.
PioScucReactiveReserveZoneView: One reactive power reserve zone.
PioScucReserveCostsView: Reserve costs for one device and one interval, in $/(p.u. h).
PioScucReserveLimitsView: Reserve quantity limits for one SCUC device.
PioScucShuntView: Discrete step limits for one SCUC shunt.
PioScucStartupCostAdjustmentView: One downtime dependent startup cost adjustment.
PioScucStartupLimitView: One limit on the number of device startups during a time window.
PioScucTransformerControlView: Tap ratio and phase shift bounds for one transformer.
PioScucViolationCostView: Required SCUC violation costs.
PioShuntBlockView: One switched shunt block.
PioSizeView: Borrowed size_t values.
PioSource: Acquired file, directory, or named memory bytes.
PioSourceSpanView: One borrowed source byte range from a source map entry.
PioSparseMatrix: Immutable CSR sparse matrix.
PioString: Owned UTF-8 text returned by report functions.
PioStringPropertyView: One source neutral string property.
PioStringView: Borrowed UTF-8 bytes. The bytes need not end in NUL.
PioSubnetworkView: One PowSybl subnetwork contained directly by the balanced network.
PioSubstationView: One source neutral substation.
PioTapChangerStepView: One source neutral transformer tap changer step.
PioTapChangerView: One source neutral transformer tap changer.
PioTemporaryLimitView: One temporary source neutral loading limit.
PioTerminalPowerView: One terminal of a prescribed multiconductor load.
PioTerminalReferenceView: Borrowed reference to one numbered equipment terminal.
PioTerminalVoltageView: One terminal of a prescribed multiconductor source.
PioThreeWindingTransformerImpedanceView: One pairwise impedance of a balanced three winding transformer.
PioThreeWindingTransformerWindingView: One winding of a balanced three winding transformer.
PioTieLineView: One PowSybl tie line and the two boundary lines that define it.
PioTimeSeriesHandle: Owner-rooted time series view.
PioTopologySwitchView: One source neutral bus breaker or node breaker switch.
PioTransformerControlView: Automatic transformer tap or phase control.
PioUpdateChange: Owner-rooted view of one changed component field.
PioUpdateReport: Exact changes made by one atomic update batch.
PioValueHandle: Owner-rooted view of one module or collection value.
PioVector: Immutable dense vector.
PioVoltageLevelView: One source neutral voltage level.
PioVoltageSourceView: One multiconductor voltage source.

Constants§

PIO_ABI_VERSION: C ABI version.

Functions§

pio_abi_version: Return the ABI number compiled into this library.
pio_ac_opf_preparation_branch_at^⚠: Read one active branch row of an AC OPF preparation.
pio_ac_opf_preparation_bus_at^⚠: Read one dense bus row of an AC OPF preparation.
pio_ac_opf_preparation_generator_at^⚠: Read one generator row of an AC OPF preparation.
pio_ac_opf_preparation_reference_buses^⚠: Borrow the dense reference bus indices of an AC OPF preparation.
pio_ac_opf_preparation_release^⚠
pio_ac_opf_preparation_retain^⚠
pio_ac_opf_preparation_skipped_zero_impedance^⚠: Borrow the analysis rows skipped for zero impedance.
pio_ac_opf_preparation_storage_at^⚠: Read one storage row of an AC OPF preparation.
pio_ac_opf_preparation_summary^⚠: Read the dimensions and conventions of an AC OPF preparation.
pio_ac_pf_instance_bus_specification_at^⚠: Read one AC power flow bus specification by zero based bus table position.
pio_ac_pf_instance_bus_specification_count^⚠
pio_ac_scuc_instance_active_reserve_zone_at^⚠
pio_ac_scuc_instance_active_reserve_zone_bus_at^⚠
pio_ac_scuc_instance_active_reserve_zone_count^⚠
pio_ac_scuc_instance_active_reserve_zone_period_at^⚠
pio_ac_scuc_instance_branch_switching_cost_at^⚠
pio_ac_scuc_instance_branch_switching_cost_count^⚠
pio_ac_scuc_instance_contingency_at^⚠: Read one named contingency in source order.
pio_ac_scuc_instance_contingency_component_at^⚠: Read one stable component identity from a named contingency.
pio_ac_scuc_instance_contingency_count^⚠: Return the number of named contingencies.
pio_ac_scuc_instance_contingency_get^⚠: Read one named contingency by its exact source UID.
pio_ac_scuc_instance_device_at^⚠
pio_ac_scuc_instance_device_count^⚠
pio_ac_scuc_instance_device_energy_cost_block_at^⚠
pio_ac_scuc_instance_device_energy_cost_block_count^⚠
pio_ac_scuc_instance_device_energy_lower_bound_at^⚠
pio_ac_scuc_instance_device_energy_lower_bound_count^⚠
pio_ac_scuc_instance_device_energy_upper_bound_at^⚠
pio_ac_scuc_instance_device_energy_upper_bound_count^⚠
pio_ac_scuc_instance_device_get^⚠: Read one device by its exact source UID.
pio_ac_scuc_instance_device_period_at^⚠
pio_ac_scuc_instance_device_startup_cost_adjustment_at^⚠
pio_ac_scuc_instance_device_startup_cost_adjustment_count^⚠
pio_ac_scuc_instance_device_startup_limit_at^⚠
pio_ac_scuc_instance_device_startup_limit_count^⚠
pio_ac_scuc_instance_dimensions^⚠: Read semantic collection sizes for one AC SCUC instance.
pio_ac_scuc_instance_interval_durations^⚠: Borrow interval durations in hours, in chronological order.
pio_ac_scuc_instance_reactive_reserve_zone_at^⚠
pio_ac_scuc_instance_reactive_reserve_zone_bus_at^⚠
pio_ac_scuc_instance_reactive_reserve_zone_count^⚠
pio_ac_scuc_instance_reactive_reserve_zone_period_at^⚠
pio_ac_scuc_instance_shunt_at^⚠
pio_ac_scuc_instance_shunt_count^⚠
pio_ac_scuc_instance_shunt_get^⚠: Read one shunt by its exact source UID.
pio_ac_scuc_instance_transformer_control_at^⚠
pio_ac_scuc_instance_transformer_control_count^⚠
pio_ac_scuc_instance_violation_costs^⚠: Read the four required violation costs.
pio_ac_scuc_solution_get_values_at^⚠: Copy one AC SCUC output row for one time position into an owned vector.
pio_ac_scuc_solution_time_count^⚠
pio_active_power_from_megawatts
pio_active_power_from_watts
pio_active_power_release^⚠
pio_active_power_retain^⚠
pio_active_power_unit^⚠
pio_active_power_value^⚠
pio_apparent_power_from_megavolt_amperes
pio_apparent_power_from_volt_amperes
pio_apparent_power_release^⚠
pio_apparent_power_retain^⚠
pio_apparent_power_unit^⚠
pio_apparent_power_value^⚠
pio_apply_bus_load_active_power^⚠: Replace aggregate active demand at one bus using the named allocation rule.
pio_apply_updates^⚠: Apply a complete typed update batch atomically.
pio_artifact_bytes^⚠: Return emitted memory bytes. A path destination has no memory bytes and returns an empty view.
pio_artifact_name^⚠
pio_artifact_release^⚠
pio_artifact_retain^⚠
pio_balanced_network_area_at^⚠: Read one control area by zero based table position.
pio_balanced_network_area_count^⚠
pio_balanced_network_base_frequency_hz^⚠
pio_balanced_network_base_mva^⚠
pio_balanced_network_branch_at^⚠: Read one branch by zero based table position.
pio_balanced_network_branch_count^⚠
pio_balanced_network_branch_rating_at^⚠: Read one additional named branch MVA rating.
pio_balanced_network_branch_route_point_at^⚠: Read one point from an explicitly stored balanced branch route.
pio_balanced_network_bus_at^⚠: Read one bus by zero based table position.
pio_balanced_network_bus_count^⚠
pio_balanced_network_detailed_connectivity^⚠: Return the optional owner-rooted detailed connectivity view.
pio_balanced_network_generator_at^⚠: Read one generator by zero based table position.
pio_balanced_network_generator_capability_at^⚠: Read one named generator capability or ramp field.
pio_balanced_network_generator_count^⚠
pio_balanced_network_geo^⚠: Read the optional coordinate space metadata for a balanced network.
pio_balanced_network_has_detailed_connectivity^⚠
pio_balanced_network_hvdc_at^⚠: Read one HVDC line by zero based table position.
pio_balanced_network_hvdc_count^⚠
pio_balanced_network_load_at^⚠: Read one load by zero based table position.
pio_balanced_network_load_count^⚠
pio_balanced_network_name^⚠
pio_balanced_network_release^⚠
pio_balanced_network_retain^⚠
pio_balanced_network_shunt_at^⚠: Read one shunt by zero based table position.
pio_balanced_network_shunt_block_at^⚠: Read one switched shunt block by zero based position.
pio_balanced_network_shunt_count^⚠
pio_balanced_network_static_var_compensator_at^⚠: Read one static VAR compensator by zero based table position.
pio_balanced_network_static_var_compensator_count^⚠
pio_balanced_network_storage_at^⚠: Read one storage element by zero based table position.
pio_balanced_network_storage_count^⚠
pio_balanced_network_switch_at^⚠: Read one transmission switch by zero based table position.
pio_balanced_network_switch_count^⚠
pio_balanced_network_three_winding_transformer_at^⚠: Read one three winding transformer by zero based table position.
pio_balanced_network_three_winding_transformer_count^⚠
pio_balanced_network_three_winding_transformer_impedance_at^⚠: Read one pairwise impedance of a three winding transformer.
pio_balanced_network_three_winding_transformer_winding_at^⚠: Read one winding of a three winding transformer.
pio_build_ac_opf_preparation^⚠: Build the matrix free AC OPF inputs from one typed instance.
pio_build_dc_opf_preparation^⚠: Build the matrix free DC OPF inputs from one typed instance.
pio_calc_branch_flow_dc^⚠
pio_calc_branch_flow_matrix^⚠
pio_calc_branch_phase_shift_injection^⚠
pio_calc_branch_susceptances^⚠
pio_calc_bus_injection_dc^⚠
pio_calc_bus_phase_shift_injection^⚠
pio_calc_bus_susceptance_matrix^⚠
pio_calc_incidence_matrix^⚠
pio_calculation_instance_active_constraint_at^⚠: Read one active constraint family by zero based position.
pio_calculation_instance_active_constraint_count^⚠
pio_calculation_instance_active_constraint_identity_at^⚠: Read one selected component identity from an only constraint selection.
pio_calculation_instance_balanced_network^⚠
pio_calculation_instance_has_initial_point^⚠
pio_calculation_instance_initial_point^⚠: Return the optional owner-rooted initial operating point. A calculation instance with no initial point returns NULL without setting an error.
pio_calculation_instance_multiconductor_network^⚠
pio_calculation_instance_objective_term_at^⚠: Read one typed objective term by zero based position.
pio_calculation_instance_objective_term_count^⚠
pio_calculation_instance_release^⚠
pio_calculation_instance_retain^⚠
pio_calculation_instance_type_name^⚠
pio_calculation_solution_balanced_network^⚠
pio_calculation_solution_get_objective^⚠: Return an OPF or SCUC objective. SOCWR reports a lower bound through pio_socwr_opf_solution_get_objective_lower_bound instead.
pio_calculation_solution_get_values^⚠: Copy one named solution quantity into an independently owned vector.
pio_calculation_solution_instance^⚠: Return an owner-rooted view of the exact calculation instance retained by a calculation solution.
pio_calculation_solution_multiconductor_network^⚠
pio_calculation_solution_release^⚠
pio_calculation_solution_retain^⚠
pio_calculation_solution_termination^⚠
pio_calculation_solution_type_name^⚠
pio_calculation_update_from_network^⚠
pio_calculation_update_from_operating_point^⚠
pio_calculation_update_release^⚠
pio_calculation_update_retain^⚠
pio_component_id_local_id^⚠
pio_component_id_new^⚠: Construct a stable component identity.
pio_component_id_release^⚠
pio_component_id_retain^⚠
pio_component_id_type^⚠
pio_dc_opf_instance_branch_susceptance_formula^⚠
pio_dc_opf_preparation_branch_at^⚠: Read one active branch row of a DC OPF preparation.
pio_dc_opf_preparation_bus_at^⚠: Read one dense bus row of a DC OPF preparation.
pio_dc_opf_preparation_generator_at^⚠: Read one generator row of a DC OPF preparation.
pio_dc_opf_preparation_reference_buses^⚠: Borrow the dense reference bus indices of a DC OPF preparation.
pio_dc_opf_preparation_release^⚠
pio_dc_opf_preparation_retain^⚠
pio_dc_opf_preparation_skipped_zero_impedance^⚠: Borrow the analysis rows skipped for zero impedance.
pio_dc_opf_preparation_summary^⚠: Read the dimensions and conventions of a DC OPF preparation.
pio_dc_pf_instance_branch_susceptance_formula^⚠
pio_dc_pf_instance_bus_specification_at^⚠: Read one DC power flow bus specification by zero based bus table position.
pio_dc_pf_instance_bus_specification_count^⚠
pio_destination_memory^⚠: Select memory output and prefix returned artifact names with root.
pio_destination_path^⚠: Select a filesystem output path.
pio_destination_release^⚠
pio_destination_retain^⚠
pio_detailed_connectivity_boundary_line_at^⚠: Read one PowSybl boundary line by zero based table position.
pio_detailed_connectivity_boundary_line_reactive_capability_point_at^⚠: Read one point from a boundary line generation reactive capability curve.
pio_detailed_connectivity_boundary_line_reactive_capability_point_property_at^⚠: Read one property from one boundary line reactive capability curve point.
pio_detailed_connectivity_boundary_line_reactive_limit_property_at^⚠: Read one property on a boundary line generation reactive limit record.
pio_detailed_connectivity_bus_breaker_bus_at^⚠: Read one configured bus breaker bus by zero based table position.
pio_detailed_connectivity_busbar_section_at^⚠: Read one busbar section by zero based table position.
pio_detailed_connectivity_calculated_bus_at^⚠: Read one calculated bus by zero based table position.
pio_detailed_connectivity_calculated_bus_node_at^⚠: Read one node identity from a calculated bus.
pio_detailed_connectivity_component_alias_at^⚠: Read one alias from a component metadata record.
pio_detailed_connectivity_component_metadata_at^⚠: Read one component metadata record by zero based table position.
pio_detailed_connectivity_component_property_at^⚠: Read one string property from a component metadata record.
pio_detailed_connectivity_counts^⚠: Read every detailed connectivity table length.
pio_detailed_connectivity_dc_busbar_at^⚠: Read one DC busbar by zero based table position.
pio_detailed_connectivity_dc_converter_unit_at^⚠: Read one DC converter unit by zero based table position.
pio_detailed_connectivity_dc_ground_at^⚠: Read one DC ground by zero based table position.
pio_detailed_connectivity_dc_line_at^⚠: Read one DC line by zero based table position.
pio_detailed_connectivity_dc_node_at^⚠: Read one physical DC node by zero based table position.
pio_detailed_connectivity_dc_series_device_at^⚠: Read one DC series device by zero based table position.
pio_detailed_connectivity_dc_switch_at^⚠: Read one DC switch by zero based table position.
pio_detailed_connectivity_dc_topological_node_at^⚠: Read one DC topological node by zero based table position.
pio_detailed_connectivity_equipment_reactive_capability_point_at^⚠: Read one point from an equipment reactive capability curve.
pio_detailed_connectivity_equipment_reactive_capability_point_property_at^⚠: Read one property from an equipment reactive capability curve point.
pio_detailed_connectivity_equipment_reactive_limit_property_at^⚠: Read one property from an equipment reactive limit record.
pio_detailed_connectivity_equipment_reactive_limits_at^⚠: Read reactive limits retained for one equipment record.
pio_detailed_connectivity_external_identifier_at^⚠: Read one external identifier from a component metadata record.
pio_detailed_connectivity_internal_connection_at^⚠: Read one node breaker internal connection by zero based table position.
pio_detailed_connectivity_junction_at^⚠: Read one CIM junction by zero based table position.
pio_detailed_connectivity_line_commutated_converter_at^⚠: Read one line commutated converter by zero based table position.
pio_detailed_connectivity_line_commutated_converter_droop_curve_segment_at^⚠: Read one DC voltage droop curve segment from a line commutated converter.
pio_detailed_connectivity_node_at^⚠: Read one connectivity node by zero based table position.
pio_detailed_connectivity_omitted_field_at^⚠: Read one field that was absent from the source representation.
pio_detailed_connectivity_operational_limit_group_at^⚠: Read one operational limit group by zero based table position.
pio_detailed_connectivity_operational_limit_group_property_at^⚠: Read one string property from an operational limit group.
pio_detailed_connectivity_release^⚠
pio_detailed_connectivity_retain^⚠
pio_detailed_connectivity_subnetwork_at^⚠: Read one PowSybl subnetwork by zero based table position.
pio_detailed_connectivity_subnetwork_component_at^⚠: Read one component identity contained by a PowSybl subnetwork.
pio_detailed_connectivity_substation_at^⚠: Read one substation by zero based table position.
pio_detailed_connectivity_substation_geographical_tag_at^⚠: Read one geographical tag of a substation.
pio_detailed_connectivity_switch_at^⚠: Read one detailed topology switch by zero based table position.
pio_detailed_connectivity_tap_changer_at^⚠: Read one transformer tap changer by zero based table position.
pio_detailed_connectivity_tap_changer_step_at^⚠: Read one transformer tap changer step by zero based position.
pio_detailed_connectivity_temporary_limit_at^⚠: Read one temporary current, active power, or apparent power limit.
pio_detailed_connectivity_terminal_at^⚠: Read one AC terminal by zero based table position.
pio_detailed_connectivity_tie_line_at^⚠: Read one PowSybl tie line by zero based table position.
pio_detailed_connectivity_voltage_level_at^⚠: Read one voltage level by zero based table position.
pio_detailed_connectivity_voltage_level_bus_at^⚠: Read one balanced bus ID assigned to a voltage level.
pio_detailed_connectivity_voltage_source_converter_at^⚠: Read one voltage source converter by zero based table position.
pio_detailed_connectivity_voltage_source_converter_droop_curve_segment_at^⚠: Read one DC voltage droop curve segment from a voltage source converter.
pio_detailed_connectivity_voltage_source_converter_reactive_capability_point_at^⚠: Read one point from a voltage source converter reactive capability curve.
pio_detailed_connectivity_voltage_source_converter_reactive_capability_point_property_at^⚠: Read one property from a voltage source converter reactive capability point.
pio_detailed_connectivity_voltage_source_converter_reactive_limit_property_at^⚠: Read one property from a voltage source converter reactive limit record.
pio_diagnostic_code^⚠
pio_diagnostic_details_json^⚠: Serialize this diagnostic’s structured details as an owned JSON object.
pio_diagnostic_has_id^⚠: Whether this diagnostic has a durable identity.
pio_diagnostic_has_suggested_action^⚠: Whether this diagnostic carries a suggested action.
pio_diagnostic_has_target^⚠: Whether this diagnostic names a value element.
pio_diagnostic_id^⚠: Borrow this diagnostic’s durable identity, or an empty view when absent.
pio_diagnostic_message^⚠
pio_diagnostic_n_related^⚠: Number of other diagnostic identities referenced by this diagnostic.
pio_diagnostic_n_spans^⚠: Number of source byte ranges attached to this diagnostic.
pio_diagnostic_related^⚠: Borrow one related diagnostic identity, or an empty view when out of range.
pio_diagnostic_severity^⚠
pio_diagnostic_span^⚠: Read one source byte range. The source string borrows from diagnostics.
pio_diagnostic_suggested_action^⚠: Borrow this diagnostic’s suggested action, or an empty view when absent.
pio_diagnostic_target^⚠: Borrow this diagnostic’s value element locator, or an empty view when absent.
pio_diagnostics_len^⚠
pio_diagnostics_release^⚠
pio_diagnostics_retain^⚠
pio_emit^⚠: Emit one module as a grid exchange format.
pio_emit_result_artifact^⚠
pio_emit_result_artifact_count^⚠
pio_emit_result_diagnostics^⚠
pio_emit_result_fidelity^⚠
pio_emit_result_layout^⚠
pio_emit_result_release^⚠
pio_emit_result_retain^⚠
pio_error_code^⚠: The failure’s stable diagnostic code.
pio_error_diagnostics^⚠: The structured diagnostics that caused the failure.
pio_error_message^⚠: The rendered failure message.
pio_error_release^⚠
pio_error_retain^⚠
pio_geo_apply_report_matched_branches^⚠
pio_geo_apply_report_matched_buses^⚠
pio_geo_apply_report_note_at^⚠
pio_geo_apply_report_note_count^⚠
pio_geo_apply_report_release^⚠
pio_geo_apply_report_retain^⚠
pio_geo_apply_report_unlocated_branches^⚠
pio_geo_apply_report_unlocated_buses^⚠
pio_geo_apply_report_unmatched_features^⚠
pio_geo_layer_diagnostics^⚠: Return diagnostics produced while parsing a geographic sidecar.
pio_geo_layer_parse^⚠: Parse one geographic sidecar from an acquired source.
pio_geo_layer_release^⚠
pio_geo_layer_retain^⚠
pio_json_value_array_at^⚠: Return one owner-rooted element from a structured JSON array.
pio_json_value_get^⚠: Read the type and scalar or collection data for a structured value.
pio_json_value_object_entry_at^⚠: Read one key and value type from a structured JSON object.
pio_json_value_object_value_at^⚠: Return one owner-rooted value from a structured JSON object by position.
pio_json_value_release^⚠
pio_json_value_retain^⚠
pio_mc_ac_pf_instance_active_control_at^⚠
pio_mc_ac_pf_instance_active_control_count^⚠
pio_mc_ac_pf_instance_isolated_terminal_at^⚠
pio_mc_ac_pf_instance_isolated_terminal_count^⚠
pio_mc_ac_pf_instance_load_at^⚠
pio_mc_ac_pf_instance_load_count^⚠
pio_mc_ac_pf_instance_load_terminal_at^⚠
pio_mc_ac_pf_instance_source_at^⚠
pio_mc_ac_pf_instance_source_count^⚠
pio_mc_ac_pf_instance_source_terminal_at^⚠
pio_module_apply_geo_layer^⚠: Apply one geographic layer to a balanced or multiconductor network module. The input module is unchanged. When out_report is not NULL, it receives an independently owned report handle.
pio_module_deserialize^⚠: Deserialize one PowerIO IR source.
pio_module_diagnostics^⚠: Return the module’s stored diagnostics.
pio_module_extension_at^⚠: Read one namespaced structured module extension by zero based position.
pio_module_extension_count^⚠
pio_module_extension_value_at^⚠: Return an owner-rooted structured module extension value.
pio_module_history_assumption_at^⚠: Read one assumption attached to a history entry.
pio_module_history_at^⚠: Read one operation from module history by zero based position.
pio_module_history_count^⚠
pio_module_history_loss_at^⚠: Read one declared loss attached to a history entry.
pio_module_history_parameter_at^⚠: Read one named structured history parameter by zero based position.
pio_module_history_parameter_value_at^⚠: Return an owner-rooted structured history parameter value.
pio_module_producer^⚠: Read the program identity recorded with a module.
pio_module_release^⚠
pio_module_retain^⚠
pio_module_serialize^⚠: Serialize one module as PowerIO IR.
pio_module_source_at^⚠: Read one durable source descriptor by zero based position.
pio_module_source_count^⚠
pio_module_source_map_at^⚠: Read one source map entry by zero based position.
pio_module_source_map_count^⚠
pio_module_source_map_span_at^⚠: Read one byte range from a source map entry.
pio_module_to_ac_opf_instance^⚠: Construct an AC optimal power flow calculation module from a balanced network module.
pio_module_to_ac_pf_instance^⚠: Construct an AC power flow calculation module from a balanced network module.
pio_module_to_dc_opf_instance^⚠: Construct a DC optimal power flow calculation module from a balanced network module.
pio_module_to_dc_pf_instance^⚠: Construct a DC power flow calculation module from a balanced network module.
pio_module_to_mc_ac_opf_instance^⚠: Construct a multiconductor AC optimal power flow calculation module from a multiconductor network module.
pio_module_to_mc_ac_pf_instance^⚠: Construct a multiconductor AC power flow calculation module from a multiconductor network module.
pio_module_value^⚠: Return an owner-rooted view of the module’s value.
pio_multiconductor_network_base_frequency_hz^⚠
pio_multiconductor_network_bus_at^⚠: Read one multiconductor bus by zero based table position. Borrowed strings and numeric spans remain valid while the network handle is alive.
pio_multiconductor_network_bus_count^⚠
pio_multiconductor_network_bus_grounded_terminal_at^⚠
pio_multiconductor_network_bus_terminal_at^⚠
pio_multiconductor_network_capacitor_at^⚠
pio_multiconductor_network_capacitor_terminal_at^⚠
pio_multiconductor_network_command_at^⚠
pio_multiconductor_network_control_profile_at^⚠
pio_multiconductor_network_counts^⚠: Read exact table lengths. Defaulted source fields and arbitrary extension maps are retained internally and are not separate domain tables.
pio_multiconductor_network_generator_at^⚠
pio_multiconductor_network_generator_count^⚠
pio_multiconductor_network_generator_terminal_at^⚠
pio_multiconductor_network_geo^⚠: Read the network coordinate metadata, including absence through has_geo.
pio_multiconductor_network_has_name^⚠
pio_multiconductor_network_has_source_format^⚠
pio_multiconductor_network_inverter_based_resource_at^⚠
pio_multiconductor_network_inverter_based_resource_terminal_at^⚠
pio_multiconductor_network_line_at^⚠
pio_multiconductor_network_line_code_at^⚠
pio_multiconductor_network_line_code_conductance_from_matrix_row_at^⚠
pio_multiconductor_network_line_code_conductance_to_matrix_row_at^⚠
pio_multiconductor_network_line_code_reactance_matrix_row_at^⚠
pio_multiconductor_network_line_code_resistance_matrix_row_at^⚠
pio_multiconductor_network_line_code_susceptance_from_matrix_row_at^⚠
pio_multiconductor_network_line_code_susceptance_to_matrix_row_at^⚠
pio_multiconductor_network_line_count^⚠
pio_multiconductor_network_line_route_point_at^⚠
pio_multiconductor_network_line_terminal_from_at^⚠
pio_multiconductor_network_line_terminal_to_at^⚠
pio_multiconductor_network_load_at^⚠
pio_multiconductor_network_load_count^⚠
pio_multiconductor_network_load_terminal_at^⚠
pio_multiconductor_network_name^⚠
pio_multiconductor_network_option_at^⚠
pio_multiconductor_network_release^⚠
pio_multiconductor_network_retain^⚠
pio_multiconductor_network_shunt_at^⚠
pio_multiconductor_network_shunt_conductance_matrix_row_at^⚠
pio_multiconductor_network_shunt_susceptance_matrix_row_at^⚠
pio_multiconductor_network_shunt_terminal_at^⚠
pio_multiconductor_network_source_format^⚠
pio_multiconductor_network_switch_at^⚠
pio_multiconductor_network_switch_terminal_from_at^⚠
pio_multiconductor_network_switch_terminal_to_at^⚠
pio_multiconductor_network_transformer_at^⚠
pio_multiconductor_network_transformer_winding_at^⚠
pio_multiconductor_network_transformer_winding_terminal_at^⚠
pio_multiconductor_network_untyped_object_at^⚠
pio_multiconductor_network_untyped_object_property_at^⚠
pio_multiconductor_network_voltage_source_at^⚠
pio_multiconductor_network_voltage_source_terminal_at^⚠
pio_network_update_release^⚠
pio_network_update_retain^⚠
pio_network_update_set_branch_thermal_rating^⚠
pio_operating_point_balanced_network^⚠
pio_operating_point_get_value^⚠: Read one operating point quantity by its PowerIO quantity name and stable component identity. Multiconductor terminal identities use component/terminal. Returns false when the point does not contain the quantity or identity.
pio_operating_point_multiconductor_network^⚠
pio_operating_point_release^⚠
pio_operating_point_retain^⚠
pio_operating_point_type_name^⚠
pio_operating_point_update_release^⚠
pio_operating_point_update_retain^⚠
pio_operating_point_update_set_branch_in_service^⚠
pio_operating_point_update_set_generator_active_power^⚠
pio_operating_point_update_set_generator_in_service^⚠
pio_operating_point_update_set_generator_reactive_power^⚠
pio_operating_point_update_set_generator_voltage_magnitude^⚠
pio_operating_point_update_set_load_active_power^⚠
pio_operating_point_update_set_load_reactive_power^⚠
pio_operating_point_update_set_switch_closed^⚠
pio_operating_point_update_set_transformer_phase_shift_degrees^⚠
pio_operating_point_update_set_transformer_tap_ratio^⚠
pio_parse^⚠: Parse one acquired grid exchange source.
pio_reactive_power_from_megavars
pio_reactive_power_from_vars
pio_reactive_power_release^⚠
pio_reactive_power_retain^⚠
pio_reactive_power_unit^⚠
pio_reactive_power_value^⚠
pio_scenario_set_element_type^⚠
pio_scenario_set_get^⚠: Return an owner-rooted scenario value by exact scenario ID.
pio_scenario_set_get_at^⚠: Return an owner-rooted scenario value by zero-based position.
pio_scenario_set_id_at^⚠
pio_scenario_set_len^⚠
pio_scenario_set_release^⚠
pio_scenario_set_retain^⚠
pio_schema_report^⚠: Return version information for this ABI and the PowerIO IR serializer/deserializer.
pio_socwr_opf_solution_get_objective_lower_bound^⚠
pio_source_from_memory^⚠: Retain named bytes as an in-memory source. Binary content is supported.
pio_source_open^⚠: Acquire a file or directory path.
pio_source_release^⚠
pio_source_retain^⚠
pio_sparse_matrix_column_indices^⚠
pio_sparse_matrix_columns^⚠
pio_sparse_matrix_release^⚠
pio_sparse_matrix_retain^⚠
pio_sparse_matrix_row_offsets^⚠
pio_sparse_matrix_rows^⚠
pio_sparse_matrix_values^⚠
pio_string_release^⚠
pio_string_retain^⚠
pio_string_view^⚠
pio_time_series_element_type^⚠
pio_time_series_get^⚠: Return an owner-rooted entry by zero-based position.
pio_time_series_len^⚠
pio_time_series_release^⚠
pio_time_series_retain^⚠
pio_update_change_component_id^⚠
pio_update_change_field^⚠
pio_update_change_release^⚠
pio_update_change_retain^⚠
pio_update_change_terminal^⚠
pio_update_report_change^⚠
pio_update_report_connectivity_changed^⚠
pio_update_report_len^⚠
pio_update_report_release^⚠
pio_update_report_retain^⚠
pio_value_ac_opf_instance^⚠
pio_value_ac_opf_solution^⚠
pio_value_ac_pf_instance^⚠
pio_value_ac_pf_solution^⚠
pio_value_ac_scuc_instance^⚠
pio_value_ac_scuc_solution^⚠
pio_value_balanced_network^⚠: Borrow the value as a balanced network without serialization or copying.
pio_value_balanced_operating_point^⚠
pio_value_dc_opf_instance^⚠
pio_value_dc_opf_solution^⚠
pio_value_dc_pf_instance^⚠
pio_value_dc_pf_solution^⚠
pio_value_geo_layer^⚠: Take the value as a geographic layer handle. The layer is copied out of the value, so the handle outlives the module the way pio_geo_layer_parse produces one.
pio_value_is_type^⚠: Exact structural type predicate.
pio_value_mc_ac_opf_instance^⚠
pio_value_mc_ac_opf_solution^⚠
pio_value_mc_ac_pf_instance^⚠
pio_value_mc_ac_pf_solution^⚠
pio_value_multiconductor_network^⚠: Borrow the value as a multiconductor network without serialization or copying.
pio_value_multiconductor_operating_point^⚠
pio_value_release^⚠
pio_value_retain^⚠
pio_value_scenario_set^⚠: Borrow the value as a scenario set.
pio_value_socwr_opf_solution^⚠
pio_value_time_series^⚠: Borrow the value as a time series.
pio_value_type_name^⚠: Canonical structural type name, such as powerio.BalancedNetwork.
pio_vector_release^⚠
pio_vector_retain^⚠
pio_vector_values^⚠
pio_version: Return the PowerIO crate version.

Crate powerio_capi

Crate powerio_capi Copy item path

Modules§

Structs§

Constants§

Functions§

Crate powerio_capi