DockingPoint

Canonical path: NemAll_Python_IFW_Input.DockingPoint

Implementation of the docking point wrapper

Methods:

• FromString –

  Create the docking point from a string

• GetDockedElements –

  Get the docked elements

• GetPoint –

  Get the docking point

• IsValid –

  Test for valid docking point

• ToString –

  Convert the docking point to a string

• __init__ –

  Overloaded function. See individual overloads.

FromString

FromString(dockingPointStr: str)

Create the docking point from a string

Parameters:

• dockingPointStr (str) –

  Docking point string

GetDockedElements

GetDockedElements() -> VecGUIDList

Get the docked elements

Returns:

• VecGUIDList –

  Docked elements

GetPoint

GetPoint(doc: DocumentAdapter) -> Point3D

Get the docking point

Parameters:

• doc (DocumentAdapter) –

  Document

Returns:

• Point3D –

  Docking point

IsValid

IsValid() -> bool

Test for valid docking point

Returns:

• bool –

  Valid state

ToString

ToString() -> str

Convert the docking point to a string

Returns:

• str –

  Docking point string

__init__ overloaded

__init__()

Initialize

__init__(element: DockingPoint)

Copy constructor

Parameters:

• element (DockingPoint) –

  Element to copy

Placeholder