Student Workbook Mentor Graphics Corporation All rights reserved.

Transcription

1 xpcb Layout Automation and Scripting Student Workbook 2016 Mentor Graphics Corporation All rights reserved. This document contains information that is trade secret and proprietary to Mentor Graphics Corporation or its licensors and is subject to license terms. No part of this document may be photocopied, reproduced, translated, distributed, disclosed or provided to third parties without the prior written consent of Mentor Graphics.

2 This document is for information and instruction purposes. Mentor Graphics reserves the right to make changes in specifications and other information contained in this publication without prior notice, and the reader should, in all cases, consult Mentor Graphics to determine whether any changes have been made. The terms and conditions governing the sale and licensing of Mentor Graphics products are set forth in written agreements between Mentor Graphics and its customers. No representation or other affirmation of fact contained in this publication shall be deemed to be a warranty or give rise to any liability of Mentor Graphics whatsoever. MENTOR GRAPHICS MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THIS MATERIAL INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. MENTOR GRAPHICS SHALL NOT BE LIABLE FOR ANY INCIDENTAL, INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING BUT NOT LIMITED TO LOST PROFITS) ARISING OUT OF OR RELATED TO THIS PUBLICATION OR THE INFORMATION CONTAINED IN IT, EVEN IF MENTOR GRAPHICS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. U.S. GOVERNMENT LICENSE RIGHTS: The software and documentation were developed entirely at private expense and are commercial computer software and commercial computer software documentation within the meaning of the applicable acquisition regulations. Accordingly, pursuant to FAR 48 CFR and DFARS 48 CFR , use, duplication and disclosure by or for the U.S. Government or a U.S. Government subcontractor is subject solely to the terms and conditions set forth in the license agreement provided with the software, except for provisions which are contrary to applicable mandatory federal laws. TRADEMARKS: The trademarks, logos and service marks ("Marks") used herein are the property of Mentor Graphics Corporation or other parties. No one is permitted to use these Marks without the prior written consent of Mentor Graphics or the owner of the Mark, as applicable. The use herein of a third- party Mark is not an attempt to indicate Mentor Graphics as a source of a product, but is intended to indicate a product from, or associated with, a particular third party. A current list of Mentor Graphics trademarks may be viewed at: End-User License Agreement: You can print a copy of the End-User License Agreement from: Mentor Graphics Corporation 8005 S.W. Boeckman Road, Wilsonville, Oregon Telephone: Toll-Free Telephone: Website: SupportNet: supportnet.mentor.com/ Send Feedback on Documentation: supportnet.mentor.com/doc_feedback_form Part Number:

3 Module 1: Introduction Objectives Note Course Key Topics Terminology What Is Automation? What can I do With Automation? How can You Use Automation? What Products Support Automation? Supported Platforms Languages Automation Clients Launching VX Applications Versioned Automation Scripting Tools Help SupportNet Login/Register Module 1 Lab: Introduction to Scripting Module 2: Basic Scripting Concepts Objectives Note Overview VBSCRIPT versus Visual Basic PCB Script Elements Overview VBScript Basics Variables I

4 Expressions Summary VBScript I/O Message/Input Boxes VBScript Basics Miscellaneous VBScript Basics Conditional Script Control For...Each and While...Wend Examples If/Then/Else and For...Next Example Select Case Example VBScript Basics Functions and Subroutines VBScript I/O FileSystemObject Error Checking String Manipulations String Manipulations Example String Manipulations Results Module 2 Lab: Basic Scripting Module 3: Environment/GUI Customizations Objectives Startup Scripts scripts.ini Directory Search Scripts.ini File Format Scripts.ini File Format Example Scripts.ini File Search Rules Scripts.ini File File Types Executed Using the Run Command Using the WDIR Variable WDIR and xdx Designer (Except DxDesigner.xml) II

5 Searching for DxDesigner.xml Support File Keybindings Keybinding Files Shortcut Key Modifiers Connecting to the Key Binding Server Xpedition xpcb Layout Keybinding File Example xdx Designer Keybinding File Example Module 3 Lab 3.1: Startup Scripts Command Bar Server Command Bar Server Objects Connecting to the Command Bar Server Adding a New Menu Adding a Command to a Menu Command Execution Adding a Separator Adding a Sub Menu "Graying Out" User Menu Items Deleting a Command Example in Context Xpedition xpcb Menu Bar Example in Context xdx Designer Summary: Adding Menu Entries Module 3 Lab 3.2: Scripting Menu Changes Toolbars Adding an Xpedition xpcb Toolbar Button Adding a xdx Designer Toolbar Button III

