Skip to content

Device count related APIs

Changgang Li edited this page Feb 8, 2021 · 1 revision

get_bus_count

Format: get_bus_count()
Description: Return number of buses, including both in-service and out-of-service buses.
Args: N/A

Rets:

(1) Number of buses.

Example: N/A

get_generator_count

Format: get_generator_count()
Description: Return number of generators.
Args: N/A

Rets:

(1) Number of generators.

Example: N/A

get_wt_generator_count

Format: get_wt_generator_count()
Description: Return number of wind turbine generators.
Args: N/A

Rets:

(1) Number of wind turbine generators.

Example: N/A

get_pv_unit_count

Format: get_pv_unit_count()
Description: Return number of PV units.
Args: N/A

Rets:

(1) Number of PV units.

Example: N/A

get_load_count

Format: get_load_count()
Description: Return number of loads.
Args: N/A

Rets:

(1) Number of loads.

Example: N/A

get_fixed_shunt_count

Format: get_fixed_shunt_count()
Description: Return number of fixed shunt.
Args: N/A

Rets:

(1) Number of fixed shunts.

Example: N/A

get_line_count

Format: get_line_count()
Description: Return number of transmission lines.
Args: N/A

Rets:

(1) Number of transmission lines.

Example: N/A

get_transformer_count

Format: get_transformer_count()
Description: Return number of transformers.
Args: N/A

Rets:

(1) Number of transformers.

Example: N/A

get_hvdc_count

Format: get_hvdc_count()
Description: Return number of HVDC links.
Args: N/A

Rets:

(1) Number of HVDC links.

Example: N/A

get_equivalent_device_count

Format: get_equivalent_device_count()
Description: Return number of equivalent devices.
Args: N/A

Rets:

(1) Number of equivalent devices.

Example: N/A

get_energy_storage_count

Format: get_energy_storage_count()
Description: Return number of energy storages.
Args: N/A

Rets:

(1) Number of energy storages.

Example: N/A

get_area_count

Format: get_area_count()
Description: Return number of areas.
Args: N/A

Rets:

(1) Number of areas.

Example: N/A

get_zone_count

Format: get_zone_count()
Description: Return number of zones.
Args: N/A

Rets:

(1) Number of zones.

Example: N/A

get_owner_count

Format: get_owner_count()
Description: Return number of owners.
Args: N/A

Rets:

(1) Number of owners.

Example: N/A

get_in_service_bus_count

Format: get_in_service_bus_count()
Description: Return number of in-service buses.
Args: N/A

Rets:

(1) Number of in-service buses.

Example: N/A

update_overshadowed_buses

Format: update_overshadowed_buses()
Description: Update overshowed buses.
Args: N/A

Rets: N/A

Example: N/A

set_all_buses_un_overshadowed

Format: set_all_buses_un_overshadowed()
Description: Set all buses as un-overshowed.
Args: N/A

Rets: N/A

Example: N/A

get_overshadowed_bus_count

Format: get_overshadowed_bus_count()
Description: Get number of overshowed buses. If there are n buses directly connected by zero impedance line or lines, n-1 buses are overshadowed by one of them.
Args: N/A

Rets:

(1) Number of overshadowed buses.

Tips:

This function calls api to update overshadowed buses first.

Example: N/A