Skip to main content

Mechanical scripting interface

CoSimulationPin

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.CoSimulationPin

Bases: object

Defines a CoSimulationPin.

Overview

Methods

Name Description
Activate Activate the current object.
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.
DOF Gets or sets the DOF.
DataModelObjectCategory Gets the current DataModelObject’s category.
InternalObject Gets the internal object. For advanced usage only.
JointType Gets or sets the Joint Type.
PinBehavior Gets or sets the Pin Behavior.
PinNature Gets or sets the Pin Nature.
Properties Gets the list of properties for this object.
Scope Gets or sets the Joint through Scope.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets or sets the DOF.

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

Gets the current DataModelObject’s category.

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

Gets the internal object. For advanced usage only.

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.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

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

Gets or sets the Joint through Scope.

property CoSimulationPin.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

Method detail

CoSimulationPin.Activate()

Activate the current object.

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

Copies all visible properties from this object to another.

CoSimulationPin.CreateParameter(propName: str)

Creates a new parameter for a Property.

CoSimulationPin.Delete()

Run the Delete action.

CoSimulationPin.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

CoSimulationPin.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

CoSimulationPin.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

CoSimulationPin.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

CoSimulationPin.PropertyByName(name: str)

Get a property by its unique name.

CoSimulationPin.RemoveParameter(propName: str)

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