`PrimaryCriterion`#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.PrimaryCriterion#

Bases: object

Defines a PrimaryCriterion.

Overview#

Methods

`EvaluateAllResults`	Run the EvaluateAllResults action.
`RenameBasedOnDefinition`	Run the RenameBasedOnDefinition action.
`ClearGeneratedData`	Run the ClearGeneratedData action.
`Delete`	Run the Delete action.
`GetChildren`	Gets the list of children, filtered by type.
`GetChildren`	Gets the list of children, filtered by type.
`AddComment`	Creates a new child Comment.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`Activate`	Activate the current object.
`CopyTo`	Copies all visible properties from this object to another.
`Duplicate`	Creates a copy of the current DataModelObject.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByName`	Get a property by its unique name.
`PropertyByAPIName`	Get a property by its API name.
`CreateParameter`	Creates a new parameter for a Property.
`GetParameter`	Gets the parameter corresponding to the given property.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

`CoordinateSystem`	Gets or sets the Coordinate System.
`InternalObject`	Gets the internal object. For advanced usage only.
`DirectionX`	Gets or sets the DirectionX.
`DirectionY`	Gets or sets the DirectionY.
`DirectionZ`	Gets or sets the DirectionZ.
`DiscretizationError`	Gets or sets the DiscretizationError.
`Step`	Gets or sets the Step.
`ModeNumber`	Gets or sets the ModeNumber.
`MaximumFrequency`	Gets or sets the MaximumFrequency.
`MinimumFrequency`	Gets or sets the MinimumFrequency.
`Value`	Gets the Value.
`BaseResult`	Gets or sets the BaseResult.
`FrequencyRangeType`	Gets or sets the FrequencyRangeType.
`FrequencyReduction`	Gets or sets the FrequencyReduction.
`LocationMethod`	Gets or sets the LocationMethod.
`ReferenceType`	Gets or sets the ReferenceType.
`RobustFrequenciesReduction`	Gets or sets the RobustFrequenciesReduction.
`SpatialReduction`	Gets or sets the SpatialReduction.
`SpatialReductionMethod`	Gets or sets the SpatialReductionMethod.
`VectorReduction`	Gets or sets the VectorReduction.
`BoundaryCondition`	Gets or sets the BoundaryCondition.
`RemotePoint`	Gets or sets the RemotePoint.
`Location`	Gets or sets the Location.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Suppressed`	Gets or sets the Suppressed.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`Figures`	Gets the list of associated figures.
`Images`	Gets the list of associated images.
`ReadOnly`	Gets or sets the ReadOnly.
`InternalObject`	Gets the internal object. For advanced usage only.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property PrimaryCriterion.CoordinateSystem: Ansys.Mechanical.DataModel.Interfaces.ICoordinateSystemSelection | None: Gets or sets the Coordinate System.

property PrimaryCriterion.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSTopoCriterionAuto | None: Gets the internal object. For advanced usage only.

property PrimaryCriterion.DirectionX: System.Double | None: Gets or sets the DirectionX.

property PrimaryCriterion.DirectionY: System.Double | None: Gets or sets the DirectionY.

property PrimaryCriterion.DirectionZ: System.Double | None: Gets or sets the DirectionZ.

property PrimaryCriterion.DiscretizationError: System.Double | None: Gets or sets the DiscretizationError.

property PrimaryCriterion.Step: System.Int32 | None: Gets or sets the Step.

property PrimaryCriterion.ModeNumber: System.Int32 | None: Gets or sets the ModeNumber.

property PrimaryCriterion.MaximumFrequency: Ansys.Core.Units.Quantity | None: Gets or sets the MaximumFrequency.

property PrimaryCriterion.MinimumFrequency: Ansys.Core.Units.Quantity | None: Gets or sets the MinimumFrequency.

property PrimaryCriterion.Value: Ansys.Core.Units.Quantity | None: Gets the Value.

property PrimaryCriterion.BaseResult: Ansys.Mechanical.DataModel.Enums.BaseResultType | None: Gets or sets the BaseResult.

property PrimaryCriterion.FrequencyRangeType: Ansys.Mechanical.DataModel.Enums.CriterionFrequencyRangeType | None: Gets or sets the FrequencyRangeType.

property PrimaryCriterion.FrequencyReduction: Ansys.Mechanical.DataModel.Enums.FrequencyReductionType | None: Gets or sets the FrequencyReduction.

property PrimaryCriterion.LocationMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None: Gets or sets the LocationMethod.

property PrimaryCriterion.ReferenceType: Ansys.Mechanical.DataModel.Enums.VectorReductionReferenceType | None: Gets or sets the ReferenceType.

property PrimaryCriterion.RobustFrequenciesReduction: Ansys.Mechanical.DataModel.Enums.RobustFrequenciesReductionType | None: Gets or sets the RobustFrequenciesReduction.

property PrimaryCriterion.SpatialReduction: Ansys.Mechanical.DataModel.Enums.SpatialReductionType | None: Gets or sets the SpatialReduction.

property PrimaryCriterion.SpatialReductionMethod: Ansys.Mechanical.DataModel.Enums.SpatialReductionMethodType | None: Gets or sets the SpatialReductionMethod.

property PrimaryCriterion.VectorReduction: Ansys.Mechanical.DataModel.Enums.VectorReductionType | None: Gets or sets the VectorReduction.

property PrimaryCriterion.BoundaryCondition: Ansys.ACT.Automation.Mechanical.DataModelObject | None: Gets or sets the BoundaryCondition.

property PrimaryCriterion.RemotePoint: Ansys.ACT.Automation.Mechanical.RemotePoint | None: Gets or sets the RemotePoint.

property PrimaryCriterion.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the Location.

property PrimaryCriterion.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property PrimaryCriterion.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

property PrimaryCriterion.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property PrimaryCriterion.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property PrimaryCriterion.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property PrimaryCriterion.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property PrimaryCriterion.ReadOnly: System.Boolean | None: Gets or sets the ReadOnly.

property PrimaryCriterion.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property PrimaryCriterion.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property PrimaryCriterion.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

PrimaryCriterion.EvaluateAllResults() → System.Void: Run the EvaluateAllResults action.

PrimaryCriterion.RenameBasedOnDefinition() → System.Void: Run the RenameBasedOnDefinition action.

PrimaryCriterion.ClearGeneratedData() → System.Void: Run the ClearGeneratedData action.

PrimaryCriterion.Delete() → System.Void: Run the Delete action.

PrimaryCriterion.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

PrimaryCriterion.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

PrimaryCriterion.AddComment() → Ansys.ACT.Automation.Mechanical.Comment: Creates a new child Comment.

PrimaryCriterion.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure: Creates a new child Figure.

PrimaryCriterion.AddImage(filePath: System.String) → Ansys.ACT.Automation.Mechanical.Image

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.

PrimaryCriterion.Activate() → System.Void: Activate the current object.

PrimaryCriterion.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

PrimaryCriterion.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

PrimaryCriterion.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

PrimaryCriterion.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

PrimaryCriterion.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

PrimaryCriterion.PropertyByAPIName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property

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.

PrimaryCriterion.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

PrimaryCriterion.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

PrimaryCriterion.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.