pipeline.portTypes

Classes

class pipeline.portTypes.PortTypeHint

Attributes:

SingleValue: TypeAlias = <ast.BinOp object at 0x0000028E2174A350>
Number: TypeAlias = numbers.Number
NumberArray: TypeAlias = <ast.BinOp object at 0x0000028E2174A110>
GeneralArray: TypeAlias = <ast.BinOp object at 0x0000028E21749F90>
FilePath: TypeAlias = <ast.BinOp object at 0x0000028E21749D50>
FilesPath: TypeAlias = <ast.Subscript object at 0x0000028E21749C30>
NumberTable = <ast.Subscript object at 0x0000028E21749AE0>
GeneralTable = <ast.Subscript object at 0x0000028E21749960>
HttpUrl = <ast.Subscript object at 0x0000028E217497E0>
Token: TypeAlias = <ast.Subscript object at 0x0000028E21749660>
TableData: TypeAlias = TableData
TableSeries: TypeAlias = TableSeries
TableCollection: TypeAlias = TableCollection
SingleResult: TypeAlias = SingleResult
Attributes: TypeAlias = <ast.Subscript object at 0x0000028E21749090>
JsonObject = <ast.Subscript object at 0x0000028E21748F40>
DocData: TypeAlias = DocData
General: TypeAlias = Any
CoordinateSystem: TypeAlias = CoordinateSystem
TableCollectionDict: TypeAlias = <ast.Subscript object at 0x0000028E21748B80>
Text = <ast.Subscript object at 0x0000028E21748A30>
Picture = <ast.Subscript object at 0x0000028E217488E0>
IterationData: TypeAlias = <ast.Subscript object at 0x0000028E21748760>
IterationResult: TypeAlias = <ast.Subscript object at 0x0000028E21748580>
ResultModel: TypeAlias = ResultModel
AgentRunResult: TypeAlias = AgentRunResult
Profile1D: TypeAlias = Profile1D
MultiProfile1D: TypeAlias = MultiProfile1D
MaterialTable: TypeAlias = MaterialTable
BoreForCadDraw: TypeAlias = BoreForCadDraw
BoreForPlanDraw: TypeAlias = BoreForPlanDraw
RecFoundation: TypeAlias = RecFoundation
Pile: TypeAlias = BasicPile
CompositePile: TypeAlias = BasicCompositePile
GeoSection: TypeAlias = SectionForCadDraw
GeoSection3D: TypeAlias = Section3D
GeoSections: TypeAlias = <ast.Subscript object at 0x0000028E22211FC0>
GeoSections3D: TypeAlias = <ast.Subscript object at 0x0000028E22211EA0>
GdimTemplate: TypeAlias = GdimTemplate
GdimFile: TypeAlias = GdimMinIOFile
GdimFiles: TypeAlias = <ast.Subscript object at 0x0000028E22211C00>
PlotData = <ast.Subscript object at 0x0000028E22211B10>
TableRowMask: TypeAlias = np.ndarray
TablesRowMask: TypeAlias = <ast.Subscript object at 0x0000028E222118A0>
SingleResultDict: TypeAlias = <ast.Subscript object at 0x0000028E222116F0>
TableDataList: TypeAlias = <ast.Subscript object at 0x0000028E22211570>
GdimJsonTable: TypeAlias = GdimJsonTable
SimpleJsonTables: TypeAlias = <ast.Subscript object at 0x0000028E22211390>
MaterialTableCollection: TypeAlias = <ast.Subscript object at 0x0000028E22211270>
class pipeline.portTypes.PortType
Inherits from:

int, Enum

Attributes:

SingleValue = 1
Number = 2
NumberArray = 3
GeneralArray = 4
FilePath = 5
FilesPath = 6
NumberTable = 7
GeneralTable = 8
HttpUrl = 9
Token = 10
TableData = 11
TableSeries = 12
TableCollection = 13
SingleResult = 14
Attributes = 18
JsonObject = 19
DocData = 20
General = 21
CoordinateSystem = 24
TableCollectionDict = 27
Text = 28
Picture = 29
IterationData = 61
IterationResult = 62
ResultModel = 63
AgentRunResult = 64
Profile1D = 30
MultiProfile1D = 31
MaterialTable = 32
BoreForCadDraw = 34
RecFoundation = 35
Pile = 36
CompositePile = 37
BoreForPlanDraw = 38
GeoSection = 39
GeoSection3D = 40
GeoSections = 41
GeoSections3D = 42
GdimTemplate = 50
GdimFile = 53
GdimFiles = 54
PlotData = 55
TableRowMask = 16
TablesRowMask = 17
SingleResultDict = 25
TableDataList = 26
MaterialTableCollection = 33
GdimJsonTable = 51
SimpleJsonTables = 52

Functions

pipeline.portTypes.get_port_type_hint_to_port_type_mapping() dict[Any, PortType]

Get direct mapping from PortTypeHint class attributes to PortType enums.

This provides an exact 1:1 mapping and is the preferred way to map PortTypeHint types to PortType enums.

pipeline.portTypes.infer_port_types_from_union_args(union_args) list[PortType]

Infer PortTypes from union type arguments.

Handles two kinds of args:

  • ``Annotated[base, "PortTypeName"]`` — the ambiguous ``PortTypeHint``