KiCAD pcbnew scripting
Classes | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
pcbnew.TRACK_List Class Reference
Inheritance diagram for pcbnew.TRACK_List:
Inheritance graph
[legend]

Classes

class  DLISTIter
 

Public Member Functions

def Get (self)
 
def __deref__ (self)
 
def GetFirst (self)
 
def GetLast (self)
 
def Append (self, args)
 
def Insert (self, aNewElement, aElementAfterMe)
 
def Remove (self, aElement)
 
def begin (self)
 
def end (self)
 
def PopFront (self)
 
def PopBack (self)
 
def PushFront (self, aNewElement)
 
def PushBack (self, aNewElement)
 
def __iter__ (self)
 
def __init__ (self)
 
def ClassOf (self, aItem)
 
def Next (self)
 
def Back (self)
 
def Move (self, aMoveVector)
 
def Rotate (self, aRotCentre, aAngle)
 
def Flip (self, aCentre)
 
def SetPosition (self, aPos)
 
def GetPosition (self)
 
def SetWidth (self, aWidth)
 
def GetWidth (self)
 
def SetEnd (self, aEnd)
 
def GetEnd (self)
 
def SetStart (self, aStart)
 
def GetStart (self)
 
def GetEndPoint (self, aEndPoint)
 
def GetBoundingBox (self)
 
def IsLocked (self)
 
def SetLocked (self, aLocked)
 
def GetBestInsertPoint (self, aPcb)
 
def GetStartNetCode (self, NetCode)
 
def GetEndNetCode (self, NetCode)
 
def GetLength (self)
 
def Draw (self, args)
 
def TransformShapeWithClearanceToPolygon (self, aCornerBuffer, aClearanceValue, aCircleToSegmentsCount, aCorrectionFactor)
 
def IsPointOnEnds
 
def IsNull (self)
 
def GetMsgPanelInfo (self, aList)
 
def ShowWidth (self)
 
def Visit (self, inspector, testData, scanTypes)
 
def HitTest (self, args)
 
def GetVia (self, args)
 
def GetTrack (self, aStartTrace, aEndTrace, aEndPoint, aSameNetOnly, aSequential)
 
def GetEndSegments (self, NbSegm, StartTrack, EndTrack)
 
def GetClass (self)
 
def GetClearance
 
def GetSelectMenuText (self)
 
def GetMenuImage (self)
 
def Clone (self)
 
def ViewGetLayers (self, aLayers, aCount)
 
def ViewGetLOD (self, aLayer, aView)
 
def IsConnected (self)
 
def GetNet (self)
 
def SetNet (self, aNetInfo)
 
def GetNetCode (self)
 
def SetNetCode
 
def GetNetname (self)
 
def GetShortNetname (self)
 
def GetNetClass (self)
 
def GetNetClassName (self)
 
def SetLocalRatsnestVisible (self, aVisible)
 
def GetLocalRatsnestVisible (self)
 
def GetCenter (self)
 
def GetParent (self)
 
def GetLayer (self)
 
def GetLayerSet (self)
 
def SetLayer (self, aLayer)
 
def SwapData (self, aImage)
 
def IsOnLayer (self, aLayer)
 
def IsTrack (self)
 
def UnLink (self)
 
def DeleteStructure (self)
 
def ShowShape (self, aShape)
 
def GetBoard (self)
 
def GetLayerName (self)
 
def FormatInternalUnits (self, args)
 
def FormatAngle (self, aAngle)
 
def Type (self)
 
def SetTimeStamp (self, aNewTimeStamp)
 
def GetTimeStamp (self)
 
def GetList (self)
 
def SetParent (self, aParent)
 
def SetList (self, aList)
 
def IsNew (self)
 
def IsModified (self)
 
def IsMoving (self)
 
def IsDragging (self)
 
def IsWireImage (self)
 
def IsSelected (self)
 
def IsResized (self)
 
def IsHighlighted (self)
 
def IsBrightened (self)
 
def SetWireImage (self)
 
def SetSelected (self)
 
def SetHighlighted (self)
 
def SetBrightened (self)
 
def ClearSelected (self)
 
def ClearHighlighted (self)
 
def ClearBrightened (self)
 
def SetModified (self)
 
def GetState (self, type)
 
def SetState (self, type, state)
 
def GetStatus (self)
 
def SetStatus (self, aStatus)
 
def SetFlags (self, aMask)
 
def ClearFlags
 
def GetFlags (self)
 
def SetForceVisible (self, aEnable)
 
def IterateForward (self, listStart, inspector, testData, scanTypes)
 
def Matches (self, aSearchData, aAuxData, aFindLocation)
 
def Replace (self, args)
 
def IsReplaceable (self)
 
def __lt__ (self, aItem)
 
def Sort (self, aLeft, aRight)
 
def ViewBBox (self)
 
- Public Member Functions inherited from pcbnew.DHEAD
def __init__ (self, args, kwargs)
 
def DeleteAll (self)
 
def SetOwnership (self, Iown)
 
def GetCount (self)
 

Public Attributes

 this
 

Static Public Attributes

tuple ret = self.last.Get()
 
 ret = self.last
 
tuple start = _swig_property(_pcbnew.TRACK_List_start_get, _pcbnew.TRACK_List_start_set)
 
tuple end = _swig_property(_pcbnew.TRACK_List_end_get, _pcbnew.TRACK_List_end_set)
 
tuple m_Param = _swig_property(_pcbnew.TRACK_List_m_Param_get, _pcbnew.TRACK_List_m_Param_set)
 

Detailed Description

Proxy of C++ DLIST<(TRACK)> class

Definition at line 23578 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.TRACK_List.__init__ (   self)
__init__(DLIST<(TRACK)> self) -> TRACK_List

Definition at line 23695 of file pcbnew.py.

Member Function Documentation

def pcbnew.TRACK_List.__deref__ (   self)
__deref__(TRACK_List self) -> TRACK

Definition at line 23595 of file pcbnew.py.

def pcbnew.TRACK_List.__iter__ (   self)

Definition at line 23690 of file pcbnew.py.

