FreeCAD

1
<?xml version="1.0" encoding="UTF-8"?>
2
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
3
  <PythonExport
4
      Father="PyObjectBase"
5
      Name="TypePy"
6
      Twin="BaseType"
7
      TwinPointer="BaseType"
8
      Include="Base/Type.h"
9
      FatherInclude="Base/PyObjectBase.h"
10
      Namespace="Base"
11
      FatherNamespace="Base"
12
      Delete="true">
13
    <ForwardDeclarations>
14
namespace Base {
15
    using BaseType = Type;
16
}</ForwardDeclarations>
17
    <Documentation>
18
      <Author Licence="LGPL" Name="Juergen Riegel" EMail="FreeCAD@juergen-riegel.net" />
19
      <DeveloperDocu>This is the Type class</DeveloperDocu>
20
      <UserDocu>BaseTypePy class.
21

22
        This class provides functionality related to type management in the Base module. It's not intended for direct instantiation but for accessing type information and creating instances of various types. Instantiation is possible for classes that inherit from the Base::BaseClass class and are not abstract.</UserDocu>
23
    </Documentation>
24
    <Methode Name="fromName" Static="true">
25
      <Documentation>
26
        <UserDocu>fromName(name) -> Base.BaseType
27

28
Returns a type object by name.
29

30
name : str</UserDocu>
31
      </Documentation>
32
    </Methode>
33
    <Methode Name="fromKey" Static="true">
34
      <Documentation>
35
        <UserDocu>fromKey(key) -> Base.BaseType
36

37
Returns a type id object by key.
38

39
key : int</UserDocu>
40
      </Documentation>
41
    </Methode>
42
    <Methode Name="getNumTypes" Static="true">
43
      <Documentation>
44
        <UserDocu>getNumTypes() -> int
45

46
Returns the number of type ids created so far.</UserDocu>
47
      </Documentation>
48
    </Methode>
49
    <Methode Name="getBadType" Static="true">
50
      <Documentation>
51
        <UserDocu>getBadType() -> Base.BaseType
52

53
Returns an invalid type id.</UserDocu>
54
      </Documentation>
55
    </Methode>
56
    <Methode Name="getAllDerivedFrom" Static="true">
57
      <Documentation>
58
        <UserDocu>getAllDerivedFrom(type) -> list
59

60
Returns all descendants from the given type id.
61

62
type : str, Base.BaseType</UserDocu>
63
      </Documentation>
64
    </Methode>
65
    <Methode Name="getParent" Const="true">
66
      <Documentation>
67
        <UserDocu>getParent() -> Base.BaseType
68

69
Returns the parent type id.</UserDocu>
70
      </Documentation>
71
    </Methode>
72
    <Methode Name="isBad" Const="true">
73
      <Documentation>
74
        <UserDocu>isBad() -> bool
75

76
Checks if the type id is invalid.</UserDocu>
77
      </Documentation>
78
    </Methode>
79
    <Methode Name="isDerivedFrom" Const="true">
80
      <Documentation>
81
        <UserDocu>isDerivedFrom(type) -> bool
82

83
Returns true if given type id is a father of this type id.
84

85
type : str, Base.BaseType</UserDocu>
86
      </Documentation>
87
    </Methode>
88
    <Methode Name="getAllDerived" Const="true">
89
      <Documentation>
90
        <UserDocu>getAllDerived() -> list
91

92
Returns all descendants from this type id.</UserDocu>
93
      </Documentation>
94
    </Methode>
95
    <Methode Name="createInstance">
96
      <Documentation>
97
        <UserDocu>createInstance() -> object
98

99
Creates an instance of this type id.</UserDocu>
100
      </Documentation>
101
    </Methode>
102
    <Methode Name="createInstanceByName" Static="true">
103
      <Documentation>
104
        <UserDocu>createInstanceByName(name, load=False) -> object
105

106
Creates an instance of the named type id.
107

108
name : str
109
load : bool
110
    Load named type id module.</UserDocu>
111
      </Documentation>
112
    </Methode>
113
    <Attribute Name="Name" ReadOnly="true">
114
      <Documentation>
115
        <UserDocu>The name of the type id.</UserDocu>
116
      </Documentation>
117
      <Parameter Name="Name" Type="String" />
118
    </Attribute>
119
    <Attribute Name="Key" ReadOnly="true">
120
      <Documentation>
121
        <UserDocu>The key of the type id.</UserDocu>
122
      </Documentation>
123
      <Parameter Name="Key" Type="Long" />
124
    </Attribute>
125
    <Attribute Name="Module" ReadOnly="true">
126
      <Documentation>
127
        <UserDocu>Module in which this class is defined.</UserDocu>
128
      </Documentation>
129
      <Parameter Name="Module" Type="String"/>
130
    </Attribute>
131
  </PythonExport>
132
</GenerateModel>
133