Mechanical scripting interface 2026 R1

`PipeTemperature`

Last update: 09.03.2026

class Ansys.ACT.Automation.Mechanical.BoundaryConditions.PipeTemperature

Bases: object

Defines a PipeTemperature.

Overview

Methods

Name Description
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.
GetActivateAtLoadStep Gets whether the pipe temperature is active at the specified load step.
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.
PromoteToNamedSelection Run the PromoteToNamedSelection 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.
SetActivateAtLoadStep Sets whether the pipe temperature is active at the specified load step.

Properties

Name Description
Children Gets the list of children.
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the current DataModelObject's category.
Figures Gets the list of associated figures.
GraphControlsXAxis Gets or sets the GraphControlsXAxis.
Images Gets the list of associated images.
IndependentVariable Gets or sets the IndependentVariable.
InternalObject Gets the internal object. For advanced usage only.
Loading Gets or sets the Loading.
Location Gets or sets the Location.
Magnitude Gets the Magnitude.
NumberOfSegments Gets or sets the NumberOfSegments.
Properties Gets the list of properties for this object.
RangeMaximum Gets or sets the RangeMaximum.
RangeMinimum Gets or sets the RangeMinimum.
ReadOnly Gets or sets the ReadOnly.
SharedRefBody Gets or sets the SharedRefBody.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.
XYZFunctionCoordinateSystem Gets or sets the XYZFunctionCoordinateSystem.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

property PipeTemperature.GraphControlsXAxis : Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None

Gets or sets the GraphControlsXAxis.

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

Gets the list of associated images.

property PipeTemperature.IndependentVariable : Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None

Gets or sets the IndependentVariable.

property PipeTemperature.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None

Gets the internal object. For advanced usage only.

property PipeTemperature.Loading : Ansys.Mechanical.DataModel.Enums.PipeLoadingType | None

Gets or sets the Loading.

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

Gets or sets the Location.

property PipeTemperature.Magnitude : Ansys.ACT.Mechanical.Fields.Field | None

Gets the Magnitude.

property PipeTemperature.NumberOfSegments : int | None

Gets or sets the NumberOfSegments.

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

Gets the list of properties for this object.

property PipeTemperature.RangeMaximum : Ansys.Core.Units.Quantity | None

Gets or sets the RangeMaximum.

property PipeTemperature.RangeMinimum : Ansys.Core.Units.Quantity | None

Gets or sets the RangeMinimum.

property PipeTemperature.ReadOnly : bool | None

Gets or sets the ReadOnly.

property PipeTemperature.SharedRefBody : Ansys.ACT.Automation.Mechanical.Body | None

Gets or sets the SharedRefBody.

property PipeTemperature.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

property PipeTemperature.XYZFunctionCoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the XYZFunctionCoordinateSystem.

Method detail

PipeTemperature.Activate() → None

Activate the current object.

PipeTemperature.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

PipeTemperature.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

PipeTemperature.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.

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

PipeTemperature.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

PipeTemperature.GetActivateAtLoadStep(stepNumber: int) → bool

Gets whether the pipe temperature is active at the specified load step.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

PipeTemperature.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

PipeTemperature.PromoteToNamedSelection() → Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]

Run the PromoteToNamedSelection action.

PipeTemperature.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.

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

Get a property by its unique name.

PipeTemperature.RemoveParameter(propName: str) → None

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

PipeTemperature.SetActivateAtLoadStep(stepNumber: int, bActive: bool) → None

Sets whether the pipe temperature is active at the specified load step.

Connect with Ansys