Struct CtmNetworkShuntItem 

pub struct CtmNetworkShuntItem {
    pub bs: CtmNetworkShuntItemBs,
    pub bus: Uid,
    pub ext: Option<Value>,
    pub gs: CtmNetworkShuntItemGs,
    pub name: Option<String>,
    pub nominal_mva: Option<PositiveNumber>,
    pub num_steps_ub: CtmNetworkShuntItemNumStepsUb,
    pub status: Status,
    pub uid: Uid,
}

structure to hold shunt data

JSON schema

{
 "description": "structure to hold shunt data",
 "type": "object",
 "required": [
   "bs",
   "bus",
   "gs",
   "num_steps_ub",
   "status",
   "uid"
 ],
 "properties": {
   "bs": {
     "description": "[MVAr or pu] reactive power demand at v_bus = 1.0 pu, per step of each shunt section",
     "anyOf": [
       {
         "type": "number"
       },
       {
         "type": "array",
         "items": {
           "type": "number"
         }
       }
     ]
   },
   "bus": {
     "description": "uid of bus to which shunt is connected to",
     "$ref": "#/$defs/uid"
   },
   "ext": {
     "description": "additional shunt parameters currently not supported by CTM"
   },
   "gs": {
     "description": "[MW or pu] active power demand at v_bus = 1.0 pu, per step of each shunt section",
     "anyOf": [
       {
         "$ref": "#/$defs/nonnegative_number"
       },
       {
         "type": "array",
         "items": {
           "$ref": "#/$defs/nonnegative_number"
         }
       }
     ]
   },
   "name": {
     "description": "shunt name",
     "type": "string"
   },
   "nominal_mva": {
     "description": "[MVA] nominal apparent power of shunt (nameplate capacity)",
     "$ref": "#/$defs/positive_number"
   },
   "num_steps_ub": {
     "description": "upper bound for number of energized steps of shunt section (lower bound is always 0)",
     "anyOf": [
       {
         "$ref": "#/$defs/nonnegative_integer"
       },
       {
         "type": "array",
         "items": {
           "$ref": "#/$defs/nonnegative_integer"
         }
       }
     ]
   },
   "status": {
     "$ref": "#/$defs/status"
   },
   "uid": {
     "$ref": "#/$defs/uid"
   }
 }
}

Fields

bs: CtmNetworkShuntItemBs

[MVAr or pu] reactive power demand at v_bus = 1.0 pu, per step of each shunt section

bus: Uid

uid of bus to which shunt is connected to

ext: Option<Value>

additional shunt parameters currently not supported by CTM

gs: CtmNetworkShuntItemGs

[MW or pu] active power demand at v_bus = 1.0 pu, per step of each shunt section

name: Option<String>

shunt name

nominal_mva: Option<PositiveNumber>

[MVA] nominal apparent power of shunt (nameplate capacity)

num_steps_ub: CtmNetworkShuntItemNumStepsUb

upper bound for number of energized steps of shunt section (lower bound is always 0)

status: Status

uid: Uid

Implementations

impl CtmNetworkShuntItem

pub fn builder() -> CtmNetworkShuntItem

Trait Implementations

impl Clone for CtmNetworkShuntItem

fn clone(&self) -> CtmNetworkShuntItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CtmNetworkShuntItem

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CtmNetworkShuntItem

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&CtmNetworkShuntItem> for CtmNetworkShuntItem

fn from(value: &CtmNetworkShuntItem) -> Self

Converts to this type from the input type.

impl From<CtmNetworkShuntItem> for CtmNetworkShuntItem

fn from(value: CtmNetworkShuntItem) -> Self

Converts to this type from the input type.

impl Serialize for CtmNetworkShuntItem

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CtmNetworkShuntItem> for CtmNetworkShuntItem

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: CtmNetworkShuntItem) -> Result<Self, ConversionError>

Performs the conversion.