AcousticPort
Last update: 14.01.2025
AcousticPort
class Ansys.ACT.Automation.Mechanical.BoundaryConditions.AcousticPort
Bases: object
Defines a AcousticPort.
Overview
Methods
Name | Description |
---|---|
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. |
PromoteToNamedSelection |
Run the PromoteToNamedSelection 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. |
Comments |
Gets the list of associated comments. |
DataModelObjectCategory |
Gets the current DataModelObject’s category. |
Figures |
Gets the list of associated figures. |
Images |
Gets the list of associated images. |
InsideSurfaceBodiesLocation |
Gets or sets the InsideSurfaceBodiesLocation. |
InternalObject |
Gets the internal object. For advanced usage only. |
PortBehavior |
Gets or sets the PortBehavior. |
PortNumber |
Gets the PortNumber. |
PortPosition |
Gets or sets the PortPosition. |
PortSurfaceLocation |
Gets or sets the PortSurfaceLocation. |
Properties |
Gets the list of properties for this object. |
ReadOnly |
Gets or sets the ReadOnly. |
SharedRefBody |
Gets or sets the SharedRefBody. |
Suppressed |
Gets or sets the Suppressed. |
VisibleProperties |
Gets the list of properties that are visible for this object. |
Property detail
property AcousticPort.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
property AcousticPort.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
property AcousticPort.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
property AcousticPort.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None
Gets the list of associated figures.
property AcousticPort.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
property AcousticPort.InsideSurfaceBodiesLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None
Gets or sets the InsideSurfaceBodiesLocation.
property AcousticPort.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None
Gets the internal object. For advanced usage only.
property AcousticPort.PortBehavior : Ansys.Mechanical.DataModel.Enums.PortBehavior | None
Gets or sets the PortBehavior.
property AcousticPort.PortNumber : int | None
Gets the PortNumber.
property AcousticPort.PortPosition : Ansys.Mechanical.DataModel.Enums.PortPosition | None
Gets or sets the PortPosition.
property AcousticPort.PortSurfaceLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None
Gets or sets the PortSurfaceLocation.
property AcousticPort.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
property AcousticPort.ReadOnly : bool | None
Gets or sets the ReadOnly.
property AcousticPort.SharedRefBody : Ansys.ACT.Automation.Mechanical.Body | None
Gets or sets the SharedRefBody.
property AcousticPort.Suppressed : bool | None
Gets or sets the Suppressed.
property AcousticPort.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
Method detail
AcousticPort.Activate()
Activate the current object.
AcousticPort.AddComment()
Creates a new child Comment.
AcousticPort.AddFigure()
Creates a new child Figure.
AcousticPort.AddImage(filePath: str)
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.
AcousticPort.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)
Copies all visible properties from this object to another.
AcousticPort.CreateParameter(propName: str)
Creates a new parameter for a Property.
AcousticPort.Delete()
Run the Delete action.
AcousticPort.Duplicate()
Creates a copy of the current DataModelObject.
AcousticPort.GetChildren(recurses: bool, children: List[ChildrenType])
Gets the list of children, filtered by type.
AcousticPort.GetParameter(propName: str)
Gets the parameter corresponding to the given property.
AcousticPort.GroupAllSimilarChildren()
Run the GroupAllSimilarChildren action.
AcousticPort.GroupSimilarObjects()
Run the GroupSimilarObjects action.
AcousticPort.PromoteToNamedSelection()
Run the PromoteToNamedSelection action.
AcousticPort.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.
AcousticPort.PropertyByName(name: str)
Get a property by its unique name.
AcousticPort.RemoveParameter(propName: str)
Removes the parameter from the parameter set corresponding to the given property.