6 Toolbar Command Execution Summary: Adding Toolbar Icons Things to Consider Acquiring Environment Information WDIR Acquisition and Disassemble Locate/Confirm File Exists in WDIR Create FileSystem Object for Copy Quick Reference: xdx Designer Menus Quick Reference: xdx Designer Toolbars - Default Quick Reference: xdx Designer Toolbars - Classic Quick Reference: xdx Designer Addins Quick Reference Xpedition xpcb Layout Quick Reference: Xpedition xpcb Layout Toolbars CommandBarButton Object Model Summary Module 3 Lab 3.3: Working with Toolbars Module 4: Object Programming Objectives Terminology Type Library Object Browsers VBA Object Browser xdx Designer Example Objects Collections xpcb Layout Example Input/Output/Collections LockServer (PCB Only) IV

7 Finding Objects Finding Objects xpcb Layout Example Example xpcb Layout Object Data Transactions (PCB Only) Transactions Example Transactions Example Automation Licensing Review Script Initialization Constructs Review Conditional Script Control Review Objects and Collections Review Input/Output/File System Review Xpedition xpcb Layout Licensing Construct Module 4 Lab: Object Programming Module 5: Designing and Creating Forms Objectives Integrated Development Environment (IDE) Accessing Form Files Creating a New Form xdx Designer Opening a Form xdx Designer Creating a New Form xpcb Layout Opening a Form xpcb Layout Creating/Editing Form Graphics Types of Widgets Widget Usage Widget Properties V

8 Widget Events Graphic/Code Statements Suggestions Form Example Graphics Properties Form Example Subroutines Module 5 Lab: Creating and Using Forms Module 6: xpcb Layout Output Engines Objectives Note Manufacturing Engines Currently Supported Manufacturing Engines Future Engines Common Script Concepts Add Engine Library Type Examples Create the Engine Object COM Version Example Script Gerber Export Using Predefined Setups Some Gerber Export Statements No Predefined Setups Gerber Output Files Module 6 Lab: Scripting Output Engines Module 7: xpcb Layout Objectives PCB Automation in a Nutshell Type Libraries Acquiring the Server in VBScript PCB Automation Data Model VI

9 PCB Automation Hierarchy Geometry Object Typical Script Beginnings Automation Licensing Document Licensing Code Example InputBox/Component Collection Output Result of InputBox/Component Collection Code Example/Output Results Net Collection Labels Review VBScript I/O FileSystemObject Code Example Net/Refdes/Pin Report Output Result of Net/Refdes/Pin Report Filters Non-Filtered Statements Filtering Statements Filter Enumerator Example Statements Example Code Not Using a Filter Example Code Using a Filter Module 7 lab 7A: Basic xpcb Layout Scripting Adding/Modifying Data PutVia Example PutVia Example Status Bar and TransactionStart PutVia Example Operate on the Via PutVia Example Error Handlers and Prompted For Exit PutVia Example TransactionEnd xpcb Events VII

10 Events Infinite Loop Example Code Event; OnSelectionChange Available Pick Methods Pick Methods Statements Pick Object Example Pick Components Example Command Object Motion Graphics Motion Graphics Form Motion Graphics and Command Object Example Writing to the Xpedition xpcb Layout Status Bar Writing to the Status Bar Example Code /Result Other Useful Objects and Methods Accessing Other Editors Review Module 7 Lab: Working with Events Module 8: xdx Designer Objectives Typical xdx Designer Script Tasks xdx Designer Automation in a Nutshell xdx Designer Type Library Acquiring the Server in VBScript xdx Designer Automation Data Model xdx Designer Automation Hierarchy xdx Designer Automation Accessing Design Data VIII

11 xdx Designer Automation Model Overview Typical Script Beginnings Automation Licensing Scopes Working With Queries Schematic Page Decision Tree Code Example Sheet Component Collection Flat Design Traversal Decision Tree Code Example Multi-Sheet Acquiring Net Labels Hierarchical Design Traversal - Decision Tree Example Code Hierarchical Traversal Enumerations xdx Designer Filters Adding/Deleting Objects in xdx Designer Modifying Objects in xdx Designer xdx Designer Events xdx Designer Events Members xdx Designer Events Script Example xdx Designer Events User Created Commands xdx Designer Events Register/Bind Command Example xdx Designer Events UnRegister Command Example xdx Databook Events Loading a Script for xdx Databook xdx Databook Example The Viewport Object IX

12 The Viewport Object Example Code The Viewport Object Example Code Results Other Useful Application Controls Status Bar VBScript I/O - FileSystemObject Module 8 Lab: xdx Designer Scripting X