def pcbnew.TRACK_List.__lt__ (   self,
  aItem 
)
__lt__(TRACK_List self, EDA_ITEM aItem) -> bool

Definition at line 25135 of file pcbnew.py.

def pcbnew.TRACK_List.Append (   self,
  args 
)
Append(TRACK_List self, TRACK aNewElement)
Append(TRACK_List self, TRACK_List aList)

Definition at line 23610 of file pcbnew.py.

def pcbnew.TRACK_List.Back (   self)
Back(TRACK_List self) -> TRACK

TRACK* TRACK::Back() const 

Definition at line 23731 of file pcbnew.py.

def pcbnew.TRACK_List.begin (   self)
begin(TRACK_List self) -> TRACK

Definition at line 23628 of file pcbnew.py.

def pcbnew.TRACK_List.ClassOf (   self,
  aItem 
)
ClassOf(TRACK_List self, EDA_ITEM aItem) -> bool

Definition at line 23705 of file pcbnew.py.

def pcbnew.TRACK_List.ClearBrightened (   self)
ClearBrightened(TRACK_List self)

void
EDA_ITEM::ClearBrightened() 

Definition at line 24942 of file pcbnew.py.

def pcbnew.TRACK_List.ClearFlags (   self,
  aMask = -1 
)
ClearFlags(TRACK_List self, STATUS_FLAGS aMask=-1)
ClearFlags(TRACK_List self)

void
EDA_ITEM::ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS) 

Definition at line 25012 of file pcbnew.py.

def pcbnew.TRACK_List.ClearHighlighted (   self)
ClearHighlighted(TRACK_List self)

void
EDA_ITEM::ClearHighlighted() 

Definition at line 24932 of file pcbnew.py.

def pcbnew.TRACK_List.ClearSelected (   self)
ClearSelected(TRACK_List self)

void
EDA_ITEM::ClearSelected() 

Definition at line 24922 of file pcbnew.py.

def pcbnew.TRACK_List.Clone (   self)
Clone(TRACK_List self) -> EDA_ITEM

EDA_ITEM * TRACK::Clone() const
override

Function Clone creates a duplicate of this item with linked list
members set to NULL.

The default version will return NULL in release builds and likely
crash the program. In debug builds, a warning message indicating the
derived class has not implemented cloning. This really should be a
pure virtual function. Due to the fact that there are so many objects
derived from EDA_ITEM, the decision was made to return NULL until all
the objects derived from EDA_ITEM implement cloning. Once that
happens, this function should be made pure.

A clone of the item. 

Definition at line 24307 of file pcbnew.py.

def pcbnew.TRACK_List.DeleteStructure (   self)
DeleteStructure(TRACK_List self)

void
BOARD_ITEM::DeleteStructure()

Function DeleteStructure deletes this object after UnLink()ing it from
its owner if it has one. 

Definition at line 24667 of file pcbnew.py.

def pcbnew.TRACK_List.Draw (   self,
  args 
)
Draw(TRACK_List self, EDA_DRAW_PANEL * panel, wxDC * DC, GR_DRAWMODE aDrawMode, wxPoint aOffset)
Draw(TRACK_List self, EDA_DRAW_PANEL * panel, wxDC * DC, GR_DRAWMODE aDrawMode)

void TRACK::Draw(EDA_DRAW_PANEL
*panel, wxDC *DC, GR_DRAWMODE aDrawMode, const wxPoint
&aOffset=ZeroOffset) override

Function Draw BOARD_ITEMs have their own color information. 

Definition at line 23989 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.TRACK_List.end (   self)
end(TRACK_List self) -> TRACK

Definition at line 23633 of file pcbnew.py.

def pcbnew.TRACK_List.Flip (   self,
  aCentre 
)
Flip(TRACK_List self, wxPoint aCentre)

void TRACK::Flip(const wxPoint
&aCentre) override

Function Flip Flip this object, i.e.

change the board side for this object

Parameters:
-----------

aCentre:  - the rotation point. 

Definition at line 23776 of file pcbnew.py.

def pcbnew.TRACK_List.FormatAngle (   self,
  aAngle 
)
FormatAngle(TRACK_List self, double aAngle) -> string

Definition at line 24722 of file pcbnew.py.

def pcbnew.TRACK_List.FormatInternalUnits (   self,
  args 
)
FormatInternalUnits(TRACK_List self, int aValue) -> string
FormatInternalUnits(TRACK_List self, wxPoint aPoint) -> string
FormatInternalUnits(TRACK_List self, wxSize aSize) -> string

Definition at line 24713 of file pcbnew.py.

def pcbnew.TRACK_List.Get (   self)
Get(TRACK_List self) -> TRACK

Definition at line 23590 of file pcbnew.py.

def pcbnew.TRACK_List.GetBestInsertPoint (   self,
  aPcb 
)
GetBestInsertPoint(TRACK_List self, BOARD aPcb) -> TRACK

TRACK *
TRACK::GetBestInsertPoint(BOARD *aPcb)

Function GetBestInsertPoint searches the "best" insertion point
within the track linked list.

The best point is the begging of the corresponding net code section.
(The BOARD::m_Track and BOARD::m_Zone lists are sorted by netcode.)

Parameters:
-----------

aPcb:  The BOARD to search for the insertion point.

TRACK* - the item found in the linked list (or NULL if no track) 

Definition at line 23931 of file pcbnew.py.

def pcbnew.TRACK_List.GetBoard (   self)
GetBoard(TRACK_List self) -> BOARD

BOARD *
BOARD_ITEM::GetBoard() const

Function GetBoard returns the BOARD in which this BOARD_ITEM resides,
or NULL if none. 

Definition at line 24685 of file pcbnew.py.

def pcbnew.TRACK_List.GetBoundingBox (   self)
GetBoundingBox(TRACK_List self) -> EDA_RECT

const EDA_RECT
TRACK::GetBoundingBox() const override

Function GetBoundingBox returns the orthogonal, bounding box of this
object for display purposes.

This box should be an enclosing perimeter for visible components of
this object, and the units should be in the pcb or schematic
coordinate system. It is OK to overestimate the size by a few counts.

