Temperature#

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.BoundaryConditions.Temperature(internalObject: Any)#

Bases: object

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.

CreateObjRef

CreateObjRef method.

CreateParameter

CreateParameter method.

Delete

Run the Delete action.

Duplicate

Creates a copy of the current DataModelObject.

Equals

Equals method.

GetAPIName

Property name bound to dispId.

GetActivateAtLoadStep

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

GetAllProperties

GetAllProperties method.

GetChildren

Gets the list of children, filtered by type.

GetDetailsView

GetDetailsView method.

GetEnumName

Enum name bound to value

GetHashCode

GetHashCode method.

GetIconFile

GetIconFile method.

GetLifetimeService

GetLifetimeService method.

GetObjectData

GetObjectData method.

GetParameter

Gets the parameter corresponding to the given property.

GetPath

GetPath method.

GetPropertyName

GetPropertyName method.

GetPropertyValue

GetPropertyValue method.

GetType

GetType method.

GetVisibleProperties

GetVisibleProperties method.

GetVisiblePropertyNames

GetVisiblePropertyNames method.

GroupAllSimilarChildren

Run the GroupAllSimilarChildren action.

GroupSimilarObjects

Run the GroupSimilarObjects action.

InitializeLifetimeService

InitializeLifetimeService method.

IsPropertyEditable

IsPropertyEditable method.

IsPropertyVisible

IsPropertyVisible method.

PromoteToNamedSelection

Run the PromoteToNamedSelection action.

PropertyByAPIName

Get a property by its API name.

PropertyById

PropertyById method.

PropertyByName

Get a property by its unique name.

RemoveParameter

RemoveParameter method.

SetActivateAtLoadStep

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

ToString

ToString method.

ApplyToEntireBody

Gets or sets the ApplyToEntireBody.

AttachedRefs

AttachedRefs property.

Children

Gets the list of children.

ClsId

ClsId property.

Comments

Gets the list of associated comments.

DataModelObjectCategory

Gets the current DataModelObject's category.

DefineBy

Gets the DefineBy.

Figures

Gets the list of associated figures.

GraphControlsXAxis

Gets or sets the GraphControlsXAxis.

GroupingFolder

GroupingFolder property.

IconName

IconName property.

Images

Gets the list of associated images.

ImportableObjectSourceId

ImportableObjectSourceId property.

IndependentVariable

Gets or sets the IndependentVariable.

InternalObject

Gets the internal object. For advanced usage only.

Location

Gets or sets the Location.

Magnitude

Gets or sets the Magnitude.

Name

Name property.

NumberOfSegments

Gets or sets the NumberOfSegments.

ObjectId

ObjectId property.

ObjectState

ObjectState property.

ObjectTags

ObjectTags property.

Parent

Parent property.

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.

ShellFace

Gets or sets the ShellFace.

State

State property.

Suppressed

Gets or sets the Suppressed.

TableAssignment

Gets or sets the TableAssignment.

TransferableObjectId

TransferableObjectId property.

VisibleProperties

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

XYZFunctionCoordinateSystem

Gets or sets the XYZFunctionCoordinateSystem.

Property detail#

property Temperature.ApplyToEntireBody: bool | None#

Gets or sets the ApplyToEntireBody.

property Temperature.AttachedRefs: List[int] | None#

AttachedRefs property.

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

Gets the list of children.

property Temperature.ClsId: int | None#

ClsId property.

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

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

property Temperature.DefineBy: Ansys.Mechanical.DataModel.Enums.LoadDefineBy | None#

Gets the DefineBy.

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

Gets the list of associated figures.

property Temperature.GraphControlsXAxis: Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None#

Gets or sets the GraphControlsXAxis.

property Temperature.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#

GroupingFolder property.

property Temperature.IconName: str | None#

IconName property.

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

Gets the list of associated images.

property Temperature.ImportableObjectSourceId: str | None#

ImportableObjectSourceId property.

property Temperature.IndependentVariable: Ansys.Mechanical.DataModel.Enums.LoadVariableVariationType | None#

