diff --git a/src/Base/TypePy.xml b/src/Base/TypePy.xml index ccccd1253b..f62728105b 100644 --- a/src/Base/TypePy.xml +++ b/src/Base/TypePy.xml @@ -17,78 +17,99 @@ namespace Base { This is the Type class - This is the Type class + Base.BaseType class.\n +This class is not intended to create instances of itself, but to get information +from the different types and create instances of them. +Regarding instantiation, this is possible in cases that inherit from the +Base::BaseClass class and are not abstract classes. - Returns a type object by name + fromName(name) -> Base.BaseType\n +Returns a type object by name.\n +name : str - Returns a type object by key + fromKey(key) -> Base.BaseType\n +Returns a type id object by key.\n +key : int - Returns the number of type ids + getNumTypes() -> int\n +Returns the number of type ids created so far. - Returns an invalid type id + getBadType() -> Base.BaseType\n +Returns an invalid type id. - Returns all descendants + getAllDerivedFrom(type) -> list\n +Returns all descendants from the given type id.\n +type : str, Base.BaseType - Returns the parent type id + getParent() -> Base.BaseType\n +Returns the parent type id. - Checks if the type id is invalid + isBad() -> bool\n +Checks if the type id is invalid. - Returns true if given type is a father + isDerivedFrom(type) -> bool\n +Returns true if given type id is a father of this type id.\n +type : str, Base.BaseType - Returns all descendants + getAllDerived() -> list\n +Returns all descendants from this type id. - Creates an instance of this type + createInstance() -> object\n +Creates an instance of this type id. - Creates an instance of the named type + createInstanceByName(name, load=False) -> object\n +Creates an instance of the named type id.\n +name : str +load : bool\n Load named type id module. - The name of the type id + The name of the type id. - The key of the type id + The key of the type id. - Module in which this class is defined + Module in which this class is defined.