Reference Manual

• Connection Methods
  • New Instance
    • launch()
  • Existing Instance
    • connect()
  • Existing or New
    • application()
• The PSCAD Application
  • PSCAD
  • Configuration
    • Application Settings
      • PSCAD.settings()
      • PSCAD.setting_range()
    • Application Flags
      • PSCAD.flags()
      • PSCAD.substitute()
  • Properties
    • PSCAD.version
    • PSCAD.examples_folder
    • PSCAD.is_busy()
  • Licensing
    • Certificate
      • PSCAD.login()
      • PSCAD.logout()
      • PSCAD.logged_in()
      • PSCAD.licensed()
      • PSCAD.get_available_certificates()
      • PSCAD.get_current_certificate()
      • PSCAD.get_certificate()
      • PSCAD.release_certificate()
      • PSCAD.release_all_certificates()
      • PSCAD.set_license_host()
    • Legacy
      • PSCAD.activate_edu_license()
      • PSCAD.activate_pro_license()
  • Workspace Commands
    • PSCAD.new_workspace()
    • PSCAD.save_workspace()
    • PSCAD.workspace_dir
    • PSCAD.workspace_name
    • PSCAD.workspace_path
    • PSCAD.is_dirty()
    • PSCAD.load()
    • PSCAD.projects()
    • PSCAD.cases()
    • PSCAD.libraries()
    • PSCAD.project()
    • PSCAD.create_library()
    • PSCAD.create_case()
  • Build & Run Commands
    • PSCAD.build_all()
    • PSCAD.build_modified()
    • PSCAD.build_current()
    • PSCAD.pause_run()
    • PSCAD.stop_run()
    • PSCAD.clean_all()
  • Simulation Sets
    • PSCAD.simulation_sets()
    • PSCAD.create_simulation_set()
    • PSCAD.simulation_set()
    • PSCAD.remove_simulation_set()
    • PSCAD.run_all_simulation_sets()
  • Parameter Grid
    • PSCAD.parameter_grid
    • ParameterGrid.view()
    • ParameterGrid.view_cases()
    • ParameterGrid.view_libraries()
    • ParameterGrid.view_simulation_sets()
    • ParameterGrid.view_simulation_tasks()
    • ParameterGrid.view_simulation_task_overrides()
    • ParameterGrid.view_simulation_task_layers()
    • ParameterGrid.save()
    • ParameterGrid.load()
  • Navigation
    • PSCAD.navigate()
    • PSCAD.navigate_to()
    • PSCAD.navigate_up()
    • PSCAD.navigate_dismiss()
    • PSCAD.focused()
  • Subscriptions
    • PSCAD.subscriptions()
    • PSCAD.subscribed()
    • PSCAD.subscribe()
    • PSCAD.unsubscribe()
    • PSCAD.unsubscribe_all()
    • PSCAD.subscription()
  • Keys & Mouse
    • Keystroke Events
      • PSCAD.key_down()
      • PSCAD.key_up()
      • PSCAD.stroke()
      • PSCAD.keystrokes()
      • PSCAD.typing()
    • Mouse Events
      • PSCAD.move()
      • PSCAD.leftdown()
      • PSCAD.leftup()
      • PSCAD.leftclick()
      • PSCAD.middledown()
      • PSCAD.middleup()
      • PSCAD.middleclick()
      • PSCAD.rightdown()
      • PSCAD.rightup()
      • PSCAD.rightclick()
      • PSCAD.wheel()
  • Termination
    • PSCAD.quit()
• Projects
  • Project
  • Properties
    • Project.name
    • Project.filename
    • Project.temp_folder
    • Project.parameters()
    • Project.parameter_range()
  • Management
    • Load & Save
      • Project.save()
      • Project.save_as()
      • Project.is_dirty()
      • Project.reload()
      • Project.unload()
    • Navigation
      • Project.focus()
      • Project.canvas()
    • Scenarios
      • Project.scenarios()
      • Project.scenario()
      • Project.save_scenario()
      • Project.save_as_scenario()
      • Project.delete_scenario()
  • Build & Run
    • Project.build()
    • Project.run()
    • Project.run_status()
    • Project.pause()
    • Project.stop()
    • Project.messages()
    • Project.output()
    • Project.clean()
    • Project.compile_library()
  • Definitions
    • Project.definitions()
    • Project.definition()
    • Project.create_definition()
    • Project.delete_definition()
    • Project.delete_definition_instances()
    • PSCAD.copy_definitions()
    • Project.paste_definitions()
    • Project.paste_definitions_with_dependents()
  • Components
    • Finding
      • Project.find()
      • Project.find_first()
      • Project.find_all()
    • Finding By Id
      • Project.component()
    • Parameter Grid
      • Project.export_parameter_grid()
      • Project.import_parameter_grid()
  • Global Substitutions
    • Project.global_substitution
    • Sets
      • GlobalSubstitution.active_set
      • GlobalSubstitution.create_sets()
      • GlobalSubstitution.remove_sets()
      • GlobalSubstitution.rename_set()
    • Variables
      • GlobalSubstitution.create()
      • GlobalSubstitution.remove()
      • GlobalSubstitution.rename()
    • Load / Save
      • GlobalSubstitution.save_set()
      • GlobalSubstitution.load_set()
      • GlobalSubstitution.append_set()
      • GlobalSubstitution.save_all_sets()
      • GlobalSubstitution.load_all_sets()
      • GlobalSubstitution.append_all_sets()
  • Layers
    • Project.layers()
    • Project.create_layer()
    • Project.set_layer_state()
    • Project.delete_layer()
    • Project.layer()
    • Project.layer_states()
    • Properties
      • Layer.project
      • Layer.id
      • Layer.name
      • Layer.state
      • Layer.parameters()
      • Layer.add_state()
      • Layer.remove_state()
      • Layer.rename_state()
      • Layer.set_custom_state()
      • Layer.move_up()
      • Layer.move_down()
      • Layer.to_top()
      • Layer.to_bottom()
  • Resources
    • Project.resources()
    • Project.create_resource()
    • Project.remove_resource()
    • Project.resource()
    • Properties
      • Resource.project
      • Resource.id
      • Resource.name
      • Resource.path
      • Resource.abspath
      • Resource.parameters()
