Struct Generator 

#[non_exhaustive]
pub struct Generator {

    pub bus: BusId,
    pub energy_source: GeneratorEnergySource,
    pub pg: f64,
    pub qg: f64,
    pub pmax: f64,
    pub pmin: f64,
    pub qmax: f64,
    pub qmin: f64,
    pub vg: f64,
    pub mbase: f64,
    pub in_service: bool,
    pub cost: Option<GenCost>,
    pub caps: [Option<f64>; 11],
    pub voltage_regulation_on: bool,
    pub regulating_terminal: Option<TerminalReference>,
    pub regulated_bus: Option<BusId>,
    pub active_power_control: Option<ActivePowerControl>,
    pub uid: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bus: BusId

energy_source: GeneratorEnergySource

Primary energy source used by the generating equipment.

pg: f64

Real power set point (MW).

qg: f64

Reactive power set point (MVAr).

pmax: f64

pmin: f64

qmax: f64

qmin: f64

vg: f64

Voltage set point (p.u.).

mbase: f64

in_service: bool

cost: Option<GenCost>

caps: [Option<f64>; 11]

The MATPOWER gen capability / ramp columns past PMIN, aligned to GEN_EXTRA_KEYS by index (None for a column the source omitted). A fixed array, not an Extras map: a string-keyed map per generator costs 11 heap allocations each, which dominates the parse of a large generator-heavy case. Surfaced into formats that name them (PowerModels). On the JSON snapshot it is a name-keyed object (see caps_serde) so the schema stays additive when GEN_EXTRA_KEYS grows; #[serde(default)] so a snapshot that omits it deserializes to the empty set.

voltage_regulation_on: bool

Whether the generator’s voltage regulation is enabled. Formats without an explicit enable field use true, matching the voltage set point carried by the balanced generator row.

regulating_terminal: Option<TerminalReference>

The exact equipment terminal whose voltage is regulated. None means the generator’s own terminal, or that the source format names only a regulated bus.

regulated_bus: Option<BusId>

The remote bus whose voltage this generator regulates, when that is not its own terminal bus (PSS/E IREG). None means it regulates its own bus. Part of the cross-element voltage-control graph: a format that names a remote regulated bus (PSS/E) keeps it across a round trip instead of collapsing every generator onto its own terminal. #[serde(default)] so JSON written before the field existed still deserializes.

active_power_control: Option<ActivePowerControl>

Governor and distributed slack settings, when supplied by the source.

uid: Option<String>

Stable row identity; see Bus::uid.

Implementations

impl Generator

pub fn new(bus: BusId) -> Generator

pub fn has_caps(&self) -> bool

True when any capability / ramp column is present. Formats without those fields (PSS/E, PowerWorld) use this to warn on what they drop.

Trait Implementations

impl Clone for Generator

fn clone(&self) -> Generator

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Generator

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Generator

fn deserialize<__D>( __deserializer: __D, ) -> Result<Generator, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Generator

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Generator

fn eq(&self, other: &Generator) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Generator

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Generator