CrossSections

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.CrossSections(internalObject: Any)

Bases: object

Defines a CrossSections.

Overview

Methods

Activate	Activate the current object.
AddChannelCrossSection	Creates a new ChannelCrossSection
AddCircularCrossSection	Creates a new CircularCrossSection
AddCircularTubeCrossSection	Creates a new CircularTubeCrossSection
AddComment	Creates a new child Comment.
AddFigure	Creates a new child Figure.
AddHatCrossSection	Creates a new HatCrossSection
AddHollowRectangularCrossSection	Creates a new HollowRectangularCrossSection
AddICrossSection	Creates a new ICrossSection
AddImage	Creates a new child Image.
AddLCrossSection	Creates a new LCrossSection
AddRectangularCrossSection	Creates a new RectangularCrossSection
AddTCrossSection	Creates a new TCrossSection
AddUserDefinedCrossSection	Creates a new UserDefinedCrossSection
AddZCrossSection	Creates a new ZCrossSection
CopyTo	Copies all visible properties from this object to another.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete 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.
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.
NameCrossSectionsUniquely	programmatically give each of the Cross Section objects a unique name .
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.
ToString	ToString method.

Properties

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.
Figures	Gets the list of associated figures.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
Properties	Gets the list of properties for this object.
State	State property.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property CrossSections.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property CrossSections.ClsId: int | None

ClsId property.

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

Gets the list of associated comments.

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

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

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

GroupingFolder property.

property CrossSections.IconName: str | None

IconName property.

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

Gets the list of associated images.

property CrossSections.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSCrossSectionGroupAuto | None

Gets the internal object. For advanced usage only.

property CrossSections.Name: str | None

Name property.

property CrossSections.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

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

Parent property.

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

Gets the list of properties for this object.

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

State property.

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

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

Method detail

CrossSections.Activate() → None

Activate the current object.

CrossSections.AddChannelCrossSection() → Ansys.ACT.Automation.Mechanical.ChannelCrossSection

Creates a new ChannelCrossSection

CrossSections.AddCircularCrossSection() → Ansys.ACT.Automation.Mechanical.CircularCrossSection

Creates a new CircularCrossSection

CrossSections.AddCircularTubeCrossSection() → Ansys.ACT.Automation.Mechanical.CircularTubeCrossSection

Creates a new CircularTubeCrossSection

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

Creates a new child Comment.

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

Creates a new child Figure.

CrossSections.AddHatCrossSection() → Ansys.ACT.Automation.Mechanical.HatCrossSection

Creates a new HatCrossSection

CrossSections.AddHollowRectangularCrossSection() → Ansys.ACT.Automation.Mechanical.HollowRectangularCrossSection

Creates a new HollowRectangularCrossSection

CrossSections.AddICrossSection() → Ansys.ACT.Automation.Mechanical.ICrossSection

Creates a new ICrossSection

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

CrossSections.AddLCrossSection() → Ansys.ACT.Automation.Mechanical.LCrossSection

Creates a new LCrossSection

CrossSections.AddRectangularCrossSection() → Ansys.ACT.Automation.Mechanical.RectangularCrossSection

Creates a new RectangularCrossSection

CrossSections.AddTCrossSection() → Ansys.ACT.Automation.Mechanical.TCrossSection

Creates a new TCrossSection

CrossSections.AddUserDefinedCrossSection() → Ansys.ACT.Automation.Mechanical.UserDefinedCrossSection

Creates a new UserDefinedCrossSection

CrossSections.AddZCrossSection() → Ansys.ACT.Automation.Mechanical.ZCrossSection

Creates a new ZCrossSection

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

Copies all visible properties from this object to another.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

CrossSections.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Equals method.

CrossSections.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

CrossSections.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

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

Enum name bound to value

CrossSections.GetHashCode() → int

GetHashCode method.

CrossSections.GetIconFile() → System.Byte

GetIconFile method.

CrossSections.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

CrossSections.GetPath() → str

GetPath method.

CrossSections.GetPropertyName(dispId: int) → str

GetPropertyName method.

CrossSections.GetPropertyValue(name: str) → Any

GetPropertyValue method.

CrossSections.GetType() → type

GetType method.

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

GetVisibleProperties method.

CrossSections.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

CrossSections.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

CrossSections.InitializeLifetimeService() → Any

InitializeLifetimeService method.

CrossSections.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

CrossSections.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

CrossSections.NameCrossSectionsUniquely() → None

programmatically give each of the Cross Section objects a unique name .

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

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

PropertyById method.

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

Get a property by its unique name.

CrossSections.RemoveParameter(propName: str) → None

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

CrossSections.ToString() → str

ToString method.