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

Public Member Functions

def __init__ (self, args)
 
def DrawMarker (self, aPanel, aDC, aDrawMode, aOffset)
 
def GetPos (self)
 
def SetColor (self, aColor)
 
def SetErrorLevel (self, aErrorLevel)
 
def GetErrorLevel (self)
 
def SetMarkerType (self, aMarkerType)
 
def GetMarkerType (self)
 
def SetData (self, args)
 
def SetAuxiliaryData (self, aAuxiliaryText, aAuxiliaryPos)
 
def SetShowNoCoordinate (self)
 
def GetReporter (self)
 
def DisplayMarkerInfo (self, aFrame)
 
def HitTestMarker (self, ref_pos)
 
def GetBoundingBoxMarker (self)
 

Public Attributes

 this
 

Static Public Attributes

 MARKER_UNSPEC = _pcbnew.MARKER_BASE_MARKER_UNSPEC
 
 MARKER_ERC = _pcbnew.MARKER_BASE_MARKER_ERC
 
 MARKER_PCB = _pcbnew.MARKER_BASE_MARKER_PCB
 
 MARKER_SIMUL = _pcbnew.MARKER_BASE_MARKER_SIMUL
 
 MARKER_SEVERITY_UNSPEC = _pcbnew.MARKER_BASE_MARKER_SEVERITY_UNSPEC
 
 MARKER_SEVERITY_INFO = _pcbnew.MARKER_BASE_MARKER_SEVERITY_INFO
 
 MARKER_SEVERITY_WARNING = _pcbnew.MARKER_BASE_MARKER_SEVERITY_WARNING
 
 MARKER_SEVERITY_ERROR = _pcbnew.MARKER_BASE_MARKER_SEVERITY_ERROR
 
tuple m_Pos = _swig_property(_pcbnew.MARKER_BASE_m_Pos_get, _pcbnew.MARKER_BASE_m_Pos_set)
 

Detailed Description

C++ includes: class_marker_base.h

Definition at line 3382 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.MARKER_BASE.__init__ (   self,
  args 
)
__init__(MARKER_BASE self) -> MARKER_BASE
__init__(MARKER_BASE self, int aErrorCode, wxPoint aMarkerPos, wxString aText, wxPoint aPos, wxString bText, wxPoint bPos) -> MARKER_BASE
__init__(MARKER_BASE self, int aErrorCode, wxPoint aMarkerPos, wxString aText, wxPoint aPos) -> MARKER_BASE
__init__(MARKER_BASE self, MARKER_BASE aMarker) -> MARKER_BASE

MARKER_BASE::MARKER_BASE(const MARKER_BASE &aMarker)

Contructor makes a copy of aMarker but does not copy the DRC_ITEM.

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

aMarker:  The marker to copy. 

Definition at line 3405 of file pcbnew.py.

Member Function Documentation

def pcbnew.MARKER_BASE.DisplayMarkerInfo (   self,
  aFrame 
)
DisplayMarkerInfo(MARKER_BASE self, EDA_DRAW_FRAME * aFrame)

void
MARKER_BASE::DisplayMarkerInfo(EDA_DRAW_FRAME *aFrame)

Function DisplayMarkerInfo displays the full info of this marker, in a
HTML window. 

Definition at line 3584 of file pcbnew.py.

def pcbnew.MARKER_BASE.DrawMarker (   self,
  aPanel,
  aDC,
  aDrawMode,
  aOffset 
)
DrawMarker(MARKER_BASE self, EDA_DRAW_PANEL * aPanel, wxDC * aDC, GR_DRAWMODE aDrawMode, wxPoint aOffset)

void
MARKER_BASE::DrawMarker(EDA_DRAW_PANEL *aPanel, wxDC *aDC, GR_DRAWMODE
aDrawMode, const wxPoint &aOffset)

Function DrawMarker draws the shape is the polygon defined in
m_Corners (array of wxPoints). 

Definition at line 3429 of file pcbnew.py.

def pcbnew.MARKER_BASE.GetBoundingBoxMarker (   self)
GetBoundingBoxMarker(MARKER_BASE self) -> EDA_RECT

EDA_RECT
MARKER_BASE::GetBoundingBoxMarker() const

Function GetBoundingBoxMarker 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 3617 of file pcbnew.py.

def pcbnew.MARKER_BASE.GetErrorLevel (   self)
GetErrorLevel(MARKER_BASE self) -> MARKER_BASE::MARKER_SEVERITY

MARKER_SEVERITY
MARKER_BASE::GetErrorLevel() const 

Definition at line 3479 of file pcbnew.py.

def pcbnew.MARKER_BASE.GetMarkerType (   self)
GetMarkerType(MARKER_BASE self) -> enum MARKER_BASE::TYPEMARKER

enum TYPEMARKER
MARKER_BASE::GetMarkerType() const 

Definition at line 3501 of file pcbnew.py.

def pcbnew.MARKER_BASE.GetPos (   self)
GetPos(MARKER_BASE self) -> wxPoint

const wxPoint&
MARKER_BASE::GetPos() const

Function GetPos returns the position of this MARKER, const. 

Definition at line 3443 of file pcbnew.py.

def pcbnew.MARKER_BASE.GetReporter (   self)
GetReporter(MARKER_BASE self) -> DRC_ITEM const &

const DRC_ITEM&
MARKER_BASE::GetReporter() const

Function GetReporter returns the DRC_ITEM held within this MARKER so
that its interface may be used.

