.. vale off :class:`PrimaryCriterion` ========================= .. py:class:: ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.PrimaryCriterion Bases: :py:obj:`object` Defines a PrimaryCriterion. .. !! processed by numpydoc !! .. py:currentmodule:: PrimaryCriterion Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~Activate` - Activate the current object. * - :py:attr:`~AddComment` - Creates a new child Comment. * - :py:attr:`~AddFigure` - Creates a new child Figure. * - :py:attr:`~AddImage` - Creates a new child Image. * - :py:attr:`~ClearGeneratedData` - Run the ClearGeneratedData action. * - :py:attr:`~CopyTo` - Copies all visible properties from this object to another. * - :py:attr:`~CreateParameter` - Creates a new parameter for a Property. * - :py:attr:`~Delete` - Run the Delete action. * - :py:attr:`~Duplicate` - Creates a copy of the current DataModelObject. * - :py:attr:`~EvaluateAllResults` - Run the EvaluateAllResults action. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~GetParameter` - Gets the parameter corresponding to the given property. * - :py:attr:`~GroupAllSimilarChildren` - Run the GroupAllSimilarChildren action. * - :py:attr:`~GroupSimilarObjects` - Run the GroupSimilarObjects action. * - :py:attr:`~PropertyByAPIName` - Get a property by its API name. * - :py:attr:`~PropertyByName` - Get a property by its unique name. * - :py:attr:`~RemoveParameter` - Removes the parameter from the parameter set corresponding to the given property. * - :py:attr:`~RenameBasedOnDefinition` - Run the RenameBasedOnDefinition action. .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~BaseResult` - Gets or sets the BaseResult. * - :py:attr:`~BoundaryCondition` - Gets or sets the BoundaryCondition. * - :py:attr:`~Children` - Gets the list of children. * - :py:attr:`~Comments` - Gets the list of associated comments. * - :py:attr:`~CoordinateSystem` - Gets or sets the Coordinate System. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~DirectionX` - Gets or sets the DirectionX. * - :py:attr:`~DirectionY` - Gets or sets the DirectionY. * - :py:attr:`~DirectionZ` - Gets or sets the DirectionZ. * - :py:attr:`~DiscretizationError` - Gets or sets the DiscretizationError. * - :py:attr:`~Figures` - Gets the list of associated figures. * - :py:attr:`~FrequencyRangeType` - Gets or sets the FrequencyRangeType. * - :py:attr:`~FrequencyReduction` - Gets or sets the FrequencyReduction. * - :py:attr:`~Images` - Gets the list of associated images. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~Location` - Gets or sets the Location. * - :py:attr:`~LocationMethod` - Gets or sets the LocationMethod. * - :py:attr:`~MaximumFrequency` - Gets or sets the MaximumFrequency. * - :py:attr:`~MinimumFrequency` - Gets or sets the MinimumFrequency. * - :py:attr:`~ModeNumber` - Gets or sets the ModeNumber. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~ReadOnly` - Gets or sets the ReadOnly. * - :py:attr:`~ReferenceType` - Gets or sets the ReferenceType. * - :py:attr:`~RemotePoint` - Gets or sets the RemotePoint. * - :py:attr:`~RobustFrequenciesReduction` - Gets or sets the RobustFrequenciesReduction. * - :py:attr:`~SpatialReduction` - Gets or sets the SpatialReduction. * - :py:attr:`~SpatialReductionMethod` - Gets or sets the SpatialReductionMethod. * - :py:attr:`~Step` - Gets or sets the Step. * - :py:attr:`~Suppressed` - Gets or sets the Suppressed. * - :py:attr:`~Value` - Gets the Value. * - :py:attr:`~VectorReduction` - Gets or sets the VectorReduction. * - :py:attr:`~VisibleProperties` - Gets the list of properties that are visible for this object. Property detail --------------- .. py:property:: BaseResult :type: Optional[Ansys.Mechanical.DataModel.Enums.BaseResultType] Gets or sets the BaseResult. .. !! processed by numpydoc !! .. py:property:: BoundaryCondition :type: Optional[Ansys.ACT.Automation.Mechanical.DataModelObject] Gets or sets the BoundaryCondition. .. !! processed by numpydoc !! .. py:property:: Children :type: Optional[List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]] Gets the list of children. .. !! processed by numpydoc !! .. py:property:: Comments :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Comment]] Gets the list of associated comments. .. !! processed by numpydoc !! .. py:property:: CoordinateSystem :type: Optional[Ansys.Mechanical.DataModel.Interfaces.ICoordinateSystemSelection] Gets or sets the Coordinate System. .. !! processed by numpydoc !! .. py:property:: DataModelObjectCategory :type: Optional[Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory] Gets the current DataModelObject's category. .. !! processed by numpydoc !! .. py:property:: DirectionX :type: Optional[float] Gets or sets the DirectionX. .. !! processed by numpydoc !! .. py:property:: DirectionY :type: Optional[float] Gets or sets the DirectionY. .. !! processed by numpydoc !! .. py:property:: DirectionZ :type: Optional[float] Gets or sets the DirectionZ. .. !! processed by numpydoc !! .. py:property:: DiscretizationError :type: Optional[float] Gets or sets the DiscretizationError. .. !! processed by numpydoc !! .. py:property:: Figures :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Figure]] Gets the list of associated figures. .. !! processed by numpydoc !! .. py:property:: FrequencyRangeType :type: Optional[Ansys.Mechanical.DataModel.Enums.CriterionFrequencyRangeType] Gets or sets the FrequencyRangeType. .. !! processed by numpydoc !! .. py:property:: FrequencyReduction :type: Optional[Ansys.Mechanical.DataModel.Enums.FrequencyReductionType] Gets or sets the FrequencyReduction. .. !! processed by numpydoc !! .. py:property:: Images :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Image]] Gets the list of associated images. .. !! processed by numpydoc !! .. py:property:: InternalObject :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSTopoCriterionAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: Location :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the Location. .. !! processed by numpydoc !! .. py:property:: LocationMethod :type: Optional[Ansys.Mechanical.DataModel.Enums.GeometryDefineByType] Gets or sets the LocationMethod. .. !! processed by numpydoc !! .. py:property:: MaximumFrequency :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the MaximumFrequency. .. !! processed by numpydoc !! .. py:property:: MinimumFrequency :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the MinimumFrequency. .. !! processed by numpydoc !! .. py:property:: ModeNumber :type: Optional[int] Gets or sets the ModeNumber. .. !! processed by numpydoc !! .. py:property:: Properties :type: Optional[tuple[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties for this object. .. !! processed by numpydoc !! .. py:property:: ReadOnly :type: Optional[bool] Gets or sets the ReadOnly. .. !! processed by numpydoc !! .. py:property:: ReferenceType :type: Optional[Ansys.Mechanical.DataModel.Enums.VectorReductionReferenceType] Gets or sets the ReferenceType. .. !! processed by numpydoc !! .. py:property:: RemotePoint :type: Optional[Ansys.ACT.Automation.Mechanical.RemotePoint] Gets or sets the RemotePoint. .. !! processed by numpydoc !! .. py:property:: RobustFrequenciesReduction :type: Optional[Ansys.Mechanical.DataModel.Enums.RobustFrequenciesReductionType] Gets or sets the RobustFrequenciesReduction. .. !! processed by numpydoc !! .. py:property:: SpatialReduction :type: Optional[Ansys.Mechanical.DataModel.Enums.SpatialReductionType] Gets or sets the SpatialReduction. .. !! processed by numpydoc !! .. py:property:: SpatialReductionMethod :type: Optional[Ansys.Mechanical.DataModel.Enums.SpatialReductionMethodType] Gets or sets the SpatialReductionMethod. .. !! processed by numpydoc !! .. py:property:: Step :type: Optional[int] Gets or sets the Step. .. !! processed by numpydoc !! .. py:property:: Suppressed :type: Optional[bool] Gets or sets the Suppressed. .. !! processed by numpydoc !! .. py:property:: Value :type: Optional[Ansys.Core.Units.Quantity] Gets the Value. .. !! processed by numpydoc !! .. py:property:: VectorReduction :type: Optional[Ansys.Mechanical.DataModel.Enums.VectorReductionType] Gets or sets the VectorReduction. .. !! processed by numpydoc !! .. py:property:: VisibleProperties :type: Optional[tuple[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties that are visible for this object. .. !! processed by numpydoc !! Method detail ------------- .. py:method:: Activate() -> None Activate the current object. .. !! processed by numpydoc !! .. py:method:: AddComment() -> Ansys.ACT.Automation.Mechanical.Comment Creates a new child Comment. .. !! processed by numpydoc !! .. py:method:: AddFigure() -> Ansys.ACT.Automation.Mechanical.Figure Creates a new child Figure. .. !! processed by numpydoc !! .. py:method:: AddImage(filePath: str) -> Ansys.ACT.Automation.Mechanical.Image .. code-block:: text Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the image will be a screen capture of the Geometry window. .. !! processed by numpydoc !! .. py:method:: ClearGeneratedData() -> None Run the ClearGeneratedData action. .. !! processed by numpydoc !! .. py:method:: CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) -> None Copies all visible properties from this object to another. .. !! processed by numpydoc !! .. py:method:: CreateParameter(propName: str) -> Ansys.ACT.Interfaces.Mechanical.IParameter Creates a new parameter for a Property. .. !! processed by numpydoc !! .. py:method:: Delete() -> None Run the Delete action. .. !! processed by numpydoc !! .. py:method:: Duplicate() -> Ansys.Mechanical.DataModel.Interfaces.IDataModelObject Creates a copy of the current DataModelObject. .. !! processed by numpydoc !! .. py:method:: EvaluateAllResults() -> None Run the EvaluateAllResults action. .. !! processed by numpydoc !! .. py:method:: GetChildren(recurses: bool, children: List[ChildrenType]) -> List[ChildrenType] Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: GetParameter(propName: str) -> Ansys.ACT.Interfaces.Mechanical.IParameter Gets the parameter corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: GroupAllSimilarChildren() -> None Run the GroupAllSimilarChildren action. .. !! processed by numpydoc !! .. py:method:: GroupSimilarObjects() -> Ansys.ACT.Automation.Mechanical.TreeGroupingFolder Run the GroupSimilarObjects action. .. !! processed by numpydoc !! .. py:method:: PropertyByAPIName(name: str) -> Ansys.ACT.Automation.Mechanical.Property .. code-block:: text Get a property by its API name. If multiple properties have the same API Name, only the first property with that name will be returned. .. !! processed by numpydoc !! .. py:method:: PropertyByName(name: str) -> Ansys.ACT.Automation.Mechanical.Property Get a property by its unique name. .. !! processed by numpydoc !! .. py:method:: RemoveParameter(propName: str) -> None Removes the parameter from the parameter set corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: RenameBasedOnDefinition() -> None Run the RenameBasedOnDefinition action. .. !! processed by numpydoc !! .. vale on