PrimaryCriterion

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.PrimaryCriterion(internalObject: Any)

Bases: object

Defines a PrimaryCriterion.

Overview

Methods

Activate	Activate the current object.
AddComment	Creates a new child Comment.
AddFigure	Creates a new child Figure.
AddImage	Creates a new child Image.
ClearGeneratedData	Run the ClearGeneratedData action.
CopyTo	Copies all visible properties from this object to another.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
EvaluateAllResults	Run the EvaluateAllResults action.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetQuantityName	GetQuantityName method.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
PropertyByName	Get a property by its unique name.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
RenameBasedOnDefinition	Run the RenameBasedOnDefinition action.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
BaseResult	Gets or sets the BaseResult.
BoundaryCondition	Gets or sets the BoundaryCondition.
Children	Gets the list of children.
ClsId	ClsId property.
Comments	Gets the list of associated comments.
CoordinateSystem	Gets or sets the Coordinate System.
DataModelObjectCategory	Gets the current DataModelObject's category.
DirectionX	Gets or sets the DirectionX.
DirectionY	Gets or sets the DirectionY.
DirectionZ	Gets or sets the DirectionZ.
DiscretizationError	Gets or sets the DiscretizationError.
Figures	Gets the list of associated figures.
FrequencyRangeType	Gets or sets the FrequencyRangeType.
FrequencyReduction	Gets or sets the FrequencyReduction.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
ImportableObjectSourceId	ImportableObjectSourceId property.
InternalObject	Gets the internal object. For advanced usage only.
Location	Gets or sets the Location.
LocationMethod	Gets or sets the LocationMethod.
MaximumFrequency	Gets or sets the MaximumFrequency.
MinimumFrequency	Gets or sets the MinimumFrequency.
ModeNumber	Gets or sets the ModeNumber.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
Properties	Gets the list of properties for this object.
ReadOnly	Gets or sets the ReadOnly.
ReferenceType	Gets or sets the ReferenceType.
RemotePoint	Gets or sets the RemotePoint.
RobustFrequenciesReduction	Gets or sets the RobustFrequenciesReduction.
SpatialReduction	Gets or sets the SpatialReduction.
SpatialReductionMethod	Gets or sets the SpatialReductionMethod.
State	State property.
Step	Gets or sets the Step.
Suppressed	Gets or sets the Suppressed.
TransferableObjectId	TransferableObjectId property.
Value	Gets the Value.
VectorReduction	Gets or sets the VectorReduction.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property PrimaryCriterion.AttachedRefs: List[int] | None

AttachedRefs property.

property PrimaryCriterion.BaseResult: Ansys.Mechanical.DataModel.Enums.BaseResultType | None

Gets or sets the BaseResult.

property PrimaryCriterion.BoundaryCondition: Ansys.ACT.Automation.Mechanical.DataModelObject | None

Gets or sets the BoundaryCondition.

property PrimaryCriterion.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property PrimaryCriterion.ClsId: int | None

ClsId property.

property PrimaryCriterion.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property PrimaryCriterion.CoordinateSystem: Ansys.Mechanical.DataModel.Interfaces.ICoordinateSystemSelection | None

Gets or sets the Coordinate System.

property PrimaryCriterion.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject's category.

property PrimaryCriterion.DirectionX: float | None

Gets or sets the DirectionX.

property PrimaryCriterion.DirectionY: float | None

Gets or sets the DirectionY.

property PrimaryCriterion.DirectionZ: float | None

Gets or sets the DirectionZ.

property PrimaryCriterion.DiscretizationError: float | None

Gets or sets the DiscretizationError.

property PrimaryCriterion.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

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.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property PrimaryCriterion.IconName: str | None

IconName property.

property PrimaryCriterion.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property PrimaryCriterion.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

property PrimaryCriterion.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSTopoCriterionAuto | None

Gets the internal object. For advanced usage only.

property PrimaryCriterion.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

property PrimaryCriterion.LocationMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the LocationMethod.

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.ModeNumber: int | None

Gets or sets the ModeNumber.

property PrimaryCriterion.Name: str | None

Name property.

property PrimaryCriterion.ObjectId: int | None

ObjectId property.

property PrimaryCriterion.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None

ObjectState property.

property PrimaryCriterion.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property PrimaryCriterion.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

property PrimaryCriterion.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property PrimaryCriterion.ReadOnly: bool | None

Gets or sets the ReadOnly.

property PrimaryCriterion.ReferenceType: Ansys.Mechanical.DataModel.Enums.VectorReductionReferenceType | None

Gets or sets the ReferenceType.

property PrimaryCriterion.RemotePoint: Ansys.ACT.Automation.Mechanical.RemotePoint | None

Gets or sets the RemotePoint.

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.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

property PrimaryCriterion.Step: int | None

Gets or sets the Step.

property PrimaryCriterion.Suppressed: bool | None

Gets or sets the Suppressed.

property PrimaryCriterion.TransferableObjectId: str | None

TransferableObjectId property.

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

Gets the Value.

property PrimaryCriterion.VectorReduction: Ansys.Mechanical.DataModel.Enums.VectorReductionType | None

Gets or sets the VectorReduction.

property PrimaryCriterion.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties that are visible for this object.

Method detail

PrimaryCriterion.Activate() → None

Activate the current object.

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: str) → 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.ClearGeneratedData() → None

Run the ClearGeneratedData action.

PrimaryCriterion.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

PrimaryCriterion.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

PrimaryCriterion.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

PrimaryCriterion.Delete() → None

Run the Delete action.

PrimaryCriterion.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

PrimaryCriterion.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

PrimaryCriterion.EvaluateAllResults() → None

Run the EvaluateAllResults action.

PrimaryCriterion.GetAPIName(dispId: int) → str

Property name bound to dispId.

PrimaryCriterion.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

PrimaryCriterion.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]

Gets the list of children, filtered by type.

PrimaryCriterion.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

PrimaryCriterion.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

PrimaryCriterion.GetHashCode() → int

GetHashCode method.

PrimaryCriterion.GetIconFile() → System.Byte

GetIconFile method.

PrimaryCriterion.GetLifetimeService() → Any

GetLifetimeService method.

PrimaryCriterion.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

PrimaryCriterion.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

PrimaryCriterion.GetPath() → str

GetPath method.

PrimaryCriterion.GetPropertyName(dispId: int) → str

GetPropertyName method.

PrimaryCriterion.GetPropertyValue(name: str) → Any

GetPropertyValue method.

PrimaryCriterion.GetQuantityName() → str

GetQuantityName method.

PrimaryCriterion.GetType() → type

GetType method.

PrimaryCriterion.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

PrimaryCriterion.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

PrimaryCriterion.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

PrimaryCriterion.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

PrimaryCriterion.InitializeLifetimeService() → Any

InitializeLifetimeService method.

PrimaryCriterion.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

PrimaryCriterion.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

PrimaryCriterion.PropertyByAPIName(name: str) → 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.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

PrimaryCriterion.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

PrimaryCriterion.RemoveParameter(propName: str) → None

Removes the parameter from the parameter set corresponding to the given property.

PrimaryCriterion.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

PrimaryCriterion.ToString() → str

ToString method.