========================== Callout (hwx.inspire.core) ========================== Display FE results at a certain location or section plane, when in a context that displays callouts. ---------- Attributes ---------- +-------------------------+-------------------------+-------------------------+ | active_: Bool | location_: Location | name_: Attribute | +-------------------------+-------------------------+-------------------------+ | resultTypes_: Attribute | visible_: Bool | | +-------------------------+-------------------------+-------------------------+ -------------- Public Methods -------------- +---------------------------------------------------------------------------------+ | classmethod getClass_ (cls, className) | +---------------------------------------------------------------------------------+ | classmethod getValidResultTypes_ (cls) | +---------------------------------------------------------------------------------+ | __new__ (cls, location, resultTypes, solverType='OPTISTRUCT_SOLVER', name=None) | +---------------------------------------------------------------------------------+ | 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. .. _location: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ location : :ref:`Location ` (units="length") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The callout location. .. _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. .. _resultTypes: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ resultTypes : :ref:`Attribute ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ResultType for Callout .. _visible: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ visible : :ref:`Bool ` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Determines whether the object is visible in the graphics window. Setting this on or off sets all children. Setting to True sets all the parents visible too. -------------- 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..] .. _getValidResultTypes: .. classmethod:: getValidResultTypes(cls) Get All the Valid Result type names. .. ___new__: .. method:: __new__(cls, location, resultTypes, solverType='OPTISTRUCT_SOLVER', name=None) Create callout at a given point in the model. :param location: x,y,z point where we want to create the callout. :type location: Point :param resultType: Call cls.getValidResultTypes for options. :type resultType: list[str] :param solverType: Solver type (OPTISTRUCT_SOLVER/SIMSOLID). :type solverType: str :param name: Name of the callout to show in gui. :returns: Return the created callout. :rtype: Callout .. _destroy: .. method:: destroy(self) Delete the object removing it from the model. The object may come back due to an undo/redo. .. _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: list[Named] :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: Search all descendents. :type recursive: bool :param \*\*kwds: Additional keyword arguments to match attributes of the object. :returns: The child object which satisfies the specified filters. :rtype: Named .. _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 objects by class. :type type: Type[Named] :param recursive: True to get all descendent Parts and Assemblies. :type recursive: bool :param sorted: Sort the children base on id. :type sorted: bool :returns: list[Named] .. _getDependents: .. method:: getDependents(self, recursive=False, **kwds) Get objects that reference this object through a Reference attribute. :param recursive: :type recursive: bool :param \*\*kwds: Filter objects using isa. :returns: set[Named] .. _getReferences: .. method:: getReferences(self, recursive=False, **kwds) Get objects this object references through a Reference attribute. :param recursive: :type recursive: bool :param \*\*kwds: Filter objects using isa. :returns: set[Named] .. _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.