`GeneralAxisymmetric`#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.GeneralAxisymmetric#

Bases: object

Defines a GeneralAxisymmetric.

Overview#

Methods

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

`Axis`	Gets or sets the Axis.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`CoordinateSystem`	Gets or sets the CoordinateSystem.
`DataModelObjectCategory`	Gets the current DataModelObject's category.
`EndPlane`	Gets or sets the EndPlane.
`Figures`	Gets the list of associated figures.
`Images`	Gets the list of associated images.
`InternalObject`	Gets the internal object. For advanced usage only.
`Location`	Gets or sets the Location.
`NodalPlanes`	Gets or sets the NodalPlanes.
`NodalPlanesVisible`	Gets or sets the NodalPlanesVisible.
`Properties`	Gets the list of properties for this object.
`ReadOnly`	Gets or sets the ReadOnly.
`StartPlane`	Gets or sets the StartPlane.
`Suppressed`	Gets or sets the Suppressed.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property GeneralAxisymmetric.Axis: Ansys.Mechanical.DataModel.Enums.CoordinateSystemAxisType | None#: Gets or sets the Axis.

property GeneralAxisymmetric.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#: Gets the list of children.

property GeneralAxisymmetric.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None#: Gets the list of associated comments.

property GeneralAxisymmetric.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#: Gets or sets the CoordinateSystem.

property GeneralAxisymmetric.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#: Gets the current DataModelObject's category.

property GeneralAxisymmetric.EndPlane: int | None#: Gets or sets the EndPlane.

property GeneralAxisymmetric.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#: Gets the list of associated figures.

property GeneralAxisymmetric.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#: Gets the list of associated images.

property GeneralAxisymmetric.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSGeneralAxisymmetricAuto | None#: Gets the internal object. For advanced usage only.

property GeneralAxisymmetric.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#: Gets or sets the Location.

property GeneralAxisymmetric.NodalPlanes: int | None#: Gets or sets the NodalPlanes.

property GeneralAxisymmetric.NodalPlanesVisible: Ansys.Mechanical.DataModel.Enums.NodalPlanesVisible | None#: Gets or sets the NodalPlanesVisible.

property GeneralAxisymmetric.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties for this object.

property GeneralAxisymmetric.ReadOnly: bool | None#: Gets or sets the ReadOnly.

property GeneralAxisymmetric.StartPlane: int | None#: Gets or sets the StartPlane.

property GeneralAxisymmetric.Suppressed: bool | None#: Gets or sets the Suppressed.

property GeneralAxisymmetric.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties that are visible for this object.

Method detail#

GeneralAxisymmetric.Activate() → None#: Activate the current object.

GeneralAxisymmetric.AddComment() → Ansys.ACT.Automation.Mechanical.Comment#: Creates a new child Comment.

GeneralAxisymmetric.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure#: Creates a new child Figure.

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

GeneralAxisymmetric.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None#: Copies all visible properties from this object to another.

GeneralAxisymmetric.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter#: Creates a new parameter for a Property.

GeneralAxisymmetric.Delete() → None#: Run the Delete action.

GeneralAxisymmetric.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#: Creates a copy of the current DataModelObject.

GeneralAxisymmetric.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]#: Gets the list of children, filtered by type.

GeneralAxisymmetric.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter#: Gets the parameter corresponding to the given property.

GeneralAxisymmetric.GroupAllSimilarChildren() → None#: Run the GroupAllSimilarChildren action.

GeneralAxisymmetric.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#: Run the GroupSimilarObjects action.

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

GeneralAxisymmetric.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property#: Get a property by its unique name.

GeneralAxisymmetric.RemoveParameter(propName: str) → None#: Removes the parameter from the parameter set corresponding to the given property.