Objective
Last update: 14.01.2025
Objective
class Ansys.ACT.Automation.Mechanical.Objective
Bases: object
Defines a Objective.
Overview
Methods
Name | Description |
---|---|
Activate |
Activate the current object. |
AddComment |
Creates a new child Comment. |
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. |
Properties
Name | Description |
---|---|
Children |
Gets the list of children. |
Comments |
Gets the list of associated comments. |
DataModelObjectCategory |
Gets the current DataModelObject’s category. |
Images |
Gets the list of associated images. |
InternalObject |
Gets the internal object. For advanced usage only. |
NormalizedSum |
Gets or sets the NormalizedSum. |
Properties |
Gets the list of properties for this object. |
Suppressed |
Gets or sets the Suppressed. |
VisibleProperties |
Gets the list of properties that are visible for this object. |
Worksheet |
Get the ObjectiveWorksheet action. |
Property detail
property Objective.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
property Objective.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
property Objective.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
property Objective.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
property Objective.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSTopoObjectiveAuto | None
Gets the internal object. For advanced usage only.
property Objective.NormalizedSum : bool | None
Gets or sets the NormalizedSum.
property Objective.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
property Objective.Suppressed : bool | None
Gets or sets the Suppressed.
property Objective.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
property Objective.Worksheet : Ansys.ACT.Automation.Mechanical.ObjectiveWorksheet | None
Get the ObjectiveWorksheet action.
Method detail
Objective.Activate()
Activate the current object.
Objective.AddComment()
Creates a new child Comment.
Objective.AddImage(filePath: str)
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.
Objective.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)
Copies all visible properties from this object to another.
Objective.CreateParameter(propName: str)
Creates a new parameter for a Property.
Objective.Delete()
Run the Delete action.
Objective.Duplicate()
Creates a copy of the current DataModelObject.
Objective.GetChildren(recurses: bool, children: List[ChildrenType])
Gets the list of children, filtered by type.
Objective.GetParameter(propName: str)
Gets the parameter corresponding to the given property.
Objective.GroupAllSimilarChildren()
Run the GroupAllSimilarChildren action.
Objective.GroupSimilarObjects()
Run the GroupSimilarObjects action.
Objective.PropertyByAPIName(name: str)
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.
Objective.PropertyByName(name: str)
Get a property by its unique name.
Objective.RemoveParameter(propName: str)
Removes the parameter from the parameter set corresponding to the given property.