Reference

The Pulsonix Scripting API defines a hierarchy of classes which are used in requests and responses. The root of this hierarchy is ScriptObject, and all of the classes below are derived from it.

• Application - The application object is a singleton which represents the Pulsonix application.
• DesignItem - Design items are objects which exist in a Pulsonix document.
  • AssociatedPart - Associated parts are parts attached to a Part, Component or Document which are not visible on a design but appear in the bill of materials.
  • Attribute - Attributes are used to apply ‘labels’ or ‘values’ to items. They are pairs of attribute names and values and belong to specific items.
  • AttributeName - An attribute name is a particular attribute type that a DesignItem may have.
  • Callout - Callouts are labels with arrows pointing to a particular item which can be used to document particular parts of a design.
  • CamPlotItem - CAM plot items are used to get information about a CamPlot or the subplots it contains.
    • CamPlot - A CAM Plot describes the parameters needed to generate a plot.
  • CommonSegment - Segments contain information about the straight lines and arcs that make up a CommonShape.
    • TrackSegment
  • CommonShape - Shapes are collections of CommonSegment on a Layer.
    • Connection - Connections are objects which tie together electrical items on a Net.
      • Track - A track is a physical copper connection on a Net on a PCB design.
    • DesignShape
      • Area - Areas are identifiable regions of a design with various properties.
      • Board - A board is a shape defining a PCB.
      • Copper - Copper shapes define custom or poured copper on a PCB design.
      • DocShape - A documentation shape is a non-electrical shape on the design often used for footprint bounds and silkscreen graphics.
      • Template
  • Component - A component object refers to a complete component in a design (e.g. “IC14” or “R31”). In a schematic design, components are composed of multiple gates which are represented by SymbolInstance. In a PCB design, they have only one symbol instance which is their actual footprint.
  • DiffPair - Differential pairs are pairs of tracks which have their lengths managed by technology rules.
  • DiffPairChain - Differential pair chains are chains of DiffPair.
  • Document - A document is the main interface to the contents of a design, containing many other items that can be accessed.
  • Gate - Gates are logical circuits part of a schematic. Component can be made up of multiple gates.
  • Group - Groups are collections of items that are treated as one item in some contexts.
  • Layer - Layers make up the electrical and non-electrical slices of a PCB stack.
    • LayerSpan - A layer span is a range of layers on a PCB design, most often used to describe the start and end point of a Via.
  • LayerClass - Layer classes are categories of Layer defined in Technology pages.
  • LibItem - A library item is an item acquired from a library containing properties that describe where it came from.
    • Part
  • LineStyle - A line style describes the appearance of a DocShape.
  • Material - A material describes the physical properties of a PCB Layer.
  • Net - A net is a set of items which are electrically connected together.
  • NetClass - A net class is a set of rules and properties which apply to specific Net.
  • Node - A node is an item which can be tied with connections on a Net.
    • ConnectPoint
      • BusTerminal - A bus terminal is a two-point connector between the end of a bus and tracks which split off from it.
      • CopperTerminal - A copper terminal connects a Track and a Copper. They can also be connected to Template which have not been poured.
      • Junction - A junction is a connect point which connects multiple tracks together. They are not visible in PCB designs.
      • MountingHole - A mounting hole is a through-hole on a PCB which enables attachment to other surfaces.
      • Pad - A pad is an electrical connection point.
        • BondPad - Bond pads are attached to die pads via bond wires.
      • Via - A via is a hole connecting multiple Layer of a PCB design together.
  • Page - Pages are individual sheets of a schematic design.
  • PartPin - A part pin contains information about a connection point on a Part.
  • PartRep - A part representation is one specific way to display a Part in a design.
  • PredefinedShape - A predefined shape is a primitive shape defined by several parameters.
    • PadStyle - A pad style defines the shape and properties of a Pad.
    • PadStyleException - A pad style exception defines the ‘by layer’ override of default pad style values or the details of a non-round drill hole.
  • SignalPath - A signal path is a series of ConnectPoint that is defined by rules configured in the Technology dialog.
  • Symbol - A symbol is an item loaded from a library which describes a component. Symbols are SymbolInstance into designs by each item that uses them.
  • SymbolInstance - This object provides you with access to the information about an instance of a symbol in a design. This is the copy of the Symbol as used by each Gate of a Component. In a PCB design, components always have one symbol instance.
  • TextPosition
    • AttributePosition - An AttributePosition is visible instance of an Attribute attached to a particular DesignItem, such as a Component or a Pad.
    • Error - Error items are the result of failing DRC or ERC checks.
    • Text
  • TextStyle - A text style describes the appearance of some text items on a design.
  • TrackStyle - A track style describes the properties of a TrackSegment.
  • Variant - Designs may have multiple variants which have distinct differences to the “master” variant of the design, such as different attribute values and parts.
• FolderList - This object provides access to the directory lists in the Folders dialog.
• Folders - This object gives you access to the application folder configuration.
• Library - Libraries are collections of items saved to disk.
  • PartLibrary - A part library is a collection of parts defined on the disk.
  • SymbolLibrary - The SymbolLibrary object provides you with access to the contents of various symbol libraries.
• PlotWriter - The PlotWriter is used to generate CAMPlot data from a design with your script.