Skip to content

← programming package

CollectParams

Iterates over the ParameterPorts in the graph and collects the values.

The result is a dictionary where the keys are the names of the ParameterPorts in the graph. This can be wired into ExportText, CreateStructure (to save to a PKL file), ReportGeneration, etc. Version 0.9.0

Ports/Properties

body

Graph to traverse. This should always be (*).

  • verbose name: Body
  • default value: None
  • port type: GraphPort
  • value type: Graph

body__signature

Signature for the "body" input. This represents the signature for the subgraph that is wired into the "body" port. This is formatted as in (a,b,c) where a,b,c are names of placeholders that are expected in the subgraph that goes into the "body" port. Alternatively, it can also be provided in data structure form as a list of lists, as in: [['a','b','c']].

  • verbose name: Body [Signature]
  • default value: (*)
  • port type: Port
  • value type: object (can be None)

result

A dictionary of settings, where the keys are the names of the ParameterPorts and the values are the node's corresponding values.

  • verbose name: Result
  • default value: None
  • port type: DataPort
  • value type: dict (can be None)
  • data direction: OUT

output_type

The format in which the result is output. By default this is a dictionary, but can also be a string representation of the dictionary (useful for wiring into ExportText), or a string representation that can be written to CSV (with 2 columns representing name and value, and one row per setting).

  • verbose name: Output Type
  • default value: dict
  • port type: EnumPort
  • value type: str (can be None)

set_breakpoint

Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

  • verbose name: Set Breakpoint (Debug Only)
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

metadata

User-definable meta-data associated with the node. Usually reserved for technical purposes.

  • verbose name: Metadata
  • default value: {}
  • port type: DictPort
  • value type: dict (can be None)