Struct kicad_parse_gen::footprint::Module

pub struct Module {
    pub name: String,
    pub elements: Vec<Element>,
}

a Kicad module, with a name and a list of elements

Fields

name: String

name of the Kicad Module

elements: Vec<Element>

elements contained within the Kicad Module

Methods

impl Module

fn new(name: String) -> Module

create a Module

fn append(&mut self, e: Element)

append an Element to a Module

fn is_reference_with_name(&self, reference: &str) -> bool

check if a Module has a reference Element with the specified name

fn get_reference(&self) -> Option<&String>

get the Reference element from the Module if it exists

fn get_text(&self, which: &'static str) -> Option<&FpText>

get a FpText field by name

fn get_text_mut(&mut self, which: &'static str) -> Option<&mut FpText>

mutably get a FpText field by name

fn get_reference_text(&self) -> Option<&FpText>

get the reference FpText

fn get_reference_text_mut(&mut self) -> Option<&mut FpText>

mutably get the reference FpText

fn get_reference2_text(&self) -> Option<&FpText>

get the reference2 FpText

fn get_reference2_text_mut(&mut self) -> Option<&mut FpText>

mutably get the reference2 FpText

fn get_value_text_mut(&mut self) -> Option<&mut FpText>

mutably get the value FpText

fn has_smd_attr(&self) -> bool

check if the module has the "smd" attribute

fn get_value_text(&self) -> Option<&FpText>

get the value FpText

fn get_tstamp(&self) -> Option<i64>

check if a Module has a tstamp Element and return it

fn get_tedit(&self) -> Option<i64>

check if a Module has a tedit Element and return it

fn set_reference(&mut self, reference: &str, reference2: &str)

update the name of the reference element specified by name, if found

fn at(&self) -> (f64, f64)

check if there is an At element and return the coordinates found returns the default of (0.0,0.0) if not found

fn get_rotation(&self) -> f64

check if there is an At element and return the rotation found returns the default of 0.0 if not found

fn adjust_at(&mut self, x: f64, y: f64)

adjust the At element contained in the module

fn is_front(&self) -> bool

check if the Module is on the front layer

fn rename_net(&mut self, old_name: &str, new_name: &str)

rename a net

fn pads(&self) -> Vec<&Pad>

return a list of Pads contained in the module

fn lines(&self) -> Vec<&FpLine>

return a list of FpLines contained in the module

Trait Implementations

impl Debug for Module

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for Module

fn clone(&self) -> Module

Returns a copy of the value.

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

Performs copy-assignment from source.

impl BoundingBox for Module

fn bounding_box(&self) -> Bound

calculate the bounding box of a layout item

impl Adjust for Module

fn adjust(&mut self, x: f64, y: f64)

adjust the location of the item

impl Flip for Module

fn flip(&mut self)

flip me

impl Rotate for Module

fn rotate(&mut self, rot: f64)

rotate

impl CheckFix for Module

fn check(&self, config: &Config) -> Vec<CheckFixData>

check an item against the KLC

fn fix(&mut self, config: &Config)

fix up an item against the KLC

impl IntoSexp for Module

fn into_sexp(&self) -> Sexp

convert self into a Sexp

impl FromSexp for Module

fn from_sexp(s: &Sexp) -> Result<Module, SexpError>

convert from a symbolic-expression to something