• Canvas
  • Canvas
  • Properties
    • Canvas.scope
    • Canvas.name
    • Canvas.parameters()
    • Canvas.parameter_range()
  • Finding Components
    • Canvas.find()
    • Canvas.find_first()
    • Canvas.find_all()
    • Canvas.components()
    • Finding By Id
      • Canvas.component()
  • Creating Components
    • Canvas.create_component()
    • Canvas.add_component()
  • Clipboard Operations
    • Canvas.select()
    • Canvas.select_components()
    • Canvas.clear_selection()
    • Canvas.copy()
    • Canvas.cut()
    • Canvas.paste()
    • Canvas.delete()
  • Transformations
    • Canvas.mirror()
    • Canvas.flip()
    • Canvas.rotate_right()
    • Canvas.rotate_left()
    • Canvas.rotate_180()
  • Navigation
    • Canvas.navigate_up()
• User Canvas
  • UserCanvas
  • Parameters
    • UserCanvas.parameters()
    • UserCanvas.parameter_range()
  • Smart Clipboard
    • UserCanvas.paste_transfer()
    • UserCanvas.paste_rename()
  • Composition
    • UserCanvas.group()
    • UserCanvas.compose_wires()
    • UserCanvas.decompose_wires()
  • Creating …
    • Wires
      • UserCanvas.create_wire()
      • UserCanvas.create_bus()
      • UserCanvas.create_sticky_wire()
    • Annotations
      • UserCanvas.create_annotation()
      • UserCanvas.create_sticky_note()
      • UserCanvas.create_divider()
      • UserCanvas.create_group_box()
      • UserCanvas.create_file()
      • UserCanvas.create_hyper_link()
      • UserCanvas.create_bookmark_link()
    • Graphs
      • UserCanvas.create_graph_frame()
      • UserCanvas.create_graph()
      • UserCanvas.create_polygraph()
      • UserCanvas.create_xy_plot()
      • UserCanvas.create_poly_meter()
      • UserCanvas.create_phasor_meter()
      • UserCanvas.create_oscilloscope()
    • Controls
      • UserCanvas.create_control_frame()
• Graphics Canvas
  • GfxCanvas
    • GfxCanvas.create_component()
    • GfxCanvas.add_port()
    • GfxCanvas.add_input()
    • GfxCanvas.add_output()
    • GfxCanvas.add_electrical()
    • GfxCanvas.add_line()
    • GfxCanvas.add_rectangle()
    • GfxCanvas.add_text()
• Components
  • Common
    • Component
    • Properties
      • Component.project_name
      • Component.iid
      • Component.defn_name
      • Component.parameters()
      • Component.range()
      • Component.view_parameter_grid()
      • Component.import_parameters()
      • Component.export_parameters()
    • Location
      • Component.parent
      • Component.location
      • Component.get_location()
      • Component.set_location()
      • Component.bounds
    • Layers
      • Component.layer
      • Component.add_to_layer()
      • Component.remove_from_layer()
      • Component.custom_state()
      • Component.enable()
      • Component.disable()
      • Component.enabled
    • Modules
      • Component.is_module()
    • Clipboard
      • Component.copy()
      • Component.cut()
      • Component.delete()
      • Component.clone()
    • Z-Ordering
      • Component.to_front()
      • Component.to_back()
      • Component.to_next()
      • Component.to_prev()
  • User Components
    • UserCmp
    • Properties
      • UserCmp.definition
      • UserCmp.parameters()
      • UserCmp.range()
      • UserCmp.view_parameter_grid()
    • Ports
      • UserCmp.ports()
      • UserCmp.port()
    • Modules
      • UserCmp.canvas()
      • UserCmp.navigate_in()
      • UserCmp.compile()
      • UserCmp.blackbox()
      • UserCmp.blackbox_defn()
  • Connections
    • Wire.vertices()
    • Wire.endpoints()
    • Wires
      • Wire
    • Sticky Wire
      • StickyWire
    • Bus
      • Bus
    • T-Line
      • TLine
    • Cable
      • Cable
  • Output Channels
    • Graph Frame
      • GraphFrame
    • Overlay Graph
      • OverlayGraph
      • Parameters
      • Properties
      • Position
      • Zoom
      • Curves
      • Clipboard
    • Polygraph
      • PolyGraph
      • Parameters
      • Properties
      • Position
      • Zoom
      • Curves
      • Clipboard
    • XY Plot Frame
      • PlotFrame
      • Parameters
      • Properties
      • Appearence
      • Zoom
      • Curves
      • Clipboard
    • Curve
      • Curve
      • Properties
      • Methods
  • Instruments
    • Instrument
      • Instrument.link_id
      • Instrument.linked
      • Instrument.title
      • Instrument.parameters()
      • Instrument.range()
    • Oscilloscope
      • Oscilloscope
    • Phasor Meter
      • PhasorMeter
    • Poly Meter
      • PolyMeter
  • Input Controls
    • Control Frame
      • ControlFrame
    • General
      • Control
    • Button
      • Button
    • Switch
      • Switch
    • Selector
      • Selector
    • Slider
      • Slider
  • Annotations
    • Sticky
      • Sticky
    • Divider
      • Divider
    • Group Box
      • GroupBox
