Vertical DXP Manuel d'utilisateur télécharger pdf

TR0124 (v1.4) April 21, 2008 1

Server Process Reference

Summary

Technical Reference

TR0124 (v1.4) April 21, 2008

This reference manual describes the server processes available in Altium Designer.

This reference details:

• Server Processes

• Client (DXP System) Processes

• Integrated Library Processes

• PCB Processes

• FPGAFlow Processes

• Schematic Processes

• WorkSpace Manager Processes.

Server Processes Reference

Servers

A server provides its services in the Altium Designer environment (the client side). The Client module of the Altium Designer

interprets the tasks in terms of processes and then delegates these processes to the appropriate servers.

For example when a user is clicking on the Schematic menu to place a wire, the Client interprets this action as a 'PlaceWire'

process and delegates the process to the Schematic Editor server. The Schematic server responds by executing the process.

The functionality of a server that is installed in the Altium Designer is exposed by that server's processes and its exposed

functions.

Generally a process is executed by selecting a packaged process launcher (such as clicking on a toolbar button, or pressing a

hot key or selecting a menu item) called as a command in Altium Designer, however you may wish to manually run a process:

Up to three different types of process launchers can be used to launch the same process.

Each server process has a process identifier. The process identifier is made up of two parts separated by a colon. The first part

of the process identifier indicates the server that defines the process, and the second part is the process name.

• For example, the process Sch:ZoomIn is provided by the Schematic Editor server. When this process is launched, either

by selecting a menu item, pressing a hot key or activating a toolbar button (which are all defined as process launchers in the

Altium Designer), it will perform the task of zooming in on the currently active schematic sheet.

A process is implemented as a server name:server process string. Processes are stored in a command launcher table

maintained by the server. Every time you execute a process via the user interface in Altium Designer, it consults the appropriate

server’s command table to fetch the process string and then sends this string over to the server for the server to determine

which process to execute. These processes are stored in corresponding server install files with an INS extension.

Parametric Processes

A parametric server process allows the information, a process needs, to be passed when the process is called. This ability to be

able to pass process parameters allows direct control over the operation of a process. For parametric processes, each

parameter has a value assigned and this parameter / value block is represented as Parameter = Name.

• For example FileName = C:\Program Files\TestFile.Txt.

To concatenate several parameters as a whole string, each parameter / value block is separated by the pipe | symbol.

• For example Parameter1 = Name1 | Parameter2 = Name 2 etc.

There are two ways you can execute a process in a script

To execute a server process in a script, you need to use commands such as ResetParameters and RunProcess procedures or

invoke the Client.SendMessage function.

1 2 3 4 5 6 ... 88 89

Résumé du contenu

Page 1 - Server Process Reference

TR0124 (v1.4) April 21, 2008 1 Server Process Reference Summary Technical Reference TR0124 (v1.4) April 21, 2008 This reference manual describes

Page 2 - Server Process Routines

Server Process Reference 10 TR0122 (v1.5) April 21, 2008 RestoreLayout process Description The RestoreLayout process restores the DXP desktop from a

Page 3 - AddSingleParameter

Server Process Reference TR0122 (v1.5) April 21, 2008 11 RunProcess process Description The RunProcess process executes a process in DXP depending on

Page 4 - GetIntegerParameter

Server Process Reference 12 TR0122 (v1.5) April 21, 2008 Process: Client:TileAllOpenDocuments Parameters : Mode = Horizontal ToggleClientStatusBar pr

Page 5 - GetStringParameter

