MappingValidation#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.MappingValidation#

Bases: object

Defines a MappingValidation.

Overview#

Activate

Activate the current object.

AddComment

Creates a new child Comment.

AddFigure

Creates a new child Figure.

AddImage

Creates a new child Image.

CopyTo

Copies all visible properties from this object to another.

CreateParameter

Creates a new parameter for a Property.

Delete

Run the Delete action.

Duplicate

Creates a copy of the current DataModelObject.

GetChildren

Gets the list of children, filtered by type.

GetParameter

Gets the parameter corresponding to the given property.

GroupAllSimilarChildren

Run the GroupAllSimilarChildren action.

GroupSimilarObjects

Run the GroupSimilarObjects action.

PropertyByAPIName

Get a property by its API name.

PropertyByName

Get a property by its unique name.

RemoveParameter

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

ActiveSequence

Gets or sets the ActiveSequence.

ActiveSequenceByValue

Gets or sets the ActiveSequenceByValue.

BoundingTolerance

Gets or sets the BoundingTolerance.

Children

Gets the list of children.

Comments

Gets the list of associated comments.

ComplexComponent

Gets or sets the ComplexComponent.

Component

Gets or sets the Component.

DataModelObjectCategory

Gets the current DataModelObject's category.

DefineActiveSequenceBy

Control whether the active sequenced is defined by row or by value.

Display

Display property.

DisplayDataType

Gets or sets the DisplayDataType.

Figures

Gets the list of associated figures.

FileIdentifierIndex

Gets or sets the FileIdentifierIndex.

Images

Gets the list of associated images.

InternalObject

Gets the internal object. For advanced usage only.

IsolineThickness

IsolineThickness property.

IsolineType

IsolineType property.

Layer

Gets or sets the Layer.

LegendDivisions

LegendDivisions property.

Properties

Gets the list of properties for this object.

Scale

Scale property.

ShellFace

Controls whether the displayed shell face lies on the bottom, middle, or top of the shell.

Type

Type property.

VisibleProperties

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

Property detail#

property MappingValidation.ActiveSequence: int | None#

Gets or sets the ActiveSequence.

property MappingValidation.ActiveSequenceByValue: float | None#

Gets or sets the ActiveSequenceByValue.

property MappingValidation.BoundingTolerance: float | None#

Gets or sets the BoundingTolerance.

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

Gets the list of children.

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

Gets the list of associated comments.

property MappingValidation.ComplexComponent: bool | None#

Gets or sets the ComplexComponent.

property MappingValidation.Component: Ansys.Mechanical.DataModel.Enums.ExternalLoadDisplayComponentType | None#

Gets or sets the Component.

property MappingValidation.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

property MappingValidation.DefineActiveSequenceBy: Ansys.Mechanical.DataModel.Enums.ExternalLoadDefineActiveSequenceBy | None#

Control whether the active sequenced is defined by row or by value.

property MappingValidation.Display: Ansys.Mechanical.DataModel.Enums.MappingValidationDisplayOption | None#

Display property.

property MappingValidation.DisplayDataType: Ansys.Mechanical.DataModel.Enums.ExternalLoadDisplayDataType | None#

Gets or sets the DisplayDataType.

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

Gets the list of associated figures.

property MappingValidation.FileIdentifierIndex: int | None#

Gets or sets the FileIdentifierIndex.

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

Gets the list of associated images.

property MappingValidation.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSMappingValidationAuto | None#

Gets the internal object. For advanced usage only.

property MappingValidation.IsolineThickness: Ansys.Mechanical.DataModel.Enums.MappingIsolineThicknessType | None#

IsolineThickness property.

property MappingValidation.IsolineType: Ansys.Mechanical.DataModel.Enums.MappingIsolineLineType | None#

IsolineType property.

property MappingValidation.Layer: int | None#

Gets or sets the Layer.

property MappingValidation.LegendDivisions: int | None#

LegendDivisions property.

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

Gets the list of properties for this object.

property MappingValidation.Scale: float | None#

Scale property.

property MappingValidation.ShellFace: Ansys.Mechanical.DataModel.Enums.ShellFaceType | None#

Controls whether the displayed shell face lies on the bottom, middle, or top of the shell.

property MappingValidation.Type: Ansys.Mechanical.DataModel.Enums.MappingValidationType | None#

Type property.

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

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

Method detail#

MappingValidation.Activate() None#

Activate the current object.

MappingValidation.AddComment() Ansys.ACT.Automation.Mechanical.Comment#

Creates a new child Comment.

MappingValidation.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#

Creates a new child Figure.

MappingValidation.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.
MappingValidation.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

MappingValidation.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Creates a new parameter for a Property.

MappingValidation.Delete() None#

Run the Delete action.

MappingValidation.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

MappingValidation.GetChildren(recurses: bool, children: List[ChildrenType]) List[ChildrenType]#

Gets the list of children, filtered by type.

MappingValidation.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

MappingValidation.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

MappingValidation.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

MappingValidation.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.
MappingValidation.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

MappingValidation.RemoveParameter(propName: str) None#

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