• Definitions
  • Definition
    • Definition.project_name
    • Definition.scope
    • Definition.name
    • Definition.scoped_name
    • Definition.instances
    • Definition.xml
    • Definition.is_module()
    • Definition.parameters()
    • Definition.compile()
    • Definition.navigate_to()
    • Definition.set_view()
    • Definition.canvas()
    • Definition.graphics()
    • Definition.copy()
    • Definition.script
• Simulation Sets
  • SimulationSet
  • Management
    • SimulationSet.name()
  • Tasks
    • SimulationSet.tasks()
    • SimulationSet.list_tasks()
    • SimulationSet.add_tasks()
    • SimulationSet.remove_tasks()
    • SimulationSet.task()
  • Build & Run
    • SimulationSet.run()
• Simulation Tasks
  • Project Task
    • ProjectTask
      • ProjectTask.name
      • ProjectTask.namespace()
      • ProjectTask.simulation_set
      • ProjectTask.parameters()
      • ProjectTask.layers()
      • ProjectTask.overrides()
  • External Task
    • ExternalTask
• Licensing
  • License Certificate
    • Certificate
    • Identification
      • Certificate.id()
      • Certificate.name()
      • Certificate.account()
      • Certificate.available()
      • Certificate.total()
    • Features
      • Certificate.features()
      • Certificate.feature()
    • Requirements
      • Certificate.meets()
      • Certificate.meet()
      • Certificate.cost()
  • License Features
    • Feature
    • Identification
      • Feature.id()
      • Feature.name()
      • Feature.value()
      • Feature.cost()
• Component Wizard
  • UserDefnWizard
    • UserDefnWizard.name
    • UserDefnWizard.module
    • UserDefnWizard.description
    • UserDefnWizard.port
    • UserDefnWizard.graphics
    • UserDefnWizard.form_caption
    • UserDefnWizard.form_width
    • UserDefnWizard.form_height
    • UserDefnWizard.form_splitter
    • UserDefnWizard.form_category_width
    • UserDefnWizard.form_help_width
    • UserDefnWizard.category
    • UserDefnWizard.parameter
    • UserDefnWizard.script
    • UserDefnWizard.create_definition()
  • Ports
    • Ports
      • Ports.electrical()
      • Ports.input()
      • Ports.output()
    • Port
      • Port
  • Graphics
    • Graphics
      • Graphics.arrow()
      • Graphics.line()
      • Graphics.rectangle()
      • Graphics.text()
    • Text
      • Text
    • Line
      • Line
    • Rectangle
      • Rectangle
  • Parameter Form
    • Parameters
      • Parameters.keys()
    • Categories
    • Category
      • Category
      • Properties
      • Methods
    • Parameters
      • Categories
    • Parameter
      • Parameter
  • Scripts
    • Scripts
      • Scripts.items()
      • Scripts.keys()
• Utilities
  • Clipboard
    • Clipboard
      • Clipboard.getFormatName()
      • Clipboard.saveBitmap()
  • File
    • File
      • File.compare_files()
      • File.move_files()
      • File.copy_files()
      • File.copy_file()
      • File.convert_out_to_csv()
    • OutFile
      • OutFile.__init__()
      • OutFile.open()
      • OutFile.close()
      • OutFile.read_values()
      • OutFile.columns()
      • OutFile.column()
      • OutFile.column_name()
      • OutFile.toCSV()
      • OutFile.values_at()
  • Mail
    • Mail
      • Mail.send_gmail()
      • Mail.send_outlook_mail()
  • Word
    • Word
      • Word.addPageBreak()
      • Word.textParagraph()
      • Word.pasteImage()
      • Word.save()
      • Word.close()
      • Word.open_document()
      • Word.new_document()