Server Process Reference TR0122 (v1.5) April 21, 2008 13 Action (ShowAboutDialog, ShowViewer, ResetDevice, ChooseAndDownload, ResetDevice, PauseProce

Page 6 - RunProcess

Server Process Reference 14 TR0122 (v1.5) April 21, 2008 Example Process: FPGAFlow:RunDiagnostic Parameters : Action = RefreshStatus

Page 7 - Scripting System Commands

Server Process Reference TR0122 (v1.5) April 21, 2008 15 Integrated Library Processes This section covers the Integrated Library processes and their

Page 8 - CustomizeResources process

Server Process Reference 16 TR0122 (v1.5) April 21, 2008 Parameters : LibReference=CAP POL1 |Library=Miscellaneous Devices.IntLib |ModelType=SIM| Mod

Page 9 - QuitFromEDAClient process

Server Process Reference TR0122 (v1.5) April 21, 2008 17 EditInternalPlanes process EditRules process EngineeringChangeOrder process EqualizeNetLengt

Page 10 - RunCommonDialog process

Server Process Reference 18 TR0122 (v1.5) April 21, 2008 Perform an autoroute of the PCB board, or a section of the PCB board, or by a specified net

Page 11

Server Process Reference TR0122 (v1.5) April 21, 2008 19 Clear process Description The Clear process is used to remove the selected objects from the

Page 12 - FPGA Flow Processes

Server Process Reference 2 TR0122 (v1.5) April 21, 2008 Example 1 ResetParameters; AddStringParameter('OpenMode','NewFromTemplate&apos

Page 13 - RunDiagnostic

Server Process Reference 20 TR0122 (v1.5) April 21, 2008 Process: PCB:CrossProbeChoose Cut process Description Cuts a selected object permanently fro

Page 14 - Example

Server Process Reference TR0122 (v1.5) April 21, 2008 21 Layer (Current, Top, Bottom, Topoverlay, Multilayer, Bottomoverlay, Connect, Bottompaste,Bot

Page 15 - Integrated Library Processes

Server Process Reference 22 TR0122 (v1.5) April 21, 2008 ComponentGridY (Real) Denotes the component grid Y size. RoutingTrackGrid (Real) Denotes the

Page 16 - PCB Processes

Server Process Reference TR0122 (v1.5) April 21, 2008 23 Parameters N/A EqualizeNetLengths process Description Equalize or make net lengths similar w

Page 17 - Autoroute process

Server Process Reference 24 TR0122 (v1.5) April 21, 2008 FindTestPoints process Description Find test points on a current PCB document or remove all

Page 18 - ChangeObject process

Server Process Reference TR0122 (v1.5) April 21, 2008 25 Process: PCB:GroupPrimitives Parameters: Action=Explode | Object=Component HideConnections p

Page 19

Server Process Reference 26 TR0122 (v1.5) April 21, 2008 Net: jump to the specified net Pad: jump to the specified pad String: jump to the specified

Page 20 - Deselect process

Server Process Reference TR0122 (v1.5) April 21, 2008 27 InternalPlane (1..4) Possible values include 1,2,3,4. Only can display internal planes 1 to

Page 21 - DocumentPreferences process

Server Process Reference 28 TR0122 (v1.5) April 21, 2008 Parameters Grid (Real) Specifies the grid value to move components to. If no parameters are

Page 22 - EditRules process

Server Process Reference TR0122 (v1.5) April 21, 2008 29 Parameters N/A Example Process: PCB:NextComponent Paste process Description Paste the conten

Page 23 - FilterSelect process

Server Process Reference TR0122 (v1.5) April 21, 2008 3 Begin Client.SendMessage('WorkspaceManager:OpenObject','OpenMode=NewFromTe

Page 24 - GroupPrimitives process

Server Process Reference 30 TR0122 (v1.5) April 21, 2008 Radius (Real) EndAngle (Real: 0-360) Keepout (True, False) - True, False. Defaults to False

Page 25 - Jump process

Server Process Reference TR0122 (v1.5) April 21, 2008 31 Designator.Mirror (Real) Designator.Width (Real) Comment.Text (String) Comment.Visible (True

Page 26 - ListComponents process

Server Process Reference 32 TR0122 (v1.5) April 21, 2008 Layer (Current, Top, Bottom, Topoverlay, Multilayer, Bottomoverlay, Connect, Bottompaste,Bot

Page 27 - MeasureDistance process

Server Process Reference TR0122 (v1.5) April 21, 2008 33 Layer (Current, Top, Bottom, Topoverlay, Multilayer, Bottomoverlay, Connect, Bottompaste,Bot

Page 28 - NextComponent process

Server Process Reference 34 TR0122 (v1.5) April 21, 2008 ModeFit (Polygonal_room, Create_Centers, Create_NonOrtho, Create_Ortho, Create_Rectangle, Fi

Page 29 - PlaceArc process

Server Process Reference TR0122 (v1.5) April 21, 2008 35 PlaceString process Description The PlaceString process is used to place a line of text onto

Page 30 - PlaceComponent process

Server Process Reference 36 TR0122 (v1.5) April 21, 2008 Process: Parameters : PlaceVia process Description The PlaceVia process is used to place a

Page 31 - PlaceCoordinate process

Server Process Reference TR0122 (v1.5) April 21, 2008 37 Process: PCB : ReportBoardSpecs Parameters : ReportKind = Component ReportNetlistStatus proc

Page 32 - PlaceFill process

Server Process Reference 38 TR0122 (v1.5) April 21, 2008 If true, the current query is cleared. Example Process: PCB:RunQuery Parameters :Expr=IsDesi

Page 33 - PlaceRoom process

Server Process Reference TR0122 (v1.5) April 21, 2008 39 Notes There are up to 9 Store and Recall memory states for the Selection Memory diailog. Exa

Page 34 - PlaceSplitPlane process

Server Process Reference 4 TR0122 (v1.5) April 21, 2008 Begin ResetParameters; AddSingleParameter('SingleValue',5); // code her

Page 35 - PlaceTrack process

Server Process Reference 40 TR0122 (v1.5) April 21, 2008 OnlineDRC (True, False, Toggle) Sets Online DRC option. LoopRemoval (True, False, Toggle) Se

Page 36 - ReportBoardSpecs process

Server Process Reference TR0122 (v1.5) April 21, 2008 41 Parameters Binary (True, False) Defaults to unary rule if no parameter is specified. If True

Page 37 - RunQuery process

Server Process Reference 42 TR0122 (v1.5) April 21, 2008 Process: PCB:SnapGrid Parameters : Size = 5Mil TearDropSelectedPads process Description Add

Page 38 - SelectionMemory process

Server Process Reference TR0122 (v1.5) April 21, 2008 43 Used to update selected components rotation field values, based upon the orientation of the

Page 39 - SetupPreferences process

Server Process Reference 44 TR0122 (v1.5) April 21, 2008 Schematic Processes This section covers the Schematic processes and their parameters (if any

Page 40 - ShowApplicableRules process

Server Process Reference TR0122 (v1.5) April 21, 2008 45 IncrementComponentPartNumber process Jump process LastComponentLibraryEditor process PlacePo

Page 41 - SnapGridXY

Server Process Reference 46 TR0122 (v1.5) April 21, 2008 AddComponentPart process Description Adds a new component part to a component in the library

Page 42 - TR0122 (v1.5) April 21, 2008

Server Process Reference TR0122 (v1.5) April 21, 2008 47 Bring an object to the front of another object on a schematic document. Parameters N/A Examp

Page 43 - Zoom process

Server Process Reference 48 TR0122 (v1.5) April 21, 2008 If True then the focussed object is zoomed into, resizing the whole object on the screen. Ex

Page 44 - Schematic Processes

Server Process Reference TR0122 (v1.5) April 21, 2008 49 Checks for empty pin name field. Defaults to previous setting if none specified. MissingPinN

Page 45

Server Process Reference TR0122 (v1.5) April 21, 2008 5 Var ErrorCode : Integer; CommandLine : String; Result : Integer; NetlistName

Page 46 - BringObjectToFrontOf process

Server Process Reference 50 TR0122 (v1.5) April 21, 2008 CreateSheetFromSheetSymbol process Description Creates a new schematic document and adds por

Page 47 - ChangeObject process (SCH)

Server Process Reference TR0122 (v1.5) April 21, 2008 51 Example Process: SCH:Cut DeleteComponentFromLibrary process Description The DeleteComponentF

Page 48 - ClearLocationMark process

Server Process Reference 52 TR0122 (v1.5) April 21, 2008 Process: SCH:DownHierarchy Parameters : Action = OpenAllDocumentsinHierarchy Drag process De

Page 49 - Copy process (SCH)

Server Process Reference TR0122 (v1.5) April 21, 2008 53 SearchText (String) Specifies the text to search for. ReplaceText (String) Specifies the t

Page 50 - Cut process (SCH)

Server Process Reference 54 TR0122 (v1.5) April 21, 2008 N/A Example Process: SCH:FirstComponentLibraryEditor IncrementComponentPartNumber process De

Page 51 - DownHierarchy process

Server Process Reference TR0122 (v1.5) April 21, 2008 55 The MoveComponentToLibrary process is used in the Library Editor to move a component from th

Page 52 - FindAndReplaceText process

Server Process Reference 56 TR0122 (v1.5) April 21, 2008 The NextComponentLibraryEditor process is used to go to the next component in a current libr

Page 53 - FindText process

Server Process Reference TR0122 (v1.5) April 21, 2008 57 Location.X (Integer) Specified in coordinate units of .01 inch. Range is 0-6500. Example:

Page 54

Server Process Reference 58 TR0122 (v1.5) April 21, 2008 PlaceBus process Description Place a bus on the current schematic document. Parameters LineW

Page 55

Server Process Reference TR0122 (v1.5) April 21, 2008 59 PlaceEllipse process Description Place an elliptical shape on the current schematic document

Page 56 - PlaceArc process (SCH)

Server Process Reference 6 TR0122 (v1.5) April 21, 2008 AddStringParameter('ReturnGeneratedDocuments', 'True'); RunProces

Page 57 - PlaceBezier process

Server Process Reference 60 TR0122 (v1.5) April 21, 2008 required value, R+256*(G+(256*B)). Examples: Color=0 is black Color=255 is red Color=6

Page 58 - PlaceBusEntry process

Server Process Reference TR0122 (v1.5) April 21, 2008 61 Location.X (Integer) Specified in coordinate units of .01 inch. Range is 0-6500. Example: Lo

Page 59 - PlaceEllipticalArc process

Server Process Reference 62 TR0122 (v1.5) April 21, 2008 Specified in coordinate units of .01 inch. Range is 0-6500. Example: Location.X=100 Corner.

Page 60 - PlaceIEEESymbol process

Server Process Reference TR0122 (v1.5) April 21, 2008 63 Location.Y (Integer) Specified in coordinate units of .01 inch. Range is 0-6500. Example: L

Page 61 - PlaceLine process

Server Process Reference 64 TR0122 (v1.5) April 21, 2008 Example Process: SCH:PlaceNote PlaceOffSheetConnector process Description Place a off sheet

Page 62 - PlaceNoErc process

Server Process Reference TR0122 (v1.5) April 21, 2008 65 Component library filename where the part exists. By default if no library is specified the

Page 63 - PlaceNote process

Server Process Reference 66 TR0122 (v1.5) April 21, 2008 Color (Long Integer) Specifies RGB value converted from 6 digit hexidecimal number. For exa

Page 64 - PlacePart process

Server Process Reference TR0122 (v1.5) April 21, 2008 67 Orientation (0..3) Four orientation settings, 0=0 degrees, 1=90 degrees, 2=180 degrees 3=2

Page 65

Server Process Reference 68 TR0122 (v1.5) April 21, 2008 Parameters Name (String) Text string up to 255 characters in length. Example: Name=D1 Sty

Page 66 - PlacePin process

Server Process Reference TR0122 (v1.5) April 21, 2008 69 PlaceProbe process Description The PlaceProbe process is used to place a simulation probe on

Page 67 - PlacePort process

Server Process Reference TR0122 (v1.5) April 21, 2008 7 The RunProcess procedure allows you to execute a Altium Designer or server process. If the p

Page 68 - PlacePowerPort process

Server Process Reference 70 TR0122 (v1.5) April 21, 2008 Location.X (Integer) Specified in coordinate units of .01 inch. Range is 0-6500. Example: L

Page 69 - PlaceRoundRectangle process

Server Process Reference TR0122 (v1.5) April 21, 2008 71 Specified in coordinate units of .01 inch. LineWidth (0..3) Four border widths, 0=Smallest,

Page 70 - PlaceSheetSymbol process

Server Process Reference 72 TR0122 (v1.5) April 21, 2008 Text string up to 255 characters in length. Location.X (Integer) Specified in coordinate un

Page 71 - PlaceTestVectorIndex process

Server Process Reference TR0122 (v1.5) April 21, 2008 73 ClipToRect (True,False,Toggle) Selection (True,False,Toggle) Example Process: SCH:PlaceTextF

Page 72 - PlaceTextFrame process

Server Process Reference 74 TR0122 (v1.5) April 21, 2008 RemoveComponentPart process Description The RemoveComponentPart process is used to delete a

Page 73 - Redo process (SCH)

Server Process Reference TR0122 (v1.5) April 21, 2008 75 Show (True,False). Load and display report in text editor if True. Defaults to True. Exam

Page 74

Server Process Reference 76 TR0122 (v1.5) April 21, 2008 N/A SetLocationMark process Description The SetLocationMark (1..10) processes are used to ta

Page 75 - SendObjectToBackOf process

Server Process Reference TR0122 (v1.5) April 21, 2008 77 HotSpotGridDistance (Integer) SnapToHotspot (True,False,Toggle) AutoZoom (True,False,Toggle)

Page 76 - SetupArrayPlacement process

Server Process Reference 78 TR0122 (v1.5) April 21, 2008 AF_PlacementZoom (True, False, Toggle) AF_PlacementThicken (True, False, Toggle) AF_EditLoca

Page 77

Server Process Reference TR0122 (v1.5) April 21, 2008 79 Parameters : Action = Mode0 ToggleElectricalGrid process Description The ToggleElectricalGri

Page 78 - SynchronizeHierarchy process

Server Process Reference 8 TR0122 (v1.5) April 21, 2008 Text (String) Example Process: ScriptingSystem:RunScriptText Parameters : Text = Begin RunApp

Page 79

Server Process Reference 80 TR0122 (v1.5) April 21, 2008 N/A UpdateComponentsFromLibraryEditor process Description The UpdateComponentFromLibraryEdit

Page 80

Server Process Reference TR0122 (v1.5) April 21, 2008 81 Prompts for a zoom value if not specified. Action (ZoomIn,ZoomOut,Pan, Redraw, All) Object (

Page 81 - Work Space Manager Processes

Server Process Reference 82 TR0122 (v1.5) April 21, 2008 Example 3 Close all the documents within the focussed project tree in a script Procedure Clo

Page 82 - DocumentOptions process

Server Process Reference TR0122 (v1.5) April 21, 2008 83 DeleteObject process (WSM) Description Execute a specified delete action. Parameters ObjectK

Page 83

Server Process Reference 84 TR0122 (v1.5) April 21, 2008 Edit the embedded option settings for the active or focussed project or document. Parameters

Page 84 - HideObject process

Server Process Reference TR0122 (v1.5) April 21, 2008 85 Execute a specified hiding action, to hide current document, project or all documents in DXP

Page 85 - OpenObject process

Server Process Reference 86 TR0122 (v1.5) April 21, 2008 FpgaProject, EmbeddedProject, IntegratedLibrary, ProjectGroup, CAM, WAVE, IntLibrary, Script

Page 86 - SaveObject process

Server Process Reference TR0122 (v1.5) April 21, 2008 87 GroupByOrder (True,False,Toggle) SortByName (True,False,Toggle) SortByStatus (True,False,Tog

Page 87 - VersionControl process

Server Process Reference 88 TR0122 (v1.5) April 21, 2008 View process Description The View process can bring a DXP panel into view on DXP. Navigator

Page 88 - View process

Server Process Reference TR0122 (v1.5) April 21, 2008 89 Revision History Date Version No. Revision 01-Dec-2004 1.0 New product release 26-Apr-200

Page 89 - Revision History

Server Process Reference TR0122 (v1.5) April 21, 2008 9 Parameters: Action = Show | ObjectKind = Window Favorites Description The Favorites process

Commentaires sur ces manuels

Pas de commentaire

Vertical DXP Manuel d'utilisateur

Naviguer en ligne ou télécharger Manuel d'utilisateur pour Téléphones Vertical DXP. DXP Panels Reference Manuel d'utilisatio

Résumé du contenu

Commentaires sur ces manuels

Produits connexes et manuels pour Téléphones Vertical DXP