kicad/pcbnew/scripting/board.i

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2012 NBEE Embedded Systems, Miguel Angel Ajo <miguelangel@nbee.es>
 * Copyright (C) 1992-2012 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

/**
 * @file board.i
 * @brief Specific BOARD extensions and templates
 */


%extend BOARD
{ 
  %pythoncode
  {
    def GetModules(self):             return self.m_Modules
    def GetDrawings(self):            return self.m_Drawings
    def GetTracks(self):              return self.m_Track
    def GetSegZones(self):            return self.m_Zone
    def GetFullRatsnest(self):        return self.m_FullRatsnest
    def GetLocalRatsnest(self):       return self.m_LocalRatsnest
    def GetNetClasses(self):          return self.m_NetClasses
    def GetCurrentNetClassName(self): return self.m_CurrentNetClassName
    def GetViasDimensionsList(self):  return self.m_ViasDimensionsList
    def GetTrackWidthList(self):      return self.m_TrackWidthList
    
    def Save(self,filename,format = None):
      if format is None:
        str_filename = str(filename)
        if str_filename.endswith(".brd"):
          format = IO_MGR.LEGACY
        if str_filename.endswith(".kicad_brd"):
          format = IO_MGR.KICAD	  
      return SaveBoard(filename,self,format)
        
    #
    # add function, clears the thisown to avoid python from deleting
    # the object in the garbage collector
    #
    
    def Add(self,item): 
    	item.thisown=0
    	self.AddNative(item)
  }
  
}

// this is to help python with the * accessor of DLIST templates 

%rename(Get) operator BOARD_ITEM*; 
%rename(Get) operator TRACK*; 
%rename(Get) operator D_PAD*; 
%rename(Get) operator MODULE*; 
%rename(Get) operator SEGZONE*; 


// we must translate C++ templates to scripting languages

%template(BOARD_ITEM_List) DLIST<BOARD_ITEM>;
%template(MODULE_List)     DLIST<MODULE>;
%template(SEGZONE_List)    DLIST<SEGZONE>;
%template(TRACK_List)      DLIST<TRACK>;
%template(PAD_List)        DLIST<D_PAD>;

// std::vector templates  

%template(VIA_DIMENSION_Vector) std::vector<VIA_DIMENSION>;
%template (RASTNET_Vector) std::vector<RATSNEST_ITEM>;

%extend DRAWSEGMENT
{
	%pythoncode 
	{
		def GetShapeStr(self):
			return self.ShowShape(self.GetShape())
	}
}

%extend BOARD_ITEM
{
        %pythoncode
        {
		def SetPos(self,p):
			self.SetPosition(p)
			self.SetPos0(p)
                
		def SetStartEnd(self,start,end):
			self.SetStart(start)
			self.SetStart0(start)
			self.SetEnd(end)
			self.SetEnd0(end)
        }
}