* Added-API-Documentation-for-RectangularTrimmedSurfacePy.xml * Added-API-Documentation-for-PlateSurfacePy.xml * Added-API-Documentation-for-ShapeFix.xml * Added-Back-Missing-Docs * Add Missing Documentation to BuildPlateSurface * Elaborate ComplexGeoData Functions * Elaborate ComplexGeoData Functions * Elaborates TypePy * Add Missing Documentation to AreaPy
133 lines
4.0 KiB
XML
133 lines
4.0 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
|
|
<PythonExport
|
|
Father="PyObjectBase"
|
|
Name="TypePy"
|
|
Twin="BaseType"
|
|
TwinPointer="BaseType"
|
|
Include="Base/Type.h"
|
|
FatherInclude="Base/PyObjectBase.h"
|
|
Namespace="Base"
|
|
FatherNamespace="Base"
|
|
Delete="true">
|
|
<ForwardDeclarations>
|
|
namespace Base {
|
|
using BaseType = Type;
|
|
}</ForwardDeclarations>
|
|
<Documentation>
|
|
<Author Licence="LGPL" Name="Juergen Riegel" EMail="FreeCAD@juergen-riegel.net" />
|
|
<DeveloperDocu>This is the Type class</DeveloperDocu>
|
|
<UserDocu>BaseTypePy class.
|
|
|
|
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>
|
|
</Documentation>
|
|
<Methode Name="fromName" Static="true">
|
|
<Documentation>
|
|
<UserDocu>fromName(name) -> Base.BaseType
|
|
|
|
Returns a type object by name.
|
|
|
|
name : str</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Methode Name="fromKey" Static="true">
|
|
<Documentation>
|
|
<UserDocu>fromKey(key) -> Base.BaseType
|
|
|
|
Returns a type id object by key.
|
|
|
|
key : int</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Methode Name="getNumTypes" Static="true">
|
|
<Documentation>
|
|
<UserDocu>getNumTypes() -> int
|
|
|
|
Returns the number of type ids created so far.</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Methode Name="getBadType" Static="true">
|
|
<Documentation>
|
|
<UserDocu>getBadType() -> Base.BaseType
|
|
|
|
Returns an invalid type id.</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Methode Name="getAllDerivedFrom" Static="true">
|
|
<Documentation>
|
|
<UserDocu>getAllDerivedFrom(type) -> list
|
|
|
|
Returns all descendants from the given type id.
|
|
|
|
type : str, Base.BaseType</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Methode Name="getParent" Const="true">
|
|
<Documentation>
|
|
<UserDocu>getParent() -> Base.BaseType
|
|
|
|
Returns the parent type id.</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Methode Name="isBad" Const="true">
|
|
<Documentation>
|
|
<UserDocu>isBad() -> bool
|
|
|
|
Checks if the type id is invalid.</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Methode Name="isDerivedFrom" Const="true">
|
|
<Documentation>
|
|
<UserDocu>isDerivedFrom(type) -> bool
|
|
|
|
Returns true if given type id is a father of this type id.
|
|
|
|
type : str, Base.BaseType</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Methode Name="getAllDerived" Const="true">
|
|
<Documentation>
|
|
<UserDocu>getAllDerived() -> list
|
|
|
|
Returns all descendants from this type id.</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Methode Name="createInstance">
|
|
<Documentation>
|
|
<UserDocu>createInstance() -> object
|
|
|
|
Creates an instance of this type id.</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Methode Name="createInstanceByName" Static="true">
|
|
<Documentation>
|
|
<UserDocu>createInstanceByName(name, load=False) -> object
|
|
|
|
Creates an instance of the named type id.
|
|
|
|
name : str
|
|
load : bool
|
|
Load named type id module.</UserDocu>
|
|
</Documentation>
|
|
</Methode>
|
|
<Attribute Name="Name" ReadOnly="true">
|
|
<Documentation>
|
|
<UserDocu>The name of the type id.</UserDocu>
|
|
</Documentation>
|
|
<Parameter Name="Name" Type="String" />
|
|
</Attribute>
|
|
<Attribute Name="Key" ReadOnly="true">
|
|
<Documentation>
|
|
<UserDocu>The key of the type id.</UserDocu>
|
|
</Documentation>
|
|
<Parameter Name="Key" Type="Long" />
|
|
</Attribute>
|
|
<Attribute Name="Module" ReadOnly="true">
|
|
<Documentation>
|
|
<UserDocu>Module in which this class is defined.</UserDocu>
|
|
</Documentation>
|
|
<Parameter Name="Module" Type="String"/>
|
|
</Attribute>
|
|
</PythonExport>
|
|
</GenerateModel>
|