======================== Named (hwx.inspire.core) ======================== Base class for all modeling objects except Features. ---------- Attributes ---------- +------------------+------------------+------------------+ | active_: Bool | name_: Attribute | visible_: Bool | +------------------+------------------+------------------+ ---------- Properties ---------- +------------+------------+------------+ | className_ | history_ | model_ | +------------+------------+------------+ | parent_ | units_ | | +------------+------------+------------+ -------------- Public Methods -------------- +-----------------------------------------------------------------------+ | classmethod getClass_ (cls, className) | +-----------------------------------------------------------------------+ | classmethod validateClassMbd_ (cls, validator) | +-----------------------------------------------------------------------+ | destroy_ (self) | +-----------------------------------------------------------------------+ | getAllChildren_ (self, type=None, **kwds) | +-----------------------------------------------------------------------+ | getChild_ (self, name=None, recursive=False, **kwds) | +-----------------------------------------------------------------------+ | getChildren_ (self, type=None, recursive=False, sorted=False, **kwds) | +-----------------------------------------------------------------------+ | getDependents_ (self, recursive=False, **kwds) | +-----------------------------------------------------------------------+ | getReferences_ (self, recursive=False, **kwds) | +-----------------------------------------------------------------------+ | isa_ (self, type=None, filter=None, name=None, wildcard=None, **kwds) | +-----------------------------------------------------------------------+ | modelPositions_ (self) | +-----------------------------------------------------------------------+ ----------------- Attribute Details ----------------- .. _active: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ active : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns or sets the object activeness. Setting this on or off sets all children. Setting to True sets all the parents active too. .. _name: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ name : :ref:`Attribute ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Returns or sets the name of the object. It can be any text string, including spaces, although it's best to avoid using the following characters: " ' * ? and $. While these characters are allowed, they could create difficulties when you export the model to other applications. .. _visible: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ visible : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Determines whether the object is visible in the modeling window. Setting this on or off sets all children. Setting to True sets all the parents visible too. ---------------- Property Details ---------------- .. _className: .. method:: className Returns the class name of the object. .. _history: .. method:: history Returns the history object to make note states for Undo/Redo. .. _model: .. method:: model Returns the model where this entity belongs to. .. _parent: .. method:: parent Returns the parent of this entity. .. _units: .. method:: units Returns the units used by model. -------------- Method Details -------------- .. _getClass: .. classmethod:: getClass(cls, className) Returns the class of the object. It can be simple or qualified (with namespace). If the name is simple, we prepend the cls.namespace. :param className: The class name. :type className: Union[Part, Occurrence, Named..] :returns: The class for the specified className. :rtype: Union[Part, Occurrence, Named..] .. _validateClassMbd: .. classmethod:: validateClassMbd(cls, validator) Validates all objects of a type for mbd realization. Useful, if you want to list all objects in the same error message. .. _destroy: .. method:: destroy(self) Destroys the object from the model. .. _getAllChildren: .. method:: getAllChildren(self, type=None, **kwds) Returns a list of all children that matches the specified type. :param type: Filter to use to get the children based on object type. :type type: Union[Part, Motor, BoundaryCondition, ...] :param \*\*kwds: Additional keyword arguments to match other attributes of the object. :returns: The list of children that satisfy the supplied filters. :rtype: list[Union[Part, Motor, BoundaryCondition, ...]] .. _getChild: .. method:: getChild(self, name=None, recursive=False, **kwds) Returns the child of the object which matches the specified unique name. :param name: The name of the child object. :type name: str :param recursive: Determines whether to search for the child till the maximum recursive depth. :type recursive: bool :param \*\*kwds: Additional keyword arguments to match attributes of the object. :returns: The child object which satisfies the specified filters. :rtype: Union[Part, Motor, BoundaryCondition, ...] .. _getChildren: .. method:: getChildren(self, type=None, recursive=False, sorted=False, **kwds) Returns a list of children that is of the specified type. :param type: Filter to use to get the children based on object type. :type type: Union[Part, Motor, BoundaryCondition, ...] :param recursive: Determines whether to search for children till the maximum recursive depth. :type recursive: bool :param sorted: Determines whether to sort the children base on id. :type sorted: bool :returns: The list of children that satisfy the supplied filters. :rtype: list[Union[Part, Motor, BoundaryCondition, ...]] .. _getDependents: .. method:: getDependents(self, recursive=False, **kwds) Returns a list of all dependents of the object. :param recursive: Determines whether to scan all the dependencies recursively. :type recursive: bool :param \*\*kwds: Additional keyword arguments to match other attributes. :returns: The list of dependencies of the object. :rtype: list[Union[Part, Motor, BoundaryCondition, ...]] .. _getReferences: .. method:: getReferences(self, recursive=False, **kwds) Returns a list of all reference of the object. :param recursive: Determines whether to scan all the reference of the references. :type recursive: bool :returns: The list of referenced objects. :rtype: list[Union[Part, Motor, BoundaryCondition, ...]] .. _isa: .. method:: isa(self, type=None, filter=None, name=None, wildcard=None, **kwds) Determines if the object matches the specified settings or not. :param type: The type of the object. :type type: Union[Part, Assembly, Contact..] :param filter: Return value of specified callback method. :type filter: method :param name: Name that matches exactly with object name. :type name: str :param wildcard: A pattern to match exactly with the object name. :type wildcard: str :param \*\*kwds: Additional keyword arguments to match other attributes. :returns: True, if a match is found, otherwise False. :rtype: bool .. _modelPositions: .. method:: modelPositions(self) Forces all objects to return the original model positions instead of the current analysis positions. Useful when defining draw methods on GeneralObjects where behaviour is different while animating.