Skip to content

Enum types

Node symbols

node_symbol

Bases: IntEnum

node symbol

Examples:

>>> cadwork.node_symbol.SmallSquare
SmallSquare
Source code in src/cadwork/node_symbol.pyi
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
@unique
class node_symbol(IntEnum):
    """node symbol

    Examples:
        >>> cadwork.node_symbol.SmallSquare
        SmallSquare
    """
    SmallSquare = 1
    """"""
    Square = 2
    """"""
    Cross = 3
    """"""
    Circle = 4
    """"""
    FilledCircle = 5
    """"""
    ChessSquare = 6
    """"""
    HalfFilledSquare = 7
    """"""
    CrossSquare = 8
    """"""
    FilledSquare = 9
    """"""

    def __int__(self) -> int:
        return self.value

ChessSquare = 6 class-attribute instance-attribute

Circle = 4 class-attribute instance-attribute

Cross = 3 class-attribute instance-attribute

CrossSquare = 8 class-attribute instance-attribute

FilledCircle = 5 class-attribute instance-attribute

FilledSquare = 9 class-attribute instance-attribute

HalfFilledSquare = 7 class-attribute instance-attribute

SmallSquare = 1 class-attribute instance-attribute

Square = 2 class-attribute instance-attribute

Element module

element_module_detail

Bases: IntEnum

element module detail

Examples:

>>> cadwork.element_module_detail.no_detail
no_detail
Source code in src/cadwork/element_module_detail.pyi
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
@unique
class element_module_detail(IntEnum):
    """element module detail

    Examples:
        >>> cadwork.element_module_detail.no_detail
        no_detail
    """
    no_detail = 1
    """"""
    angle_detail = 2
    """"""
    area_detail = 3
    """"""
    cross_detail = 4
    """"""
    edge_detail = 5
    """"""
    end_detail = 6
    """"""
    line_detail = 7
    """"""
    open_detail = 8
    """"""
    t_detail = 9
    """"""
    floor_area_detail = 10
    """"""
    floor_end_detail = 11
    """"""
    floor_line_detail = 12
    """"""
    floor_open_detail = 13
    """"""

    def __int__(self) -> int:
        return self.value

angle_detail = 2 class-attribute instance-attribute

area_detail = 3 class-attribute instance-attribute

cross_detail = 4 class-attribute instance-attribute

edge_detail = 5 class-attribute instance-attribute

end_detail = 6 class-attribute instance-attribute

floor_area_detail = 10 class-attribute instance-attribute

floor_end_detail = 11 class-attribute instance-attribute

floor_line_detail = 12 class-attribute instance-attribute

floor_open_detail = 13 class-attribute instance-attribute

line_detail = 7 class-attribute instance-attribute

no_detail = 1 class-attribute instance-attribute

open_detail = 8 class-attribute instance-attribute

t_detail = 9 class-attribute instance-attribute

division_zone_direction

Bases: IntEnum

division zone direction

Examples:

>>> cadwork.division_zone_direction.positive
positive
Source code in src/cadwork/division_zone_direction.pyi
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
@unique
class division_zone_direction(IntEnum):
    """division zone direction

    Examples:
        >>> cadwork.division_zone_direction.positive
        positive
    """
    positive = 1
    """"""
    negative = 2
    """"""
    no_direction = 3
    """"""

    def __int__(self) -> int:
        return self.value

negative = 2 class-attribute instance-attribute

no_direction = 3 class-attribute instance-attribute

positive = 1 class-attribute instance-attribute

element_grouping_type

Bases: IntEnum

element grouping type

Examples:

>>> cadwork.element_grouping_type.group
group
Source code in src/cadwork/element_grouping_type.pyi
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
@unique
class element_grouping_type(IntEnum):
    """element grouping type

    Examples:
        >>> cadwork.element_grouping_type.group
        group
    """
    group = 1
    """"""
    subgroup = 2
    """"""

    def __int__(self) -> int:
        return self.value

group = 1 class-attribute instance-attribute

subgroup = 2 class-attribute instance-attribute

F-Keys

shortcut_key

Bases: IntEnum

shortcut key

Examples:

