Skip to main content

Mechanical scripting interface

ObjectiveWorksheet

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.ObjectiveWorksheet

Bases: object

ObjectiveWorksheet class.

Overview

Methods

Name Description
AddRow Adds a Row to the worksheet.
DeleteRow Deletes a row from the worksheet at index.
GetCriterion Gets the worksheet Environment property at index.
GetEnabled Gets the worksheet Enabled property at row index
GetEndMode Gets the worksheet End Mode property at index.
GetEndStep Gets the worksheet End Step property at index.
GetEnvironment Gets the worksheet Environment property at index.
GetFormulation Gets the worksheet Formulation property at index.
GetMode Gets the worksheet Mode property at index.
GetMultipleSets Gets the worksheet Multiple Sets property at row index
GetObjectiveType Gets the Objective Type property at index.
GetStartMode Gets the worksheet Start Mode property at index.
GetStartStep Gets the worksheet Start Step property at index.
GetStep Gets the worksheet Step property at index.
GetWeight Gets the worksheet Weight property at index.
SetCriterion Sets the worksheet Environment property at index.
SetEnabled Sets the worksheet Enabled property at row index.
SetEndMode Sets the worksheet End Mode property at index.
SetEndStep Sets the worksheet End Step property at index.
SetEnvironment Sets the worksheet Environment property at index.
SetFormulation Sets the worksheet Formulation property at index.
SetMode Sets the worksheet Mode property at index.
SetMultipleSets Sets the worksheet Multiple Sets property at row index.
SetObjectiveType Sets the ObjectiveType property at index.
SetStartMode Sets the worksheet Start Mode property at index.
SetStartStep Sets the worksheet Start Step property at index.
SetStep Sets the worksheet Step property at index.
SetWeight Sets the worksheet Weight property at index.

Properties

Name Description
RowCount Deletes a row from the worksheet at index.

Property detail

property ObjectiveWorksheet.RowCount : int | None

Deletes a row from the worksheet at index.

Method detail

ObjectiveWorksheet.AddRow()

Adds a Row to the worksheet.

ObjectiveWorksheet.DeleteRow(index: int)

Deletes a row from the worksheet at index.

ObjectiveWorksheet.GetCriterion(index: int)

Gets the worksheet Environment property at index.

ObjectiveWorksheet.GetEnabled(index: int)

Gets the worksheet Enabled property at row index

ObjectiveWorksheet.GetEndMode(index: int)

Gets the worksheet End Mode property at index.

ObjectiveWorksheet.GetEndStep(index: int)

Gets the worksheet End Step property at index.

ObjectiveWorksheet.GetEnvironment(index: int)

Gets the worksheet Environment property at index.

ObjectiveWorksheet.GetFormulation(index: int)

Gets the worksheet Formulation property at index.

ObjectiveWorksheet.GetMode(index: int)

Gets the worksheet Mode property at index.

ObjectiveWorksheet.GetMultipleSets(index: int)

Gets the worksheet Multiple Sets property at row index

ObjectiveWorksheet.GetObjectiveType(index: int)

Gets the Objective Type property at index.

ObjectiveWorksheet.GetStartMode(index: int)

Gets the worksheet Start Mode property at index.

ObjectiveWorksheet.GetStartStep(index: int)

Gets the worksheet Start Step property at index.

ObjectiveWorksheet.GetStep(index: int)

Gets the worksheet Step property at index.

ObjectiveWorksheet.GetWeight(index: int)

Gets the worksheet Weight property at index.

ObjectiveWorksheet.SetCriterion(index: int, newVal: Ansys.ACT.Automation.Mechanical.Criterion)

Sets the worksheet Environment property at index.

ObjectiveWorksheet.SetEnabled(index: int, value: bool)

Sets the worksheet Enabled property at row index.

ObjectiveWorksheet.SetEndMode(index: int, newVal: int)

Sets the worksheet End Mode property at index.

ObjectiveWorksheet.SetEndStep(index: int, newVal: int)

Sets the worksheet End Step property at index.

ObjectiveWorksheet.SetEnvironment(index: int, newVal: Ansys.ACT.Automation.Mechanical.Analysis)

Sets the worksheet Environment property at index.

ObjectiveWorksheet.SetFormulation(index: int, value: Ansys.Mechanical.DataModel.Enums.TopoObjectiveFormulation)

Sets the worksheet Formulation property at index.

ObjectiveWorksheet.SetMode(index: int, newVal: int)

Sets the worksheet Mode property at index.

ObjectiveWorksheet.SetMultipleSets(index: int, value: bool)

Sets the worksheet Multiple Sets property at row index.

ObjectiveWorksheet.SetObjectiveType(index: int, value: Ansys.Mechanical.DataModel.Enums.ObjectiveType)

Sets the ObjectiveType property at index.

ObjectiveWorksheet.SetStartMode(index: int, newVal: int)

Sets the worksheet Start Mode property at index.

ObjectiveWorksheet.SetStartStep(index: int, newVal: int)

Sets the worksheet Start Step property at index.

ObjectiveWorksheet.SetStep(index: int, newVal: int)

Sets the worksheet Step property at index.

ObjectiveWorksheet.SetWeight(index: int, newVal: float)

Sets the worksheet Weight property at index.