Definition at line 23887 of file pcbnew.py.

def pcbnew.TRACK_List.GetCenter (   self)
GetCenter(TRACK_List self) -> wxPoint

virtual const wxPoint
BOARD_ITEM::GetCenter() const

Function GetCenter()

This defaults to the same point as returned by GetPosition(), unless
overridden

centre point of the item 

Definition at line 24522 of file pcbnew.py.

def pcbnew.TRACK_List.GetClass (   self)
GetClass(TRACK_List self) -> wxString

wxString TRACK::GetClass()
const override

Function GetClass returns the class name.

wxString 

Definition at line 24232 of file pcbnew.py.

def pcbnew.TRACK_List.GetClearance (   self,
  aItem = None 
)
GetClearance(TRACK_List self, BOARD_CONNECTED_ITEM aItem=None) -> int
GetClearance(TRACK_List self) -> int

int
TRACK::GetClearance(BOARD_CONNECTED_ITEM *aItem=NULL) const override

Function GetClearance returns the clearance in internal units.

If aItem is not NULL then the returned clearance is the greater of
this object's clearance and aItem's clearance. If aItem is NULL, then
this objects clearance is returned.

Parameters:
-----------

aItem:  is another BOARD_CONNECTED_ITEM or NULL

int - the clearance in internal units. 

Definition at line 24246 of file pcbnew.py.

def pcbnew.TRACK_List.GetEnd (   self)
GetEnd(TRACK_List self) -> wxPoint

const wxPoint& TRACK::GetEnd()
const 

Definition at line 23845 of file pcbnew.py.

def pcbnew.TRACK_List.GetEndNetCode (   self,
  NetCode 
)
GetEndNetCode(TRACK_List self, int NetCode) -> TRACK

TRACK *
TRACK::GetEndNetCode(int NetCode) 

Definition at line 23964 of file pcbnew.py.

def pcbnew.TRACK_List.GetEndPoint (   self,
  aEndPoint 
)
GetEndPoint(TRACK_List self, ENDPOINT_T aEndPoint) -> wxPoint

const wxPoint&
TRACK::GetEndPoint(ENDPOINT_T aEndPoint) const

Return the selected endpoint (start or end) 

Definition at line 23875 of file pcbnew.py.

def pcbnew.TRACK_List.GetEndSegments (   self,
  NbSegm,
  StartTrack,
  EndTrack 
)
GetEndSegments(TRACK_List self, int NbSegm, TRACK ** StartTrack, TRACK ** EndTrack) -> int

int
TRACK::GetEndSegments(int NbSegm, TRACK **StartTrack, TRACK
**EndTrack)

Function GetEndSegments get the segments connected to the end point of
the track.

return 1 if OK, 0 when a track is a closed loop and the beginning and
the end of the track in *StartTrack and *EndTrack Modify *StartTrack
en *EndTrack : (*StartTrack)->m_Start coordinate is the beginning of
the track (*EndTrack)->m_End coordinate is the end of the track
Segments connected must be consecutive in list 

Definition at line 24212 of file pcbnew.py.

def pcbnew.TRACK_List.GetFirst (   self)
GetFirst(TRACK_List self) -> TRACK

Definition at line 23600 of file pcbnew.py.

def pcbnew.TRACK_List.GetFlags (   self)
GetFlags(TRACK_List self) -> STATUS_FLAGS

STATUS_FLAGS
EDA_ITEM::GetFlags() const 

Definition at line 25023 of file pcbnew.py.

def pcbnew.TRACK_List.GetLast (   self)
GetLast(TRACK_List self) -> TRACK

Definition at line 23605 of file pcbnew.py.

def pcbnew.TRACK_List.GetLayer (   self)
GetLayer(TRACK_List self) -> PCB_LAYER_ID

PCB_LAYER_ID
BOARD_ITEM::GetLayer() const

Function GetLayer returns the primary layer this item is on. 

Definition at line 24549 of file pcbnew.py.

def pcbnew.TRACK_List.GetLayerName (   self)
GetLayerName(TRACK_List self) -> wxString

wxString
BOARD_ITEM::GetLayerName() const

Function GetLayerName returns the name of the PCB layer on which the
item resides.

wxString containing the layer name associated with this item. 

Definition at line 24698 of file pcbnew.py.

def pcbnew.TRACK_List.GetLayerSet (   self)
GetLayerSet(TRACK_List self) -> LSET

virtual LSET
BOARD_ITEM::GetLayerSet() const

Function GetLayerSet returns a "layer mask", which is a bitmap of
all layers on which the TRACK segment or VIA physically resides.

int - a layer mask, see layers_id_colors_visibility.h. 

Definition at line 24561 of file pcbnew.py.

def pcbnew.TRACK_List.GetLength (   self)
GetLength(TRACK_List self) -> double

double TRACK::GetLength()
const

Function GetLength returns the length of the track using the
hypotenuse calculation.

double - the length of the track 

Definition at line 23974 of file pcbnew.py.

def pcbnew.TRACK_List.GetList (   self)
GetList(TRACK_List self) -> DHEAD

DHEAD* EDA_ITEM::GetList()
const 

Definition at line 24762 of file pcbnew.py.

def pcbnew.TRACK_List.GetLocalRatsnestVisible (   self)
GetLocalRatsnestVisible(TRACK_List self) -> bool

bool BOARD_CONNECTED_ITEM::GetLocalRatsnestVisible() const 

Definition at line 24513 of file pcbnew.py.

def pcbnew.TRACK_List.GetMenuImage (   self)
GetMenuImage(TRACK_List self) -> BITMAP_DEF

BITMAP_DEF
TRACK::GetMenuImage() const override

Function GetMenuImage returns a pointer to an image to be used in
menus.

The default version returns the right arrow image. Override this
function to provide object specific menu images. The menu image
associated with the item. 

Definition at line 24290 of file pcbnew.py.

def pcbnew.TRACK_List.GetMsgPanelInfo (   self,
  aList 
)
GetMsgPanelInfo(TRACK_List self, std::vector< MSG_PANEL_ITEM,std::allocator< MSG_PANEL_ITEM > > & aList)

