CommandSnippet
#
- class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.CommandSnippet#
Bases:
object
Defines a CommandSnippet.
Overview#
Activate the current object. |
|
Creates a new child Comment. |
|
Creates a new child Figure. |
|
Creates a new child Image. |
|
Append Text. |
|
Copies all visible properties from this object to another. |
|
Creates a new parameter for a Property. |
|
Run the Delete action. |
|
Creates a copy of the current DataModelObject. |
|
Export to Textfile. |
|
Gets the list of children, filtered by type. |
|
Gets the parameter corresponding to the given property. |
|
Run the GroupAllSimilarChildren action. |
|
Run the GroupSimilarObjects action. |
|
Import from Textfile. |
|
Get a property by its API name. |
|
Get a property by its unique name. |
|
Removes the parameter from the parameter set corresponding to the given property. |
|
Run the RenameBasedOnDefinition action. |
Gets the list of children. |
|
Gets the list of associated comments. |
|
Gets the current DataModelObject's category. |
|
Gets the list of associated figures. |
|
Gets the FileName. |
|
Gets the list of associated images. |
|
Gets or sets the Text. |
|
Gets or sets the InputArgument1. |
|
Gets or sets the InputArgument2. |
|
Gets or sets the InputArgument3. |
|
Gets or sets the InputArgument4. |
|
Gets or sets the InputArgument5. |
|
Gets or sets the InputArgument6. |
|
Gets or sets the InputArgument7. |
|
Gets or sets the InputArgument8. |
|
Gets or sets the InputArgument9. |
|
Gets the internal object. For advanced usage only. |
|
Gets or sets the InvalidateSolution. |
|
Gets or sets the IssueSolveCommand. |
|
Gets a list of the command snippet's output parameters. |
|
Gets or sets the OutputSearchPrefix. |
|
Gets the list of properties for this object. |
|
Gets or sets the ReadOnly. |
|
Gets the SnippetFileStatus. |
|
Gets the SolverTarget. |
|
Gets or sets the StepNumber. |
|
Gets or sets the StepSelectionMode. |
|
Gets or sets the Suppressed. |
|
Gets the list of properties that are visible for this object. |
Property detail#
- property CommandSnippet.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#
Gets the list of children.
- property CommandSnippet.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None#
Gets the list of associated comments.
- property CommandSnippet.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#
Gets the current DataModelObject's category.
- property CommandSnippet.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#
Gets the list of associated figures.
- property CommandSnippet.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#
Gets the list of associated images.
- property CommandSnippet.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSCommandEditorAuto | None#
Gets the internal object. For advanced usage only.
- property CommandSnippet.OutputParameters: tuple[Ansys.ACT.Automation.Mechanical.CommandOutputParameter] | None#
Gets a list of the command snippet's output parameters.
- property CommandSnippet.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#
Gets the list of properties for this object.
- property CommandSnippet.SolverTarget: Ansys.Mechanical.DataModel.Enums.CommandEditorTarget | None#
Gets the SolverTarget.
- property CommandSnippet.StepSelectionMode: Ansys.Mechanical.DataModel.Enums.SequenceSelectionType | None#
Gets or sets the StepSelectionMode.
Method detail#
- CommandSnippet.AddComment() Ansys.ACT.Automation.Mechanical.Comment #
Creates a new child Comment.
- CommandSnippet.AddFigure() Ansys.ACT.Automation.Mechanical.Figure #
Creates a new child Figure.
- CommandSnippet.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.
- CommandSnippet.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None #
Copies all visible properties from this object to another.
- CommandSnippet.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter #
Creates a new parameter for a Property.
- CommandSnippet.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject #
Creates a copy of the current DataModelObject.
- CommandSnippet.GetChildren(recurses: bool, children: List[ChildrenType]) List[ChildrenType] #
Gets the list of children, filtered by type.
- CommandSnippet.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter #
Gets the parameter corresponding to the given property.
- CommandSnippet.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder #
Run the GroupSimilarObjects action.
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.
- CommandSnippet.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property #
Get a property by its unique name.