Gets or sets the IndependentVariable.

property Temperature.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None#

Gets the internal object. For advanced usage only.

property Temperature.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the Location.

property Temperature.Magnitude: Any | None#

Gets or sets the Magnitude.

property Temperature.Name: str | None#

Name property.

property Temperature.NumberOfSegments: int | None#

Gets or sets the NumberOfSegments.

property Temperature.ObjectId: int | None#

ObjectId property.

property Temperature.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None#

ObjectState property.

property Temperature.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None#

ObjectTags property.

property Temperature.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#

Parent property.

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

Gets the list of properties for this object.

property Temperature.RangeMaximum: Ansys.Core.Units.Quantity | None#

Gets or sets the RangeMaximum.

property Temperature.RangeMinimum: Ansys.Core.Units.Quantity | None#

Gets or sets the RangeMinimum.

property Temperature.ReadOnly: bool | None#

Gets or sets the ReadOnly.

property Temperature.SharedRefBody: Ansys.ACT.Automation.Mechanical.Body | None#

Gets or sets the SharedRefBody.

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

Gets or sets the ShellFace.

property Temperature.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None#

State property.

property Temperature.Suppressed: bool | None#

Gets or sets the Suppressed.

property Temperature.TableAssignment: Ansys.ACT.Automation.Mechanical.Table | None#

Gets or sets the TableAssignment.

property Temperature.TransferableObjectId: str | None#

TransferableObjectId property.

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

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

property Temperature.XYZFunctionCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

Gets or sets the XYZFunctionCoordinateSystem.

Method detail#

Temperature.Activate() None#

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

Copies all visible properties from this object to another.

Temperature.CreateObjRef(requestedType: type) System.Runtime.Remoting.ObjRef#

CreateObjRef method.

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

CreateParameter method.

Temperature.Delete() None#

Run the Delete action.

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

Creates a copy of the current DataModelObject.

Temperature.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) bool#

Equals method.

Temperature.GetAPIName(dispId: int) str#

Property name bound to dispId.

Temperature.GetActivateAtLoadStep(stepNumber: int) bool#

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

Temperature.GetAllProperties() List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]#

GetAllProperties method.

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

Gets the list of children, filtered by type.

Temperature.GetDetailsView() Ansys.ACT.Automation.Mechanical.DetailsViewData#

GetDetailsView method.

Temperature.GetEnumName(enumType: type, value: int, dispId: int) str#

Enum name bound to value

Temperature.GetHashCode() int#

GetHashCode method.

Temperature.GetIconFile() System.Byte#

GetIconFile method.

Temperature.GetLifetimeService() Any#

GetLifetimeService method.

Temperature.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) None#

GetObjectData method.

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

Gets the parameter corresponding to the given property.

Temperature.GetPath() str#

GetPath method.

Temperature.GetPropertyName(dispId: int) str#

GetPropertyName method.

Temperature.GetPropertyValue(name: str) Any#

GetPropertyValue method.

Temperature.GetType() type#

GetType method.

Temperature.GetVisibleProperties() List[System.Reflection.PropertyInfo]#

GetVisibleProperties method.

Temperature.GetVisiblePropertyNames() List[str]#

GetVisiblePropertyNames method.

Temperature.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

Temperature.InitializeLifetimeService() Any#

InitializeLifetimeService method.

Temperature.IsPropertyEditable(dispId: int) bool#

IsPropertyEditable method.

Temperature.IsPropertyVisible(dispId: int) bool#

IsPropertyVisible method.

Temperature.PromoteToNamedSelection() Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]#

Run the PromoteToNamedSelection action.

Temperature.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.
Temperature.PropertyById(dispId: int) Ansys.ACT.Automation.Mechanical.Property#

PropertyById method.

Temperature.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

Temperature.RemoveParameter(propName: str) None#

RemoveParameter method.

Temperature.SetActivateAtLoadStep(stepNumber: int, bActive: bool) None#

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

Temperature.ToString() str#

ToString method.