Struct EditSession 

pub struct EditSession {
    pub doc: SchDoc,
    /* private fields */
}

An editing session for a schematic document.

Fields

doc: SchDoc

The schematic document being edited.

Implementations

impl EditSession

pub fn new() -> Self

Create a new empty editing session.

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Open an existing schematic file for editing.

pub fn save<P: AsRef<Path>>(&mut self, path: P) -> Result<()>

Save the schematic to a file.

pub fn save_to_original(&mut self) -> Result<()>

Save to the original file (if opened from file).

pub fn is_modified(&self) -> bool

Check if the document has been modified.

pub fn source_path(&self) -> Option<&str>

Get the source file path.

pub fn layout(&self) -> &LayoutEngine

Get the layout engine.

pub fn layout_mut(&mut self) -> &mut LayoutEngine

Get mutable access to the layout engine.

pub fn library(&self) -> &LibraryManager

Get the library manager.

pub fn library_mut(&mut self) -> &mut LibraryManager

Get mutable access to the library manager.

pub fn set_grid(&mut self, grid: Grid)

Set the grid configuration.

pub fn load_library<P: AsRef<Path>>(&mut self, path: P) -> Result<()>

Load a SchLib library file.

pub fn add_component( &mut self, lib_reference: &str, location: CoordPoint, orientation: Orientation, designator: Option<&str>, ) -> Result<usize>

Add a component from a loaded library.

pub fn suggest_component_placement( &self, lib_reference: &str, near_component: Option<&str>, ) -> Vec<PlacementSuggestion>

Find the best position for a new component.

pub fn move_component( &mut self, index: usize, new_location: CoordPoint, ) -> Result<()>

Move a component to a new location.

pub fn delete_component(&mut self, index: usize) -> Result<()>

Delete a component and all its child primitives.

pub fn add_wire(&mut self, vertices: &[CoordPoint]) -> Result<usize>

Add a wire with specified vertices.

pub fn route_wire( &mut self, start: CoordPoint, end: CoordPoint, ) -> Result<usize>

Route a wire between two points automatically.

pub fn connect_pins( &mut self, component1: &str, pin1: &str, component2: &str, pin2: &str, ) -> Result<usize>

Connect two component pins with automatic routing.

pub fn delete_wire(&mut self, index: usize) -> Result<()>

Delete a wire by index.

pub fn add_bus(&mut self, vertices: &[CoordPoint]) -> Result<usize>

Add a bus with specified vertices.

pub fn add_bus_entry( &mut self, bus_point: CoordPoint, wire_point: CoordPoint, ) -> Result<usize>

Add a bus entry connecting a bus to a wire.

• bus_point - Point on the bus where the entry connects
• wire_point - Point where the wire will connect (typically 10 mil offset)

pub fn find_buses(&self) -> Vec<(usize, &SchBus)>

Find buses in the document.

pub fn find_bus_at(&self, point: CoordPoint) -> Option<(usize, &SchBus)>

Find a bus that contains or is near a point.

pub fn route_to_bus( &mut self, wire_start: CoordPoint, bus_point: CoordPoint, ) -> Result<(usize, usize)>

Route a wire to a bus, automatically creating a bus entry.

Creates a bus entry at the nearest point on the bus to the wire endpoint, then routes the wire to the bus entry’s wire-side point.

pub fn add_net_label( &mut self, name: &str, location: CoordPoint, ) -> Result<usize>

Add a net label at a location.

pub fn add_power_port( &mut self, net_name: &str, location: CoordPoint, style: PowerObjectStyle, orientation: TextOrientations, ) -> Result<usize>

Add a power port at a location.

pub fn smart_wire_pin( &mut self, component: &str, pin: &str, net_name: &str, power_style: Option<PowerObjectStyle>, wire_length_mils: f64, ) -> Result<(usize, usize)>

Smart-wire a pin: create a wire stub from the pin endpoint and attach a net label or power port.

Returns (wire_index, label_or_power_index).

pub fn add_junction(&mut self, location: CoordPoint) -> Result<usize>

Add a junction at a location.

pub fn add_port( &mut self, name: &str, location: CoordPoint, io_type: PortIoType, ) -> Result<usize>

Add a port at a location.

pub fn build_netlist(&self) -> Netlist

Build the netlist for the current document.

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

Find unconnected pins.

pub fn find_missing_junctions(&self) -> Vec<(i32, i32)>

Find missing junctions.

pub fn add_missing_junctions(&mut self) -> Result<usize>

Add missing junctions automatically.

pub fn validate(&self) -> Vec<ValidationError>

Validate the schematic and return any errors.

pub fn history_count(&self) -> usize

Get the number of operations in history.

pub fn can_undo(&self) -> bool

Check if undo is available.

pub fn can_redo(&self) -> bool

Check if redo is available.

pub fn recent_operations(&self, count: usize) -> Vec<String>

Get a summary of recent operations.

Trait Implementations

impl Default for EditSession

fn default() -> Self

Returns the “default value” for a type.