Skip to content

maint: 2024 Mechanical doc updates #88

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 13, 2024
Merged

maint: 2024 Mechanical doc updates #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
32 changes: 16 additions & 16 deletions ...s/mechanical/stubs/v241/Ansys/ACT/Automation/Mechanical/AMOverhangConstraint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Defines a AMOverhangConstraint.
### Methods

| Name | Description |
|-------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|
|----------------------------------------------------------------------------|-----------------------------------------------------------------------------------|
| [`Activate`](#AMOverhangConstraint.Activate) | Activate the current object. |
| [`CopyTo`](#AMOverhangConstraint.CopyTo) | Copies all visible properties from this object to another. |
| [`CreateParameter`](#AMOverhangConstraint.CreateParameter) | Creates a new parameter for a Property. |
Expand All @@ -35,7 +35,7 @@ Defines a AMOverhangConstraint.
### Properties

| Name | Description |
|-------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------|
|----------------------------------------------------------------------------|---------------------------------------------------------------|
| [`BuildDirection`](#AMOverhangConstraint.BuildDirection) | Gets or sets the BuildDirection. |
| [`Children`](#AMOverhangConstraint.Children) | Gets the list of children. |
| [`CoordinateSystem`](#AMOverhangConstraint.CoordinateSystem) | Gets or sets the CoordinateSystem. |
Expand All @@ -54,15 +54,15 @@ Defines a AMOverhangConstraint.

<a id="AMOverhangConstraint.BuildDirection"></a>

### *property* AMOverhangConstraint.BuildDirection *: [Ansys.Mechanical.DataModel.Enums.CoordinateSystemAxisType](../../../../../v242/Ansys/Mechanical/DataModel/Enums/CoordinateSystemAxisType.md#ansys.mechanical.stubs.v242.Ansys.Mechanical.DataModel.Enums.CoordinateSystemAxisType) | [None](https://docs.python.org/3/library/constants.html#None)*
### *property* AMOverhangConstraint.BuildDirection *: [Ansys.Mechanical.DataModel.Enums.CoordinateSystemAxisType](../../../Mechanical/DataModel/Enums/CoordinateSystemAxisType.md#ansys.mechanical.stubs.v241.Ansys.Mechanical.DataModel.Enums.CoordinateSystemAxisType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the BuildDirection.

<!-- !! processed by numpydoc !! -->

<a id="AMOverhangConstraint.Children"></a>

### *property* AMOverhangConstraint.Children *: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | [None](https://docs.python.org/3/library/constants.html#None)*
### *property* AMOverhangConstraint.Children *: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of children.

Expand All @@ -78,7 +78,7 @@ Gets or sets the CoordinateSystem.

<a id="AMOverhangConstraint.DataModelObjectCategory"></a>

### *property* AMOverhangConstraint.DataModelObjectCategory *: [Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory](../../../../../v242/Ansys/Mechanical/DataModel/Enums/DataModelObjectCategory.md#ansys.mechanical.stubs.v242.Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory) | [None](https://docs.python.org/3/library/constants.html#None)*
### *property* AMOverhangConstraint.DataModelObjectCategory *: [Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory](../../../Mechanical/DataModel/Enums/DataModelObjectCategory.md#ansys.mechanical.stubs.v241.Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the current DataModelObject’s category.

Expand All @@ -102,39 +102,39 @@ Gets or sets the OverhangAngle.

<a id="AMOverhangConstraint.Properties"></a>

### *property* AMOverhangConstraint.Properties *: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | [None](https://docs.python.org/3/library/constants.html#None)*
### *property* AMOverhangConstraint.Properties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)[Ansys.ACT.Automation.Mechanical.Property] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties for this object.

<!-- !! processed by numpydoc !! -->

<a id="AMOverhangConstraint.ScopingMethod"></a>

### *property* AMOverhangConstraint.ScopingMethod *: [Ansys.Mechanical.DataModel.Enums.GeometryDefineByType](../../../../../v242/Ansys/Mechanical/DataModel/Enums/GeometryDefineByType.md#ansys.mechanical.stubs.v242.Ansys.Mechanical.DataModel.Enums.GeometryDefineByType) | [None](https://docs.python.org/3/library/constants.html#None)*
### *property* AMOverhangConstraint.ScopingMethod *: [Ansys.Mechanical.DataModel.Enums.GeometryDefineByType](../../../Mechanical/DataModel/Enums/GeometryDefineByType.md#ansys.mechanical.stubs.v241.Ansys.Mechanical.DataModel.Enums.GeometryDefineByType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ScopingMethod.

<!-- !! processed by numpydoc !! -->

<a id="AMOverhangConstraint.Selection"></a>

### *property* AMOverhangConstraint.Selection *: [Ansys.ACT.Automation.Mechanical.OptimizationRegion](../../../../../v242/Ansys/ACT/Automation/Mechanical/OptimizationRegion.md#ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.OptimizationRegion) | [None](https://docs.python.org/3/library/constants.html#None)*
### *property* AMOverhangConstraint.Selection *: [Ansys.ACT.Automation.Mechanical.OptimizationRegion](OptimizationRegion.md#ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.OptimizationRegion) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Selection.

<!-- !! processed by numpydoc !! -->

<a id="AMOverhangConstraint.Suppressed"></a>

### *property* AMOverhangConstraint.Suppressed *: System.Boolean | [None](https://docs.python.org/3/library/constants.html#None)*
### *property* AMOverhangConstraint.Suppressed *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Suppressed.

<!-- !! processed by numpydoc !! -->

<a id="AMOverhangConstraint.VisibleProperties"></a>

### *property* AMOverhangConstraint.VisibleProperties *: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | [None](https://docs.python.org/3/library/constants.html#None)*
### *property* AMOverhangConstraint.VisibleProperties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)[Ansys.ACT.Automation.Mechanical.Property] | [None](https://docs.python.org/3/library/constants.html#None)*

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

Expand Down Expand Up @@ -162,7 +162,7 @@ Copies all visible properties from this object to another.

<a id="AMOverhangConstraint.CreateParameter"></a>

### AMOverhangConstraint.CreateParameter(propName: System.String)
### AMOverhangConstraint.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Creates a new parameter for a Property.

Expand All @@ -186,15 +186,15 @@ Creates a copy of the current DataModelObject.

<a id="AMOverhangConstraint.GetChildren"></a>

### AMOverhangConstraint.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType])
### AMOverhangConstraint.GetChildren(recurses: [bool](https://docs.python.org/3/library/functions.html#bool), children: List[ChildrenType])

Gets the list of children, filtered by type.

<!-- !! processed by numpydoc !! -->

<a id="AMOverhangConstraint.GetParameter"></a>

### AMOverhangConstraint.GetParameter(propName: System.String)
### AMOverhangConstraint.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Gets the parameter corresponding to the given property.

Expand All @@ -218,7 +218,7 @@ Run the GroupSimilarObjects action.

<a id="AMOverhangConstraint.PropertyByAPIName"></a>

### AMOverhangConstraint.PropertyByAPIName(name: System.String)
### AMOverhangConstraint.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

```text
Get a property by its API name.
Expand All @@ -229,15 +229,15 @@ If multiple properties have the same API Name, only the first property with that

<a id="AMOverhangConstraint.PropertyByName"></a>

### AMOverhangConstraint.PropertyByName(name: System.String)
### AMOverhangConstraint.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

Get a property by its unique name.

<!-- !! processed by numpydoc !! -->

<a id="AMOverhangConstraint.RemoveParameter"></a>

### AMOverhangConstraint.RemoveParameter(propName: System.String)
### AMOverhangConstraint.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

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

Expand Down
28 changes: 14 additions & 14 deletions .../stubs/v241/Ansys/ACT/Automation/Mechanical/AcousticsFarFieldResultWorksheet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ AcousticsFarFieldResultWorksheet class.
### Methods

| Name | Description |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
|--------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
| [`AddRow`](#AcousticsFarFieldResultWorksheet.AddRow) | Adds a Row to the worksheet. |
| [`DeleteRow`](#AcousticsFarFieldResultWorksheet.DeleteRow) | Deletes a row from the worksheet at index. |
| [`DuplicateRow`](#AcousticsFarFieldResultWorksheet.DuplicateRow) | Insert a row from the worksheet at index. |
Expand All @@ -34,7 +34,7 @@ AcousticsFarFieldResultWorksheet class.
### Properties

| Name | Description |
|---------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|
|------------------------------------------------------------|---------------------------------|
| [`RowCount`](#AcousticsFarFieldResultWorksheet.RowCount) | Return the number of entries. |

<a id="property-detail"></a>
Expand All @@ -43,7 +43,7 @@ AcousticsFarFieldResultWorksheet class.

<a id="AcousticsFarFieldResultWorksheet.RowCount"></a>

### *property* AcousticsFarFieldResultWorksheet.RowCount *: System.Int32 | [None](https://docs.python.org/3/library/constants.html#None)*
### *property* AcousticsFarFieldResultWorksheet.RowCount *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Return the number of entries.

Expand All @@ -63,87 +63,87 @@ Adds a Row to the worksheet.

<a id="AcousticsFarFieldResultWorksheet.DeleteRow"></a>

### AcousticsFarFieldResultWorksheet.DeleteRow(index: System.Int32)
### AcousticsFarFieldResultWorksheet.DeleteRow(index: [int](https://docs.python.org/3/library/functions.html#int))

Deletes a row from the worksheet at index.

<!-- !! processed by numpydoc !! -->

<a id="AcousticsFarFieldResultWorksheet.DuplicateRow"></a>

### AcousticsFarFieldResultWorksheet.DuplicateRow(fromIndex: System.Int32, toIndex: System.Int32)
### AcousticsFarFieldResultWorksheet.DuplicateRow(fromIndex: [int](https://docs.python.org/3/library/functions.html#int), toIndex: [int](https://docs.python.org/3/library/functions.html#int))

Insert a row from the worksheet at index.

<!-- !! processed by numpydoc !! -->

<a id="AcousticsFarFieldResultWorksheet.GetCoordinateSystemSelection"></a>

### AcousticsFarFieldResultWorksheet.GetCoordinateSystemSelection(index: System.Int32)
### AcousticsFarFieldResultWorksheet.GetCoordinateSystemSelection(index: [int](https://docs.python.org/3/library/functions.html#int))

Gets the worksheet CoordinateSystemSelection property at index.

<!-- !! processed by numpydoc !! -->

<a id="AcousticsFarFieldResultWorksheet.GetXCoordinate"></a>

### AcousticsFarFieldResultWorksheet.GetXCoordinate(index: System.Int32)
### AcousticsFarFieldResultWorksheet.GetXCoordinate(index: [int](https://docs.python.org/3/library/functions.html#int))

Gets the worksheet Mic X property at index.

<!-- !! processed by numpydoc !! -->

<a id="AcousticsFarFieldResultWorksheet.GetYCoordinate"></a>

### AcousticsFarFieldResultWorksheet.GetYCoordinate(index: System.Int32)
### AcousticsFarFieldResultWorksheet.GetYCoordinate(index: [int](https://docs.python.org/3/library/functions.html#int))

Gets the worksheet Mic Y property at index.

<!-- !! processed by numpydoc !! -->

<a id="AcousticsFarFieldResultWorksheet.GetZCoordinate"></a>

### AcousticsFarFieldResultWorksheet.GetZCoordinate(index: System.Int32)
### AcousticsFarFieldResultWorksheet.GetZCoordinate(index: [int](https://docs.python.org/3/library/functions.html#int))

Gets the worksheet Mic Z property at index.

<!-- !! processed by numpydoc !! -->

<a id="AcousticsFarFieldResultWorksheet.InsertRow"></a>

### AcousticsFarFieldResultWorksheet.InsertRow(index: System.Int32)
### AcousticsFarFieldResultWorksheet.InsertRow(index: [int](https://docs.python.org/3/library/functions.html#int))

Insert a row from the worksheet at index.

<!-- !! processed by numpydoc !! -->

<a id="AcousticsFarFieldResultWorksheet.SetCoordinateSystemSelection"></a>

### AcousticsFarFieldResultWorksheet.SetCoordinateSystemSelection(index: System.Int32, newVal: System.UInt32)
### AcousticsFarFieldResultWorksheet.SetCoordinateSystemSelection(index: [int](https://docs.python.org/3/library/functions.html#int), newVal: [int](https://docs.python.org/3/library/functions.html#int))

Sets the worksheet CoordinateSystemSelection property at index.

<!-- !! processed by numpydoc !! -->

<a id="AcousticsFarFieldResultWorksheet.SetXCoordinate"></a>

### AcousticsFarFieldResultWorksheet.SetXCoordinate(index: System.Int32, newVal: System.Double)
### AcousticsFarFieldResultWorksheet.SetXCoordinate(index: [int](https://docs.python.org/3/library/functions.html#int), newVal: [float](https://docs.python.org/3/library/functions.html#float))

Sets the worksheet Mic X property at index.

<!-- !! processed by numpydoc !! -->

<a id="AcousticsFarFieldResultWorksheet.SetYCoordinate"></a>

### AcousticsFarFieldResultWorksheet.SetYCoordinate(index: System.Int32, newVal: System.Double)
### AcousticsFarFieldResultWorksheet.SetYCoordinate(index: [int](https://docs.python.org/3/library/functions.html#int), newVal: [float](https://docs.python.org/3/library/functions.html#float))

Sets the worksheet Mic Y property at index.

<!-- !! processed by numpydoc !! -->

<a id="AcousticsFarFieldResultWorksheet.SetZCoordinate"></a>

### AcousticsFarFieldResultWorksheet.SetZCoordinate(index: System.Int32, newVal: System.Double)
### AcousticsFarFieldResultWorksheet.SetZCoordinate(index: [int](https://docs.python.org/3/library/functions.html#int), newVal: [float](https://docs.python.org/3/library/functions.html#float))

Sets the worksheet Mic Z property at index.

Expand Down
Loading