ReferencePlaneID

Canonical path: NemAll_Python_ArchElements.ReferencePlaneID

struct for handling reference plane IDs

Methods:

• Invalidate –

  Set values to undefined state

• IsDefaultLowerPlane –

  Find out if reference plane is default lower reference plane

• IsDefaultUpperPlane –

  Find out if reference plane is default upper reference plane

• IsDocumentRefSurface –

  Find out if reference surface is from document

• IsInModel –

  Find out if reference plane is in model

• IsValid –

  Get validity of ref plane

• SetCustomLowerPlane –

  Set values to custom lower state

• SetCustomUpperPlane –

  Set values to custom upper state

• __eq__ –

  Equal operator

• __init__ –

  dummy, is only needed for the creation of the documentation by MkDocs

• __lt__ –

  Less operator

• __ne__ –

  Unequal operator

• __repr__ –

  Convert to string

Attributes:

• ModelGuid (GUID) –

  Get model

• PlaneId (int) –

  Get plane ID

ModelGuid property writable

ModelGuid: GUID

Get model

change model id to another

PlaneId property

PlaneId: int

Get plane ID

Invalidate

Invalidate()

Set values to undefined state

IsDefaultLowerPlane

IsDefaultLowerPlane() -> bool

Find out if reference plane is default lower reference plane

Returns:

• bool –

  true if ref plane is default lower ref plane

IsDefaultUpperPlane

IsDefaultUpperPlane() -> bool

Find out if reference plane is default upper reference plane

Returns:

• bool –

  true if ref plane is default upper ref plane

IsDocumentRefSurface

IsDocumentRefSurface() -> bool

Find out if reference surface is from document

Returns:

• bool –

  true is reference surface from document (not in model)

IsInModel

IsInModel() -> bool

Find out if reference plane is in model

Returns:

• bool –

  true if ref plane is in model

IsValid

IsValid() -> bool

Get validity of ref plane

Returns:

• bool –

  true if ref plane is valid

SetCustomLowerPlane

SetCustomLowerPlane()

Set values to custom lower state

SetCustomUpperPlane

SetCustomUpperPlane()

Set values to custom upper state

__eq__

__eq__(other: ReferencePlaneID) -> bool

Equal operator

Parameters:

• other (ReferencePlaneID) –

  Reference plane ID to compare

Returns:

• bool –

  Reference plane IDs are equal

__init__ overloaded

__init__()

Initialize

__init__(modelGuid: GUID, planeId: int)

Constructor

Parameters:

• modelGuid (GUID) –

  Model guid

• planeId (int) –

  Plane ID

__init__(element: ReferencePlaneID)

Copy constructor

Parameters:

• element (ReferencePlaneID) –

  Element to copy

__lt__

__lt__(other: ReferencePlaneID) -> bool

Less operator

Parameters:

• other (ReferencePlaneID) –

  Reference plane ID to compare

Returns:

• bool –

  Reference plane is lees then other

__ne__

__ne__(other: ReferencePlaneID) -> bool

Unequal operator

Parameters:

• other (ReferencePlaneID) –

  Reference plane ID to compare

Returns:

• bool –

  Reference plane IDs are not equal

__repr__

__repr__() -> str

Convert to string