Struct MulticonductorNetwork 

pub struct MulticonductorNetwork { /* private fields */ }

A multiconductor distribution network: an immutable cheap to clone owning handle over private shared tables.

Cloning the handle bumps one reference count and clones no table allocation. Reads go through the per field accessors; the *_mut accessors copy the shared tables once on first write to a shared handle (copy on write), so no other handle ever observes a mutation. Per element ("class.name" key), the tables also record which fields the reader materialized from a format default rather than the source text. The original source text for the byte exact echo tier is not carried here; it lives on the PioModule a parse returns, alongside this network.

Implementations

impl MulticonductorNetwork

pub fn to_graph(&self) -> DistGraph

Transform this network into a render ready bus and terminal graph.

impl MulticonductorNetwork

pub fn name(&self) -> &Option<String>

pub fn name_mut(&mut self) -> &mut Option<String>

Mutable access to the same table; a shared handle copies its tables once here, so no other handle observes the change.

pub fn geo(&self) -> &Option<DistGeoMeta>

pub fn geo_mut(&mut self) -> &mut Option<DistGeoMeta>

Mutable access to the same table; a shared handle copies its tables once here, so no other handle observes the change.

pub fn buses(&self) -> &Vec<DistBus>

pub fn buses_mut(&mut self) -> &mut Vec<DistBus>

Mutable access to the same table; a shared handle copies its tables once here, so no other handle observes the change.

pub fn line_codes(&self) -> &Vec<DistLineCode>

pub fn line_codes_mut(&mut self) -> &mut Vec<DistLineCode>

Mutable access to the same table; a shared handle copies its tables once here, so no other handle observes the change.

pub fn lines(&self) -> &Vec<DistLine>

pub fn lines_mut(&mut self) -> &mut Vec<DistLine>

Mutable access to the same table; a shared handle copies its tables once here, so no other handle observes the change.

pub fn switches(&self) -> &Vec<DistSwitch>

pub fn switches_mut(&mut self) -> &mut Vec<DistSwitch>

Mutable access to the same table; a shared handle copies its tables once here, so no other handle observes the change.

pub fn transformers(&self) -> &Vec<DistTransformer>

pub fn transformers_mut(&mut self) -> &mut Vec<DistTransformer>

Mutable access to the same table; a shared handle copies its tables once here, so no other handle observes the change.

pub fn loads(&self) -> &Vec<DistLoad>

pub fn loads_mut(&mut self) -> &mut Vec<DistLoad>

Mutable access to the same table; a shared handle copies its tables once here, so no other handle observes the change.

pub fn generators(&self) -> &Vec<DistGenerator>

pub fn generators_mut(&mut self) -> &mut Vec<DistGenerator>

Mutable access to the same table; a shared handle copies its tables once here, so no other handle observes the change.

pub fn ibrs(&self) -> &Vec<DistIbr>

pub fn ibrs_mut(&mut self) -> &mut Vec<DistIbr>

Mutable access to the same table; a shared handle copies its tables once here, so no other handle observes the change.

pub fn control_profiles(&self) -> &Vec<DistControlProfile>

pub fn control_profiles_mut(&mut self) -> &mut Vec<DistControlProfile>

Mutable access to the same table; a shared handle copies its tables once here, so no other handle observes the change.

pub fn shunts(&self) -> &Vec<DistShunt>

pub fn shunts_mut(&mut self) -> &mut Vec<DistShunt>

Mutable access to the same table; a shared handle copies its tables once here, so no other handle observes the change.

pub fn capacitors(&self) -> &Vec<DistCapacitor>

pub fn capacitors_mut(&mut self) -> &mut Vec<DistCapacitor>

Mutable access to the same table; a shared handle copies its tables once here, so no other handle observes the change.

pub fn sources(&self) -> &Vec<VoltageSource>

pub fn sources_mut(&mut self) -> &mut Vec<VoltageSource>

Mutable access to the same table; a shared handle copies its tables once here, so no other handle observes the change.

pub fn untyped_objects(&self) -> &Vec<UntypedObject>

pub fn untyped_objects_mut(&mut self) -> &mut Vec<UntypedObject>

Mutable access to the same table; a shared handle copies its tables once here, so no other handle observes the change.

pub fn commands(&self) -> &Vec<(String, String)>

pub fn commands_mut(&mut self) -> &mut Vec<(String, String)>

Mutable access to the same table; a shared handle copies its tables once here, so no other handle observes the change.

pub fn options(&self) -> &Vec<(String, String)>

pub fn options_mut(&mut self) -> &mut Vec<(String, String)>

Mutable access to the same table; a shared handle copies its tables once here, so no other handle observes the change.

pub fn defaulted(&self) -> &BTreeMap<String, Vec<&'static str>>

pub fn defaulted_mut(&mut self) -> &mut BTreeMap<String, Vec<&'static str>>

Mutable access to the same table; a shared handle copies its tables once here, so no other handle observes the change.

pub fn source_format(&self) -> &Option<DistSourceFormat>

pub fn source_format_mut(&mut self) -> &mut Option<DistSourceFormat>

Mutable access to the same table; a shared handle copies its tables once here, so no other handle observes the change.

pub fn extras(&self) -> &BTreeMap<String, Value>

pub fn extras_mut(&mut self) -> &mut BTreeMap<String, Value>

Mutable access to the same table; a shared handle copies its tables once here, so no other handle observes the change.

impl MulticonductorNetwork

pub fn base_frequency(&self) -> f64

Hz.

pub fn base_frequency_mut(&mut self) -> &mut f64

impl MulticonductorNetwork

pub fn new() -> MulticonductorNetwork

pub fn named(name: impl Into<String>) -> MulticonductorNetwork

pub fn bus(&self, id: &str) -> Option<&DistBus>

Case insensitive, matching the source formats’ name semantics.

pub fn linecode(&self, name: &str) -> Option<&DistLineCode>

Case insensitive, matching the source formats’ name semantics.

Trait Implementations

impl Clone for MulticonductorNetwork

fn clone(&self) -> MulticonductorNetwork

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MulticonductorNetwork

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

Formats the value using the given formatter.

impl Default for MulticonductorNetwork

fn default() -> MulticonductorNetwork

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MulticonductorNetwork

fn deserialize<D>( deserializer: D, ) -> Result<MulticonductorNetwork, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<MulticonductorNetwork> for PioValue

fn from(value: MulticonductorNetwork) -> Self

Converts to this type from the input type.

impl JsonSchema for MulticonductorNetwork

Available on crate feature schema only.

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 Serialize for MulticonductorNetwork

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.