void
TRACK::GetMsgPanelInfo(std::vector< MSG_PANEL_ITEM > &aList) override

Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects
with it's internal state for display purposes.

This method replaces DisplayInfo() so that KiCad objects no longer
have any knowledge of wxWidgets UI objects.

Parameters:
-----------

aList:  is the list to populate. 

Definition at line 24061 of file pcbnew.py.

def pcbnew.TRACK_List.GetNet (   self)
GetNet(TRACK_List self) -> NETINFO_ITEM

NETINFO_ITEM*
BOARD_CONNECTED_ITEM::GetNet() const

Function GetNet Returns NET_INFO object for a given item. 

Definition at line 24386 of file pcbnew.py.

def pcbnew.TRACK_List.GetNetClass (   self)
GetNetClass(TRACK_List self) -> std::shared_ptr< NETCLASS >

NETCLASSPTR
BOARD_CONNECTED_ITEM::GetNetClass() const

Function GetNetClass returns the NETCLASS for this item. 

Definition at line 24476 of file pcbnew.py.

def pcbnew.TRACK_List.GetNetClassName (   self)
GetNetClassName(TRACK_List self) -> wxString

wxString BOARD_CONNECTED_ITEM::GetNetClassName() const

Function GetNetClassName returns a pointer to the netclass of the
zone.