>>> cadwork.shortcut_key.F1
F1
Source code in src/cadwork/shortcut_key.pyi
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
@unique
class shortcut_key(IntEnum):
    """shortcut key

    Examples:
        >>> cadwork.shortcut_key.F1
        F1
    """
    F1 = 1
    """"""
    F2 = 2
    """"""
    F3 = 3
    """"""
    F4 = 4
    """"""
    F5 = 5
    """"""
    F6 = 6
    """"""
    F7 = 7
    """"""
    F8 = 8
    """"""
    F9 = 9
    """"""
    F10 = 10
    """"""
    F11 = 11
    """"""
    F12 = 12
    """"""

    def __int__(self) -> int:
        return self.value

F1 = 1 class-attribute instance-attribute

F10 = 10 class-attribute instance-attribute

F11 = 11 class-attribute instance-attribute

F12 = 12 class-attribute instance-attribute

F2 = 2 class-attribute instance-attribute

F3 = 3 class-attribute instance-attribute

F4 = 4 class-attribute instance-attribute

F5 = 5 class-attribute instance-attribute

F6 = 6 class-attribute instance-attribute

F7 = 7 class-attribute instance-attribute

F8 = 8 class-attribute instance-attribute

F9 = 9 class-attribute instance-attribute

shortcut_key_modifier

Bases: IntEnum

shortcut key modifier

Examples:

>>> cadwork.shortcut_key_modifier.shift
shift
Source code in src/cadwork/shortcut_key_modifier.pyi
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
@unique
class shortcut_key_modifier(IntEnum):
    """shortcut key modifier

    Examples:
        >>> cadwork.shortcut_key_modifier.shift
        shift
    """
    shift = 1
    """"""
    ctrl = 2
    """"""
    alt = 3
    """"""

    def __int__(self) -> int:
        return self.value

alt = 3 class-attribute instance-attribute

ctrl = 2 class-attribute instance-attribute

shift = 1 class-attribute instance-attribute

Machines

btl_version

Bases: IntEnum

btl version

Examples:

>>> cadwork.btl_version.btlx_1_0
btlx_1_0
Source code in src/cadwork/btl_version.pyi
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
@unique
class btl_version(IntEnum):
    """btl version

    Examples:
        >>> cadwork.btl_version.btlx_1_0
        btlx_1_0
    """
    btlx_1_0 = 110
    """"""
    btlx_1_1 = 111
    """"""
    btl_1_2 = 112
    """"""
    btl_1_3 = 113
    """"""
    btl_1_4 = 114
    """"""
    btl_1_5 = 115
    """"""
    btl_1_6 = 116
    """"""
    btl_10_0 = 100
    """"""
    btl_10_1 = 101
    """"""
    btl_10_2 = 102
    """"""
    btl_10_3 = 103
    """"""
    btl_10_4 = 104
    """"""
    btl_10_5 = 105
    """"""
    btl_10_6 = 106
    """"""
    btlx_2_0 = 120
    """"""
    btlx_2_1 = 121
    """"""
    btlx_2_2 = 122
    """"""

    def __int__(self) -> int:
        return self.value

btl_10_0 = 100 class-attribute instance-attribute

btl_10_1 = 101 class-attribute instance-attribute

btl_10_2 = 102 class-attribute instance-attribute

btl_10_3 = 103 class-attribute instance-attribute

btl_10_4 = 104 class-attribute instance-attribute

btl_10_5 = 105 class-attribute instance-attribute

btl_10_6 = 106 class-attribute instance-attribute

btl_1_2 = 112 class-attribute instance-attribute

btl_1_3 = 113 class-attribute instance-attribute

btl_1_4 = 114 class-attribute instance-attribute

btl_1_5 = 115 class-attribute instance-attribute

btl_1_6 = 116 class-attribute instance-attribute

btlx_1_0 = 110 class-attribute instance-attribute

btlx_1_1 = 111 class-attribute instance-attribute

btlx_2_0 = 120 class-attribute instance-attribute

btlx_2_1 = 121 class-attribute instance-attribute

btlx_2_2 = 122 class-attribute instance-attribute

hundegger_machine_type

Bases: IntEnum

hundegger machine type

Examples:

