CoSimulationPin#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.CoSimulationPin#

Bases: object

Defines a CoSimulationPin.

Overview#

Delete

Run the Delete action.

GetChildren

Gets the list of children, filtered by type.

GetChildren

Gets the list of children, filtered by type.

Activate

Activate the current object.

CopyTo

Copies all visible properties from this object to another.

Duplicate

Creates a copy of the current DataModelObject.

GroupAllSimilarChildren

Run the GroupAllSimilarChildren action.

GroupSimilarObjects

Run the GroupSimilarObjects action.

PropertyByName

Get a property by its unique name.

PropertyByAPIName

Get a property by its API name.

CreateParameter

Creates a new parameter for a Property.

GetParameter

Gets the parameter corresponding to the given property.

RemoveParameter

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

Scope

Gets or sets the Joint through Scope.

DOF

Gets or sets the DOF.

JointType

Gets or sets the Joint Type.

PinBehavior

Gets or sets the Pin Behavior.

PinNature

Gets or sets the Pin Nature.

InternalObject

Gets the internal object. For advanced usage only.

Suppressed

Gets or sets the Suppressed.

DataModelObjectCategory

Gets the current DataModelObject’s category.

Children

Gets the list of children.

InternalObject

Gets the internal object. For advanced usage only.

Properties

Gets the list of properties for this object.

VisibleProperties

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

Property detail#

property CoSimulationPin.Scope: Ansys.ACT.Automation.Mechanical.Connections.Joint | None

Gets or sets the Joint through Scope.

property CoSimulationPin.DOF: Ansys.Mechanical.DataModel.Enums.KinematicDOF | None

Gets or sets the DOF.

property CoSimulationPin.JointType: Ansys.Mechanical.DataModel.Enums.JointType | None

Gets or sets the Joint Type.

property CoSimulationPin.PinBehavior: Ansys.Mechanical.DataModel.Enums.PinBehavior | None

Gets or sets the Pin Behavior.

property CoSimulationPin.PinNature: Ansys.Mechanical.DataModel.Enums.PinNature | None

Gets or sets the Pin Nature.

property CoSimulationPin.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSSimplorerPinAuto | None

Gets the internal object. For advanced usage only.

property CoSimulationPin.Suppressed: System.Boolean | None

Gets or sets the Suppressed.

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

Gets the current DataModelObject’s category.

property CoSimulationPin.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property CoSimulationPin.InternalObject: System.Object | None

Gets the internal object. For advanced usage only.

property CoSimulationPin.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property CoSimulationPin.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

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

Method detail#

CoSimulationPin.Delete() System.Void

Run the Delete action.

CoSimulationPin.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) System.Collections.Generic.IList[ChildrenType]

Gets the list of children, filtered by type.

CoSimulationPin.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]

Gets the list of children, filtered by type.

CoSimulationPin.Activate() System.Void

Activate the current object.

CoSimulationPin.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) System.Void

Copies all visible properties from this object to another.

CoSimulationPin.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

CoSimulationPin.GroupAllSimilarChildren() System.Void

Run the GroupAllSimilarChildren action.

CoSimulationPin.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

CoSimulationPin.PropertyByName(name: System.String) Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

CoSimulationPin.PropertyByAPIName(name: System.String) 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.
CoSimulationPin.CreateParameter(propName: System.String) Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

CoSimulationPin.GetParameter(propName: System.String) Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

CoSimulationPin.RemoveParameter(propName: System.String) System.Void

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