const& DRC_ITEM 

Definition at line 3569 of file pcbnew.py.

def pcbnew.MARKER_BASE.HitTestMarker (   self,
  ref_pos 
)
HitTestMarker(MARKER_BASE self, wxPoint ref_pos) -> bool

bool
MARKER_BASE::HitTestMarker(const wxPoint &ref_pos) const

Function HitTestMarker tests if the given wxPoint is within the bounds
of this object.

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

ref_pos:  A wxPoint to test

bool - true if a hit, else false 

Definition at line 3597 of file pcbnew.py.

def pcbnew.MARKER_BASE.SetAuxiliaryData (   self,
  aAuxiliaryText,
  aAuxiliaryPos 
)
SetAuxiliaryData(MARKER_BASE self, wxString aAuxiliaryText, wxPoint aAuxiliaryPos)

void
MARKER_BASE::SetAuxiliaryData(const wxString &aAuxiliaryText, const
wxPoint &aAuxiliaryPos)

Function SetAuxiliaryData initialize data for the second (auxiliary)
item.

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

aAuxiliaryText:  = the second text (main text) concerning the second
schematic or board item

aAuxiliaryPos:  = position the second item 

Definition at line 3537 of file pcbnew.py.

def pcbnew.MARKER_BASE.SetColor (   self,
  aColor 
)
SetColor(MARKER_BASE self, COLOR4D aColor)

void
MARKER_BASE::SetColor(COLOR4D aColor)

Function SetColor Set the color of this marker. 

Definition at line 3455 of file pcbnew.py.

def pcbnew.MARKER_BASE.SetData (   self,
  args 
)
SetData(MARKER_BASE self, int aErrorCode, wxPoint aMarkerPos, wxString aText, wxPoint aPos, wxString bText, wxPoint bPos)
SetData(MARKER_BASE self, int aErrorCode, wxPoint aMarkerPos, wxString aText, wxPoint aPos)

void
MARKER_BASE::SetData(int aErrorCode, const wxPoint &aMarkerPos, const
wxString &aText, const wxPoint &aPos)

Function SetData fills in all the reportable data associated with a
MARKER.

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

aErrorCode:  The categorizing identifier for an error

aMarkerPos:  The position of the MARKER on the BOARD

aText:  Text describing the object

aPos:  The position of the object 

Definition at line 3511 of file pcbnew.py.

def pcbnew.MARKER_BASE.SetErrorLevel (   self,
  aErrorLevel 
)
SetErrorLevel(MARKER_BASE self, MARKER_BASE::MARKER_SEVERITY aErrorLevel)

void
MARKER_BASE::SetErrorLevel(MARKER_SEVERITY aErrorLevel)

accessors to set/get error levels (warning, error, fatal error..) 

Definition at line 3467 of file pcbnew.py.

def pcbnew.MARKER_BASE.SetMarkerType (   self,
  aMarkerType 
)
SetMarkerType(MARKER_BASE self, enum MARKER_BASE::TYPEMARKER aMarkerType)

void
MARKER_BASE::SetMarkerType(enum TYPEMARKER aMarkerType)

accessors to set/get marker type ( DRC, ERC, or other) 

Definition at line 3489 of file pcbnew.py.

def pcbnew.MARKER_BASE.SetShowNoCoordinate (   self)
SetShowNoCoordinate(MARKER_BASE self)

void
MARKER_BASE::SetShowNoCoordinate() 

Definition at line 3559 of file pcbnew.py.

Member Data Documentation

tuple pcbnew.MARKER_BASE.m_Pos = _swig_property(_pcbnew.MARKER_BASE_m_Pos_get, _pcbnew.MARKER_BASE_m_Pos_set)
static

Definition at line 3403 of file pcbnew.py.

pcbnew.MARKER_BASE.MARKER_ERC = _pcbnew.MARKER_BASE_MARKER_ERC
static

Definition at line 3393 of file pcbnew.py.

pcbnew.MARKER_BASE.MARKER_PCB = _pcbnew.MARKER_BASE_MARKER_PCB
static

Definition at line 3394 of file pcbnew.py.

pcbnew.MARKER_BASE.MARKER_SEVERITY_ERROR = _pcbnew.MARKER_BASE_MARKER_SEVERITY_ERROR
static

Definition at line 3399 of file pcbnew.py.

pcbnew.MARKER_BASE.MARKER_SEVERITY_INFO = _pcbnew.MARKER_BASE_MARKER_SEVERITY_INFO
static

Definition at line 3397 of file pcbnew.py.

pcbnew.MARKER_BASE.MARKER_SEVERITY_UNSPEC = _pcbnew.MARKER_BASE_MARKER_SEVERITY_UNSPEC
static

Definition at line 3396 of file pcbnew.py.

pcbnew.MARKER_BASE.MARKER_SEVERITY_WARNING = _pcbnew.MARKER_BASE_MARKER_SEVERITY_WARNING
static

Definition at line 3398 of file pcbnew.py.

pcbnew.MARKER_BASE.MARKER_SIMUL = _pcbnew.MARKER_BASE_MARKER_SIMUL
static

Definition at line 3395 of file pcbnew.py.

pcbnew.MARKER_BASE.MARKER_UNSPEC = _pcbnew.MARKER_BASE_MARKER_UNSPEC
static

Definition at line 3392 of file pcbnew.py.

pcbnew.MARKER_BASE.this

Definition at line 3425 of file pcbnew.py.


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