xorn.geda.netlist.package.Package Class Reference

Public Member Functions
def	__init__
def	get_all_attributes
	Get attribute value(s) from a package with given refdes. More...
def	get_attribute
	Return the value associated with attribute name on the package. More...
def	get_pin_by_pinseq
	Takes a pinseq string and returns that pinseq pin of this package. More...
def	get_slots
	Return a sorted list of slots used by this package. More...
def	get_unique_slots
	Return a sorted list of unique slots used by this package. More...
def	get_attribute_names
def	error
def	warn

Public Attributes
	netlist
	namespace
	unmangled_refdes
	refdes
	components
	pins
	pins_by_number

Detailed Description

Definition at line 26 of file package.py.

Constructor & Destructor Documentation

def xorn.geda.netlist.package.Package.__init__	(		self,
			netlist,
			namespace,
			unmangled_refdes
	)

Definition at line 27 of file package.py.

Member Function Documentation

def xorn.geda.netlist.package.Package.error	(		self,
			msg
	)

Definition at line 151 of file package.py.

def xorn.geda.netlist.package.Package.get_all_attributes	(		self,
			name
	)

Get attribute value(s) from a package with given refdes.

This function returns the values of a specific attribute type attached to the symbol instances with this package's refdes.

For each symbol instance, the found attribute value is added to the return list. None is added if the instance has no such attribute.

Note

The order of the values in the return list is the order of symbol instances within the netlist (the first element is the value associated with the first symbol instance).

Returns

a list of attribute values as strings and None

Definition at line 51 of file package.py.

def xorn.geda.netlist.package.Package.get_attribute	(		self,
			name,
			default = KeyError
	)

Return the value associated with attribute name on the package.

It actually computes a single value from the full list of values produced by get_all_attributes.

Returns the value associated with the first symbol instance for refdes which has a matching attribute. If all instances of refdes do not have the same value for name and name is not "slot", raises an error.

Definition at line 76 of file package.py.

def xorn.geda.netlist.package.Package.get_attribute_names	(		self,
			search_inherited
	)

Definition at line 141 of file package.py.

def xorn.geda.netlist.package.Package.get_pin_by_pinseq	(		self,
			pinseq
	)

Takes a pinseq string and returns that pinseq pin of this package.

Definition at line 98 of file package.py.

def xorn.geda.netlist.package.Package.get_slots

(

self

)

Return a sorted list of slots used by this package.

It collects the slot attribute values of each symbol instance of this package. As a result, slots may be repeated in the returned list.

Definition at line 117 of file package.py.

def xorn.geda.netlist.package.Package.get_unique_slots

(

self

)

Return a sorted list of unique slots used by this package.

Definition at line 136 of file package.py.

def xorn.geda.netlist.package.Package.warn	(		self,
			msg
	)

Definition at line 155 of file package.py.

Member Data Documentation

xorn.geda.netlist.package.Package.components

Definition at line 32 of file package.py.

xorn.geda.netlist.package.Package.namespace

Definition at line 29 of file package.py.

xorn.geda.netlist.package.Package.netlist

Definition at line 28 of file package.py.

xorn.geda.netlist.package.Package.pins

Definition at line 33 of file package.py.

xorn.geda.netlist.package.Package.pins_by_number

Definition at line 34 of file package.py.

xorn.geda.netlist.package.Package.refdes

Definition at line 31 of file package.py.

xorn.geda.netlist.package.Package.unmangled_refdes

Definition at line 30 of file package.py.

---

The documentation for this class was generated from the following file:

• doc/api/xorn/geda/netlist/package.py