>>> cadwork.hundegger_machine_type.p8_10
p8_10
Source code in src/cadwork/hundegger_machine_type.pyi
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
@unique
class hundegger_machine_type(IntEnum):
    """hundegger machine type

    Examples:
        >>> cadwork.hundegger_machine_type.p8_10
        p8_10
    """
    p8_10 = 1
    """"""
    k1 = 2
    """"""
    k2 = 3
    """"""
    k2_cambium = 4
    """"""
    k2_uf_5 = 5
    """"""
    k2_uf_5_cambium = 6
    """"""
    speedcut = 7
    """"""
    pba = 8
    """"""
    pba_bvx = 9
    """"""
    pba_bvx_cambium = 10
    """"""
    spm = 12
    """"""
    spm_cambium = 13
    """"""
    robot_drive = 14
    """"""
    turbo_drive = 15
    """"""

    def __int__(self) -> int:
        return self.value

k1 = 2 class-attribute instance-attribute

k2 = 3 class-attribute instance-attribute

k2_cambium = 4 class-attribute instance-attribute

k2_uf_5 = 5 class-attribute instance-attribute

k2_uf_5_cambium = 6 class-attribute instance-attribute

p8_10 = 1 class-attribute instance-attribute

pba = 8 class-attribute instance-attribute

pba_bvx = 9 class-attribute instance-attribute

pba_bvx_cambium = 10 class-attribute instance-attribute

robot_drive = 14 class-attribute instance-attribute

speedcut = 7 class-attribute instance-attribute

spm = 12 class-attribute instance-attribute

spm_cambium = 13 class-attribute instance-attribute

turbo_drive = 15 class-attribute instance-attribute

weinmann_mfb_version

Bases: IntEnum

weinmann mfb version

Examples:

>>> cadwork.weinmann_mfb_version.wup_2_0
wup_2_0
Source code in src/cadwork/weinmann_mfb_version.pyi
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
@unique
class weinmann_mfb_version(IntEnum):
    """weinmann mfb version

    Examples:
        >>> cadwork.weinmann_mfb_version.wup_2_0
        wup_2_0
    """
    wup_2_0 = 20
    """"""
    wup_3_1 = 31
    """"""
    wup_3_2 = 32
    """"""
    wup_3_3 = 33
    """"""
    wup_3_4 = 34
    """"""

    def __int__(self) -> int:
        return self.value

wup_2_0 = 20 class-attribute instance-attribute

wup_3_1 = 31 class-attribute instance-attribute

wup_3_2 = 32 class-attribute instance-attribute

wup_3_3 = 33 class-attribute instance-attribute

wup_3_4 = 34 class-attribute instance-attribute

IFC Aggregation Behaviour

ifc_element_combine_behaviour

Bases: IntEnum

ifc element combine behaviour

Examples:

>>> cadwork.ifc_element_combine_behaviour.element_module
element_module
Source code in src/cadwork/ifc_element_combine_behaviour.pyi
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
@unique
class ifc_element_combine_behaviour(IntEnum):
    """ifc element combine behaviour

    Examples:
        >>> cadwork.ifc_element_combine_behaviour.element_module
        element_module
    """
    element_module = 0
    """"""
    element_assembly = 1
    """"""

    def __int__(self) -> int:
        return self.value

element_assembly = 1 class-attribute instance-attribute

element_module = 0 class-attribute instance-attribute

Multi Layer Cover Type

multi_layer_type

Bases: IntEnum

multi layer type

Examples:

>>> cadwork.multi_layer_type.undefined
undefined
Source code in src/cadwork/multi_layer_type.pyi
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
@unique
class multi_layer_type(IntEnum):
    """multi layer type

    Examples:
        >>> cadwork.multi_layer_type.undefined
        undefined
    """
    undefined = 0
    """"""
    structure = 1
    """"""
    panel = 2
    """"""
    lathing = 3
    """"""
    air = 4
    """"""
    covering = 5
    """"""

    def __int__(self) -> int:
        return self.value

air = 4 class-attribute instance-attribute

covering = 5 class-attribute instance-attribute

lathing = 3 class-attribute instance-attribute

panel = 2 class-attribute instance-attribute

structure = 1 class-attribute instance-attribute

undefined = 0 class-attribute instance-attribute