ConnectionGroup

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Connections.ConnectionGroup(internalObject: Any)

Bases: object

Defines a ConnectionGroup.

Overview

Methods

Activate	Activate the current object.
AddComment	Creates a new child Comment.
AddContactRegion	Creates a new child ContactRegion.
AddContactRegionInternal	Creates a new child ContactRegion that is not visible.
AddFigure	Creates a new child Figure.
AddImage	Creates a new child Image.
AddInterStage	Creates a new child InterStage.
AddJoint	Creates a new child Joint.
AddJointInternal
AddSpotWeld	Creates a new child SpotWeld.
CopyTo	Copies all visible properties from this object to another.
CreateAutomaticConnections	Run the CreateAutomaticConnections action.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
DeleteChildren	Run the DeleteChildren action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
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.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
PropertyByName	Get a property by its unique name.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
RenameBasedOnChildren	Rename the Connection group based on the children.
RepairOverlappingContactRegions	Check for Overlapping Contact Regions. However, please note that this action does not result in any actual repair being performed.
SearchConnectionsForDuplicatePairs	Run the SearchConnectionsForDuplicatePairs action.
SetDefaultAPDLNames	Loop over all the valid contact regions and set the default APDL names.
ToString	ToString method.

Properties

ActiveConnections	Gets the ActiveConnections.
AutomaticFixedJoints	Gets or sets the AutomaticFixedJoints.
Children	Gets the list of children.
Comments	Gets the list of associated comments.
ConnectionType	Gets or sets the ConnectionType.
Connections	Gets the Connections.
CylindricalFaces	Gets or sets the CylindricalFaces.
DataModelObjectCategory	Gets the current DataModelObject's category.
EdgeEdge	Gets or sets the EdgeEdge.
EdgeOverlapTolerance	Gets or sets the EdgeOverlapTolerance.
FaceAngleTolerance	Gets or sets the FaceAngleTolerance.
FaceEdge	Gets or sets the FaceEdge.
FaceFace	Gets or sets the FaceFace.
FaceFaceDetectionAngleTolerence	Gets or sets the FaceFaceDetectionAngleTolerence.
FaceOverlapTolerance	Gets or sets the FaceOverlapTolerance.
Figures	Gets the list of associated figures.
GroupBy	Gets or sets the GroupBy.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
ImportableObjectSourceId	ImportableObjectSourceId property.
InternalObject	Gets the internal object. For advanced usage only.
Location	Gets or sets the Location.
MinimumDistancePercentage	Gets or sets the MinimumDistancePercentage.
MinimumDistanceValue	Gets the MinimumDistanceValue.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
Priority	Gets or sets the Priority.
Properties	Gets the list of properties for this object.
ReadOnly	Gets or sets the ReadOnly.
RevoluteJoints	Gets or sets the RevoluteJoints.
SearchAcross	Gets or sets the SearchAcross.
State	State property.
Suppressed	Gets or sets the Suppressed.
ThicknessScaleFactor	Gets or sets the ThicknessScaleFactor.
ToleranceSlider	Gets or sets the ToleranceSlider.
ToleranceType	Gets or sets the ToleranceType.
ToleranceValue	Gets or sets the ToleranceValue.
TransferableObjectId	TransferableObjectId property.
UseRange	Gets or sets the UseRange.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property ConnectionGroup.ActiveConnections: int | None

Gets the ActiveConnections.

property ConnectionGroup.AutomaticFixedJoints: bool | None

Gets or sets the AutomaticFixedJoints.

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

Gets the list of children.

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

Gets the list of associated comments.

property ConnectionGroup.ConnectionType: Ansys.Mechanical.DataModel.Enums.AutoDetectionType | None

Gets or sets the ConnectionType.

property ConnectionGroup.Connections: int | None

Gets the Connections.

property ConnectionGroup.CylindricalFaces: Ansys.Mechanical.DataModel.Enums.CylindricalFacesOption | None

Gets or sets the CylindricalFaces.

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

Gets the current DataModelObject's category.

property ConnectionGroup.EdgeEdge: Ansys.Mechanical.DataModel.Enums.ContactEdgeEdgeOption | None

Gets or sets the EdgeEdge.

property ConnectionGroup.EdgeOverlapTolerance: int | None

Gets or sets the EdgeOverlapTolerance.

property ConnectionGroup.FaceAngleTolerance: Ansys.Core.Units.Quantity | None

Gets or sets the FaceAngleTolerance.

property ConnectionGroup.FaceEdge: Ansys.Mechanical.DataModel.Enums.ContactFaceEdgeOption | None

Gets or sets the FaceEdge.

property ConnectionGroup.FaceFace: bool | None

Gets or sets the FaceFace.

property ConnectionGroup.FaceFaceDetectionAngleTolerence: Ansys.Core.Units.Quantity | None

Gets or sets the FaceFaceDetectionAngleTolerence.

property ConnectionGroup.FaceOverlapTolerance: int | None

Gets or sets the FaceOverlapTolerance.

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

Gets the list of associated figures.

property ConnectionGroup.GroupBy: Ansys.Mechanical.DataModel.Enums.ContactGroupingType | None

Gets or sets the GroupBy.

property ConnectionGroup.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property ConnectionGroup.IconName: str | None