If the net is not found (can happen when a netlist is reread, and the
net name does not exist, return the default net class (should not
return a null pointer). the Net Class name of this item 

Definition at line 24488 of file pcbnew.py.

def pcbnew.TRACK_List.GetNetCode (   self)
GetNetCode(TRACK_List self) -> int

int
BOARD_CONNECTED_ITEM::GetNetCode() const

Function GetNetCode.

int - the net code. 

Definition at line 24410 of file pcbnew.py.

def pcbnew.TRACK_List.GetNetname (   self)
GetNetname(TRACK_List self) -> wxString

const
wxString& BOARD_CONNECTED_ITEM::GetNetname() const

Function GetNetname.

wxString - the full netname 

Definition at line 24448 of file pcbnew.py.

def pcbnew.TRACK_List.GetParent (   self)
GetParent(TRACK_List self) -> BOARD_ITEM_CONTAINER

BOARD_ITEM_CONTAINER*
BOARD_ITEM::GetParent() const 

Definition at line 24539 of file pcbnew.py.

def pcbnew.TRACK_List.GetPosition (   self)
GetPosition(TRACK_List self) -> wxPoint

const wxPoint&
TRACK::GetPosition() const override 

Definition at line 23805 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.TRACK_List.GetSelectMenuText (   self)
GetSelectMenuText(TRACK_List self) -> wxString

wxString
TRACK::GetSelectMenuText() const override

Function GetSelectMenuText returns the text to display to be used in
the selection clarification context menu when multiple items are found
at the current cursor position.

The default version of this function raises an assertion in the debug
mode and returns a string to indicate that it was not overridden to
provide the object specific text.

The menu text string. 

Definition at line 24270 of file pcbnew.py.

def pcbnew.TRACK_List.GetShortNetname (   self)
GetShortNetname(TRACK_List self) -> wxString

const
wxString& BOARD_CONNECTED_ITEM::GetShortNetname() const

Function GetShortNetname.

wxString - the short netname 

Definition at line 24462 of file pcbnew.py.

def pcbnew.TRACK_List.GetStart (   self)
GetStart(TRACK_List self) -> wxPoint

const wxPoint&
TRACK::GetStart() const 

Definition at line 23865 of file pcbnew.py.

def pcbnew.TRACK_List.GetStartNetCode (   self,
  NetCode 
)
GetStartNetCode(TRACK_List self, int NetCode) -> TRACK

TRACK *
TRACK::GetStartNetCode(int NetCode) 

Definition at line 23954 of file pcbnew.py.

def pcbnew.TRACK_List.GetState (   self,
  type 
)
GetState(TRACK_List self, int type) -> int

int EDA_ITEM::GetState(int
type) const 

Definition at line 24962 of file pcbnew.py.

def pcbnew.TRACK_List.GetStatus (   self)
GetStatus(TRACK_List self) -> STATUS_FLAGS

STATUS_FLAGS
EDA_ITEM::GetStatus() const 

Definition at line 24982 of file pcbnew.py.

def pcbnew.TRACK_List.GetTimeStamp (   self)
GetTimeStamp(TRACK_List self) -> time_t

time_t
EDA_ITEM::GetTimeStamp() const 

Definition at line 24752 of file pcbnew.py.

def pcbnew.TRACK_List.GetTrack (   self,
  aStartTrace,
  aEndTrace,
  aEndPoint,
  aSameNetOnly,
  aSequential 
)
GetTrack(TRACK_List self, TRACK aStartTrace, TRACK aEndTrace, ENDPOINT_T aEndPoint, bool aSameNetOnly, bool aSequential) -> TRACK

TRACK * TRACK::GetTrack(TRACK
*aStartTrace, TRACK *aEndTrace, ENDPOINT_T aEndPoint, bool
aSameNetOnly, bool aSequential)

Function GetTrack returns the trace segment connected to the segment
at aEndPoint from aStartTrace to aEndTrace.

Parameters:
-----------

aStartTrace:  A pointer to the TRACK object to begin searching.

aEndTrace:  A pointer to the TRACK object to stop the search. A NULL
value searches to the end of the list.

aEndPoint:  The start or end point of the segment to test against.

aSameNetOnly:  if true stop searching when the netcode changes

aSequential:  If true, forces a forward sequential search, which is
restartable; the default search can be faster but the position of the
returned track in the list is unpredictable

A TRACK object pointer if found otherwise NULL. 

Definition at line 24180 of file pcbnew.py.

def pcbnew.TRACK_List.GetVia (   self,
  args 
)
GetVia(TRACK_List self, wxPoint aPosition, PCB_LAYER_ID aLayer=UNDEFINED_LAYER) -> VIA
GetVia(TRACK_List self, wxPoint aPosition) -> VIA
GetVia(TRACK_List self, TRACK aEndTrace, wxPoint aPosition, LSET aLayerMask) -> VIA

VIA * TRACK::GetVia(TRACK
*aEndTrace, const wxPoint &aPosition, LSET aLayerMask)

Function GetVia finds the first VIA object at aPosition on aLayer
starting at the trace and ending at aEndTrace.

Parameters:
-----------

aEndTrace:  Pointer to the last TRACK object to end search.

aPosition:  The wxPoint to HitTest() against.

aLayerMask:  The layers to match, pass -1 for a don't care.

A pointer to a VIA object if found, else NULL. 

Definition at line 24154 of file pcbnew.py.

def pcbnew.TRACK_List.GetWidth (   self)
GetWidth(TRACK_List self) -> int

int TRACK::GetWidth() const

Definition at line 23825 of file pcbnew.py.

def pcbnew.TRACK_List.HitTest (   self,
  args 
)
HitTest(TRACK_List self, wxPoint aPosition) -> bool
HitTest(TRACK_List self, EDA_RECT aRect, bool aContained=True, int aAccuracy=0) -> bool
HitTest(TRACK_List self, EDA_RECT aRect, bool aContained=True) -> bool
HitTest(TRACK_List self, EDA_RECT aRect) -> bool

bool TRACK::HitTest(const
EDA_RECT &aRect, bool aContained=true, int aAccuracy=0) const override

Function HitTest tests if the aRect intersects or contains this object
(depending on aContained).

Parameters:
-----------

aRect:  A reference to an EDA_RECT object containg the area to test.

aContained:  Test if aRect contains this object completly.

aAccuracy:  Increase the item bounding box by this amount.

bool - True if aRect contains this object completly or if aRect
intersects the object and aContained is False, otherwise false. 

Definition at line 24126 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.TRACK_List.Insert (   self,
  aNewElement,
  aElementAfterMe 
)
Insert(TRACK_List self, TRACK aNewElement, TRACK aElementAfterMe)

Definition at line 23618 of file pcbnew.py.

def pcbnew.TRACK_List.IsBrightened (   self)
IsBrightened(TRACK_List self) -> bool

bool
EDA_ITEM::IsBrightened() const 

Definition at line 24872 of file pcbnew.py.

def pcbnew.TRACK_List.IsConnected (   self)
IsConnected(TRACK_List self) -> bool

bool
BOARD_CONNECTED_ITEM::IsConnected() const override

>

Function IsConnected() Returns information if the object is derived
from BOARD_CONNECTED_ITEM. True if the object is of
BOARD_CONNECTED_ITEM type, false otherwise. 

Definition at line 24370 of file pcbnew.py.

def pcbnew.TRACK_List.IsDragging (   self)
IsDragging(TRACK_List self) -> bool

bool
EDA_ITEM::IsDragging() const 

Definition at line 24822 of file pcbnew.py.

def pcbnew.TRACK_List.IsHighlighted (   self)
IsHighlighted(TRACK_List self) -> bool

bool
EDA_ITEM::IsHighlighted() const 

Definition at line 24862 of file pcbnew.py.

def pcbnew.TRACK_List.IsLocked (   self)
IsLocked(TRACK_List self) -> bool

bool TRACK::IsLocked() const
override

Function IsLocked.

bool - true if the object is locked, else false 

Definition at line 23905 of file pcbnew.py.

def pcbnew.TRACK_List.IsModified (   self)
IsModified(TRACK_List self) -> bool

bool
EDA_ITEM::IsModified() const 

Definition at line 24802 of file pcbnew.py.

def pcbnew.TRACK_List.IsMoving (   self)
IsMoving(TRACK_List self) -> bool

bool EDA_ITEM::IsMoving()
const 

Definition at line 24812 of file pcbnew.py.

def pcbnew.TRACK_List.IsNew (   self)
IsNew(TRACK_List self) -> bool

bool EDA_ITEM::IsNew() const

Definition at line 24792 of file pcbnew.py.

def pcbnew.TRACK_List.IsNull (   self)
IsNull(TRACK_List self) -> bool

bool TRACK::IsNull()

Function IsNull returns true if segment length is zero. 

Definition at line 24050 of file pcbnew.py.

def pcbnew.TRACK_List.IsOnLayer (   self,
  aLayer 
)
IsOnLayer(TRACK_List self, PCB_LAYER_ID aLayer) -> bool

virtual bool
BOARD_ITEM::IsOnLayer(PCB_LAYER_ID aLayer) const

Function IsOnLayer tests to see if this object is on the given layer.

Is virtual so objects like D_PAD, which reside on multiple layers can
do their own form of testing.

Parameters:
-----------

aLayer:  The layer to test for.

bool - true if on given layer, else false. 

Definition at line 24616 of file pcbnew.py.

def pcbnew.TRACK_List.IsPointOnEnds (   self,
  point,
  min_dist = 0 
)
IsPointOnEnds(TRACK_List self, wxPoint point, int min_dist=0) -> STATUS_FLAGS
IsPointOnEnds(TRACK_List self, wxPoint point) -> STATUS_FLAGS

STATUS_FLAGS
TRACK::IsPointOnEnds(const wxPoint &point, int min_dist=0)

Function IsPointOnEnds returns STARTPOINT if point if near (dist =
min_dist) start point, ENDPOINT if point if near (dist = min_dist) end
point,STARTPOINT|ENDPOINT if point if near (dist = min_dist) both
ends, or 0 if none of the above.

if min_dist < 0: min_dist = track_width/2 

Definition at line 24032 of file pcbnew.py.

def pcbnew.TRACK_List.IsReplaceable (   self)
IsReplaceable(TRACK_List self) -> bool

virtual bool
EDA_ITEM::IsReplaceable() const

Function IsReplaceable.

Override this method in any derived object that supports test find and
replace.

True if the item has replaceable text that can be modified using the
find and replace dialog. 

Definition at line 25117 of file pcbnew.py.

def pcbnew.TRACK_List.IsResized (   self)
IsResized(TRACK_List self) -> bool

bool
EDA_ITEM::IsResized() const 

Definition at line 24852 of file pcbnew.py.

def pcbnew.TRACK_List.IsSelected (   self)
IsSelected(TRACK_List self) -> bool

bool
EDA_ITEM::IsSelected() const 

Definition at line 24842 of file pcbnew.py.

def pcbnew.TRACK_List.IsTrack (   self)
IsTrack(TRACK_List self) -> bool

bool
BOARD_ITEM::IsTrack() const

Function IsTrack tests to see if this object is a track or via (or
microvia).

form of testing. bool - true if a track or via, else false. 

Definition at line 24638 of file pcbnew.py.

def pcbnew.TRACK_List.IsWireImage (   self)
IsWireImage(TRACK_List self) -> bool

bool
EDA_ITEM::IsWireImage() const 

Definition at line 24832 of file pcbnew.py.

def pcbnew.TRACK_List.IterateForward (   self,
  listStart,
  inspector,
  testData,
  scanTypes 
)
IterateForward(TRACK_List self, EDA_ITEM listStart, INSPECTOR inspector, void * testData, KICAD_T const [] scanTypes) -> SEARCH_RESULT

Definition at line 25053 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.TRACK_List.Matches (   self,
  aSearchData,
  aAuxData,
  aFindLocation 
)
Matches(TRACK_List self, wxFindReplaceData & aSearchData, void * aAuxData, wxPoint aFindLocation) -> bool

virtual bool
EDA_ITEM::Matches(wxFindReplaceData &aSearchData, void *aAuxData,
wxPoint *aFindLocation)

Function Matches compares the item against the search criteria in
aSearchData.

The base class returns false since many of the objects derived from
EDA_ITEM do not have any text to search.

Parameters:
-----------

aSearchData:  A reference to a wxFindReplaceData object containing the
search criteria.

aAuxData:  A pointer to optional data required for the search or NULL
if not used.

aFindLocation:  A pointer to a wxPoint object to store the location of
matched item. The pointer can be NULL if it is not used.

True if the item's text matches the search criteria in aSearchData. 

Definition at line 25058 of file pcbnew.py.

def pcbnew.TRACK_List.Move (   self,
  aMoveVector 
)
Move(TRACK_List self, wxPoint aMoveVector)

virtual void TRACK::Move(const
wxPoint &aMoveVector) override

Function Move move this object.

Parameters:
-----------

aMoveVector:  - the move vector for this object. 

Definition at line 23740 of file pcbnew.py.

def pcbnew.TRACK_List.Next (   self)
Next(TRACK_List self) -> TRACK

TRACK* TRACK::Next() const 

Definition at line 23722 of file pcbnew.py.

def pcbnew.TRACK_List.PopBack (   self)
PopBack(TRACK_List self) -> TRACK

Definition at line 23643 of file pcbnew.py.

def pcbnew.TRACK_List.PopFront (   self)
PopFront(TRACK_List self) -> TRACK

Definition at line 23638 of file pcbnew.py.

def pcbnew.TRACK_List.PushBack (   self,
  aNewElement 
)
PushBack(TRACK_List self, TRACK aNewElement)

Definition at line 23653 of file pcbnew.py.

def pcbnew.TRACK_List.PushFront (   self,
  aNewElement 
)
PushFront(TRACK_List self, TRACK aNewElement)

Definition at line 23648 of file pcbnew.py.

def pcbnew.TRACK_List.Remove (   self,
  aElement 
)
Remove(TRACK_List self, TRACK aElement) -> TRACK

Definition at line 23623 of file pcbnew.py.

def pcbnew.TRACK_List.Replace (   self,
  args 
)
Replace(TRACK_List self, wxFindReplaceData & aSearchData, wxString aText) -> bool
Replace(TRACK_List self, wxFindReplaceData & aSearchData, void * aAuxData=None) -> bool
Replace(TRACK_List self, wxFindReplaceData & aSearchData) -> bool

virtual bool
EDA_ITEM::Replace(wxFindReplaceData &aSearchData, void *aAuxData=NULL)

Function Replace performs a text replace using the find and replace
criteria in aSearchData on items that support text find and replace.

This function must be overridden for items that support text replace.

Parameters:
-----------

aSearchData:  A reference to a wxFindReplaceData object containing the
search and replace criteria.

aAuxData:  A pointer to optional data required for the search or NULL
if not used.

True if the item text was modified, otherwise false. 

Definition at line 25089 of file pcbnew.py.

def pcbnew.TRACK_List.Rotate (   self,
  aRotCentre,
  aAngle 
)
Rotate(TRACK_List self, wxPoint aRotCentre, double aAngle)

void TRACK::Rotate(const
wxPoint &aRotCentre, double aAngle) override

Function Rotate Rotate this object.

Parameters:
-----------

aRotCentre:  - the rotation point.

aAngle:  - the rotation angle in 0.1 degree. 

Definition at line 23757 of file pcbnew.py.

def pcbnew.TRACK_List.SetBrightened (   self)
SetBrightened(TRACK_List self)

void
EDA_ITEM::SetBrightened() 

Definition at line 24912 of file pcbnew.py.

def pcbnew.TRACK_List.SetEnd (   self,
  aEnd 
)
SetEnd(TRACK_List self, wxPoint aEnd)

void TRACK::SetEnd(const
wxPoint &aEnd) 

Definition at line 23835 of file pcbnew.py.

def pcbnew.TRACK_List.SetFlags (   self,
  aMask 
)
SetFlags(TRACK_List self, STATUS_FLAGS aMask)

void
EDA_ITEM::SetFlags(STATUS_FLAGS aMask) 

Definition at line 25002 of file pcbnew.py.

def pcbnew.TRACK_List.SetForceVisible (   self,
  aEnable 
)
SetForceVisible(TRACK_List self, bool aEnable)

void
EDA_ITEM::SetForceVisible(bool aEnable)

Function SetForceVisible is used to set and cleag force visible flag
used to force the item to be drawn even if it's draw attribute is set
to not visible.

Parameters:
-----------

aEnable:  True forces the item to be drawn. False uses the item's
visibility setting to determine if the item is to be drawn. 

Definition at line 25033 of file pcbnew.py.

def pcbnew.TRACK_List.SetHighlighted (   self)
SetHighlighted(TRACK_List self)

void
EDA_ITEM::SetHighlighted() 

Definition at line 24902 of file pcbnew.py.

def pcbnew.TRACK_List.SetLayer (   self,
  aLayer 
)
SetLayer(TRACK_List self, PCB_LAYER_ID aLayer)

virtual void
BOARD_ITEM::SetLayer(PCB_LAYER_ID aLayer)

Function SetLayer sets the layer this item is on.

Parameters:
-----------

aLayer:  The layer number. is virtual because some items (in fact:
class DIMENSION) have a slightly different initialization 

Definition at line 24576 of file pcbnew.py.

def pcbnew.TRACK_List.SetList (   self,
  aList 
)
SetList(TRACK_List self, DHEAD aList)

void
EDA_ITEM::SetList(DHEAD *aList) 

Definition at line 24782 of file pcbnew.py.

def pcbnew.TRACK_List.SetLocalRatsnestVisible (   self,
  aVisible 
)
SetLocalRatsnestVisible(TRACK_List self, bool aVisible)

void BOARD_CONNECTED_ITEM::SetLocalRatsnestVisible(bool aVisible) 

Definition at line 24504 of file pcbnew.py.

def pcbnew.TRACK_List.SetLocked (   self,
  aLocked 
)
SetLocked(TRACK_List self, bool aLocked)

void TRACK::SetLocked(bool
aLocked) override

Function SetLocked modifies 'lock' status for of the item. 

Definition at line 23919 of file pcbnew.py.

def pcbnew.TRACK_List.SetModified (   self)
SetModified(TRACK_List self)

void
EDA_ITEM::SetModified() 

Definition at line 24952 of file pcbnew.py.

def pcbnew.TRACK_List.SetNet (   self,
  aNetInfo 
)
SetNet(TRACK_List self, NETINFO_ITEM aNetInfo)

void
BOARD_CONNECTED_ITEM::SetNet(NETINFO_ITEM *aNetInfo)

Function SetNet Sets a NET_INFO object for the item. 

Definition at line 24398 of file pcbnew.py.

def pcbnew.TRACK_List.SetNetCode (   self,
  aNetCode,
  aNoAssert = False 
)
SetNetCode(TRACK_List self, int aNetCode, bool aNoAssert=False) -> bool
SetNetCode(TRACK_List self, int aNetCode) -> bool

bool
BOARD_CONNECTED_ITEM::SetNetCode(int aNetCode, bool aNoAssert=false)

Function SetNetCode sets net using a net code.

Parameters:
-----------

aNetCode:  is a net code for the new net. It has to exist in
NETINFO_LIST held by BOARD.

aNoAssert:  if true, do not assert that the net exists. Otherwise,
item is assigned to the unconnected net.

true on success, false if the net did not exist 

Definition at line 24424 of file pcbnew.py.

def pcbnew.TRACK_List.SetParent (   self,
  aParent 
)
SetParent(TRACK_List self, EDA_ITEM aParent)

void
EDA_ITEM::SetParent(EDA_ITEM *aParent) 

Definition at line 24772 of file pcbnew.py.

def pcbnew.TRACK_List.SetPosition (   self,
  aPos 
)
SetPosition(TRACK_List self, wxPoint aPos)

void
TRACK::SetPosition(const wxPoint &aPos) override 

Definition at line 23795 of file pcbnew.py.

def pcbnew.TRACK_List.SetSelected (   self)
SetSelected(TRACK_List self)

void
EDA_ITEM::SetSelected() 

Definition at line 24892 of file pcbnew.py.

def pcbnew.TRACK_List.SetStart (   self,
  aStart 
)
SetStart(TRACK_List self, wxPoint aStart)

void TRACK::SetStart(const
wxPoint &aStart) 

Definition at line 23855 of file pcbnew.py.

def pcbnew.TRACK_List.SetState (   self,
  type,
  state 
)
SetState(TRACK_List self, int type, int state)

void
EDA_ITEM::SetState(int type, int state) 

Definition at line 24972 of file pcbnew.py.

def pcbnew.TRACK_List.SetStatus (   self,
  aStatus 
)
SetStatus(TRACK_List self, STATUS_FLAGS aStatus)

void
EDA_ITEM::SetStatus(STATUS_FLAGS aStatus) 

Definition at line 24992 of file pcbnew.py.

def pcbnew.TRACK_List.SetTimeStamp (   self,
  aNewTimeStamp 
)
SetTimeStamp(TRACK_List self, time_t aNewTimeStamp)

void
EDA_ITEM::SetTimeStamp(time_t aNewTimeStamp) 

Definition at line 24742 of file pcbnew.py.

def pcbnew.TRACK_List.SetWidth (   self,
  aWidth 
)
SetWidth(TRACK_List self, int aWidth)

void TRACK::SetWidth(int
aWidth) 

Definition at line 23815 of file pcbnew.py.

def pcbnew.TRACK_List.SetWireImage (   self)
SetWireImage(TRACK_List self)

void
EDA_ITEM::SetWireImage() 

Definition at line 24882 of file pcbnew.py.

def pcbnew.TRACK_List.ShowShape (   self,
  aShape 
)
ShowShape(TRACK_List self, STROKE_T aShape) -> wxString

Definition at line 24680 of file pcbnew.py.

def pcbnew.TRACK_List.ShowWidth (   self)
ShowWidth(TRACK_List self) -> wxString

wxString TRACK::ShowWidth()
const

Function ShowWidth returns the width of the track in displayable user
units. 

Definition at line 24082 of file pcbnew.py.

def pcbnew.TRACK_List.Sort (   self,
  aLeft,
  aRight 
)
Sort(TRACK_List self, EDA_ITEM aLeft, EDA_ITEM aRight) -> bool

Definition at line 25140 of file pcbnew.py.

def pcbnew.TRACK_List.SwapData (   self,
  aImage 
)
SwapData(TRACK_List self, BOARD_ITEM aImage)

void
BOARD_ITEM::SwapData(BOARD_ITEM *aImage)

Swap data between aItem and aImage.

aItem and aImage should have the same type Used in undo redo command
to swap values between an item and its copy Only values like layer,
size .. which are modified by edition are swapped, not the pointers
like Pnext and Pback because aItem is not changed in the linked list

Parameters:
-----------

aImage:  = the item image which contains data to swap 

Definition at line 24594 of file pcbnew.py.

def pcbnew.TRACK_List.TransformShapeWithClearanceToPolygon (   self,
  aCornerBuffer,
  aClearanceValue,
  aCircleToSegmentsCount,
  aCorrectionFactor 
)
TransformShapeWithClearanceToPolygon(TRACK_List self, SHAPE_POLY_SET aCornerBuffer, int aClearanceValue, int aCircleToSegmentsCount, double aCorrectionFactor)

void TRACK::TransformShapeWithClearanceToPolygon(SHAPE_POLY_SET
&aCornerBuffer, int aClearanceValue, int aCircleToSegmentsCount,
double aCorrectionFactor) const

Function TransformShapeWithClearanceToPolygon Convert the track shape
to a closed polygon Used in filling zones calculations Circles (vias)
and arcs (ends of tracks) are approximated by segments.

Parameters:
-----------

aCornerBuffer:  = a buffer to store the polygon

aClearanceValue:  = the clearance around the pad

aCircleToSegmentsCount:  = the number of segments to approximate a
circle

aCorrectionFactor:  = the correction to apply to circles radius to
keep clearance when the circle is approximated by segment bigger or
equal to the real clearance value (usually near from 1.0) 

Definition at line 24003 of file pcbnew.py.

def pcbnew.TRACK_List.Type (   self)
Type(TRACK_List self) -> KICAD_T

KICAD_T EDA_ITEM::Type() const

Function Type()

returns the type of object. This attribute should never be changed
after a constructor sets it, so there is no public "setter" method.
KICAD_T - the type of object. 

Definition at line 24727 of file pcbnew.py.

def pcbnew.TRACK_List.UnLink (   self)
UnLink(TRACK_List self)

void BOARD_ITEM::UnLink()

Function UnLink detaches this object from its owner.

This base class implementation should work for all derived classes
which are held in a DLIST<>. 

Definition at line 24653 of file pcbnew.py.

Here is the caller graph for this function:

def pcbnew.TRACK_List.ViewBBox (   self)
ViewBBox(TRACK_List self) -> BOX2I const

const BOX2I
EDA_ITEM::ViewBBox() const override

Function ViewBBox() returns the bounding box of the item covering all
its layers.

BOX2I - the current bounding box 

Definition at line 25145 of file pcbnew.py.

def pcbnew.TRACK_List.ViewGetLayers (   self,
  aLayers,
  aCount 
)
ViewGetLayers(TRACK_List self, int [] aLayers, int & aCount)

void
TRACK::ViewGetLayers(int aLayers[], int &aCount) const override

Function ViewGetLayers() Returns the all the layers within the VIEW
the object is painted on.

For instance, a D_PAD spans zero or more copper layers and a few
technical layers. ViewDraw() or PAINTER::Draw() is repeatedly called
for each of the layers returned by ViewGetLayers(), depending on the
rendering order.

Parameters:
-----------

aLayers[]:  output layer index array

aCount:  number of layer indices in aLayers[] 

Definition at line 24330 of file pcbnew.py.

def pcbnew.TRACK_List.ViewGetLOD (   self,
  aLayer,
  aView 
)
ViewGetLOD(TRACK_List self, int aLayer, KIGFX::VIEW * aView) -> unsigned int

unsigned int
TRACK::ViewGetLOD(int aLayer, KIGFX::VIEW *aView) const override

Function ViewGetLOD() Returns the level of detail of the item.

A level of detail is the minimal VIEW scale that is sufficient for an
item to be shown on a given layer. 

Definition at line 24355 of file pcbnew.py.

def pcbnew.TRACK_List.Visit (   self,
  inspector,
  testData,
  scanTypes 
)
Visit(TRACK_List self, INSPECTOR inspector, void * testData, KICAD_T const [] scanTypes) -> SEARCH_RESULT

SEARCH_RESULT
TRACK::Visit(INSPECTOR inspector, void *testData, const KICAD_T
scanTypes[]) override

Function Visit may be re-implemented for each derived class in order
to handle all the types given by its member data.

Implementations should call inspector->Inspect() on types in
scanTypes[], and may use IterateForward() to do so on lists of such
data.

Parameters:
-----------

inspector:  An INSPECTOR instance to use in the inspection.

testData:  Arbitrary data used by the inspector.

scanTypes:  Which KICAD_T types are of interest and the order is
significant too, terminated by EOT.

SEARCH_RESULT SEARCH_QUIT if the Iterator is to stop the scan, else
SCAN_CONTINUE, and determined by the inspector. 

Definition at line 24095 of file pcbnew.py.

Member Data Documentation

tuple pcbnew.TRACK_List.end = _swig_property(_pcbnew.TRACK_List_end_get, _pcbnew.TRACK_List_end_set)
static

Definition at line 23716 of file pcbnew.py.

tuple pcbnew.TRACK_List.m_Param = _swig_property(_pcbnew.TRACK_List_m_Param_get, _pcbnew.TRACK_List_m_Param_set)
static

Definition at line 23720 of file pcbnew.py.

tuple pcbnew.TRACK_List.ret = self.last.Get()
static

Definition at line 23677 of file pcbnew.py.

pcbnew.TRACK_List.ret = self.last
static

Definition at line 23679 of file pcbnew.py.

tuple pcbnew.TRACK_List.start = _swig_property(_pcbnew.TRACK_List_start_get, _pcbnew.TRACK_List_start_set)
static

Definition at line 23712 of file pcbnew.py.

pcbnew.TRACK_List.this

Definition at line 23701 of file pcbnew.py.


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