IconName property.

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

Gets the list of associated images.

property ConnectionGroup.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

property ConnectionGroup.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSConnectionGroupAuto | None

Gets the internal object. For advanced usage only.

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

Gets or sets the Location.

property ConnectionGroup.MinimumDistancePercentage: int | None

Gets or sets the MinimumDistancePercentage.

property ConnectionGroup.MinimumDistanceValue: Ansys.Core.Units.Quantity | None

Gets the MinimumDistanceValue.

property ConnectionGroup.Name: str | None

Name property.

property ConnectionGroup.ObjectId: int | None

ObjectId property.

property ConnectionGroup.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None

ObjectState property.

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

ObjectTags property.

property ConnectionGroup.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

property ConnectionGroup.Priority: Ansys.Mechanical.DataModel.Enums.ContactFaceEdgePriority | None

Gets or sets the Priority.

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

Gets the list of properties for this object.

property ConnectionGroup.ReadOnly: bool | None

Gets or sets the ReadOnly.

property ConnectionGroup.RevoluteJoints: bool | None

Gets or sets the RevoluteJoints.

property ConnectionGroup.SearchAcross: Ansys.Mechanical.DataModel.Enums.ContactSearchingType | None

Gets or sets the SearchAcross.

property ConnectionGroup.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

property ConnectionGroup.Suppressed: bool | None

Gets or sets the Suppressed.

property ConnectionGroup.ThicknessScaleFactor: float | None

Gets or sets the ThicknessScaleFactor.

property ConnectionGroup.ToleranceSlider: int | None

Gets or sets the ToleranceSlider.

property ConnectionGroup.ToleranceType: Ansys.Mechanical.DataModel.Enums.ContactToleranceType | None

Gets or sets the ToleranceType.

property ConnectionGroup.ToleranceValue: Ansys.Core.Units.Quantity | None

Gets or sets the ToleranceValue.

property ConnectionGroup.TransferableObjectId: str | None

TransferableObjectId property.

property ConnectionGroup.UseRange: bool | None

Gets or sets the UseRange.

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

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

Method detail

ConnectionGroup.Activate() → None

Activate the current object.

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

Creates a new child Comment.

ConnectionGroup.AddContactRegion() → Ansys.ACT.Automation.Mechanical.Connections.ContactRegion

Creates a new child ContactRegion.

ConnectionGroup.AddContactRegionInternal() → Ansys.ACT.Automation.Mechanical.Connections.ContactRegion

Creates a new child ContactRegion that is not visible.

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

Creates a new child Figure.

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

ConnectionGroup.AddInterStage() → Ansys.ACT.Automation.Mechanical.Connections.ContactRegion

Creates a new child InterStage.

ConnectionGroup.AddJoint() → Ansys.ACT.Automation.Mechanical.Connections.Joint

Creates a new child Joint.

ConnectionGroup.AddJointInternal() → Ansys.ACT.Automation.Mechanical.Connections.Joint

ConnectionGroup.AddSpotWeld() → Ansys.ACT.Automation.Mechanical.Connections.ContactRegion

Creates a new child SpotWeld.

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

Copies all visible properties from this object to another.

ConnectionGroup.CreateAutomaticConnections() → None

Run the CreateAutomaticConnections action.

ConnectionGroup.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

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

Creates a new parameter for a Property.

ConnectionGroup.Delete() → None

Run the Delete action.

ConnectionGroup.DeleteChildren() → None

Run the DeleteChildren action.

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

Creates a copy of the current DataModelObject.

ConnectionGroup.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

ConnectionGroup.GetAPIName(dispId: int) → str

Property name bound to dispId.

ConnectionGroup.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

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

Gets the list of children, filtered by type.

ConnectionGroup.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

ConnectionGroup.GetHashCode() → int

GetHashCode method.

ConnectionGroup.GetIconFile() → System.Byte

GetIconFile method.

ConnectionGroup.GetLifetimeService() → Any

GetLifetimeService method.

ConnectionGroup.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

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

Gets the parameter corresponding to the given property.

ConnectionGroup.GetPath() → str

GetPath method.

ConnectionGroup.GetPropertyName(dispId: int) → str

GetPropertyName method.

ConnectionGroup.GetPropertyValue(name: str) → Any

GetPropertyValue method.

ConnectionGroup.GetType() → type

GetType method.

ConnectionGroup.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

ConnectionGroup.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

ConnectionGroup.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

ConnectionGroup.InitializeLifetimeService() → Any

InitializeLifetimeService method.

ConnectionGroup.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

ConnectionGroup.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

ConnectionGroup.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

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

Get a property by its unique name.

ConnectionGroup.RemoveParameter(propName: str) → None

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

ConnectionGroup.RenameBasedOnChildren() → bool

Rename the Connection group based on the children.

ConnectionGroup.RepairOverlappingContactRegions() → None

Check for Overlapping Contact Regions. However, please note that this action does not result in any actual repair being performed.

ConnectionGroup.SearchConnectionsForDuplicatePairs() → None

Run the SearchConnectionsForDuplicatePairs action.

ConnectionGroup.SetDefaultAPDLNames() → None

Loop over all the valid contact regions and set the default APDL names.

ConnectionGroup.ToString() → str

ToString method.