`Table`#

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

Bases: object

Defines a Table.

Overview#

Methods

`Activate`	Activate the current object.
`Add`
`AddComment`	Creates a new child Comment.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`Clear`
`Contains`
`CopyTo`	Copies all visible properties from this object to another.
`CreateAndAddColumn`	Creates and adds a new column (data series) to the table.
`CreateObjRef`	CreateObjRef method.
`CreateParameter`	Creates a new parameter for a Property.
`Duplicate`	Creates a copy of the current DataModelObject.
`Equals`	Equals method.
`ExecutePropertySetViaApi`
`GetAPIName`	Property name bound to dispId.
`GetAllProperties`	GetAllProperties method.
`GetChildren`	Gets the list of children, filtered by type.
`GetDataURI`	Gets the data URI from which the tabular data was imported.
`GetDetailsView`	GetDetailsView method.
`GetEnumName`	Enum name bound to value
`GetEnumerator`
`GetHashCode`	GetHashCode method.
`GetIconFile`	GetIconFile method.
`GetImportSettings`	Get the settings used for an import operation.
`GetLifetimeService`	GetLifetimeService method.
`GetObjectData`	GetObjectData method.
`GetParameter`	Gets the parameter corresponding to the given property.
`GetPath`	GetPath method.
`GetPropertyName`	GetPropertyName method.
`GetPropertyValue`	GetPropertyValue method.
`GetRow`
`GetType`	GetType method.
`GetVisibleProperties`	GetVisibleProperties method.
`GetVisiblePropertyNames`	GetVisiblePropertyNames method.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`Import`	Import data from the provided resource into the table as specified by
`InitializeLifetimeService`	InitializeLifetimeService method.
`Insert`
`IsPropertyEditable`	IsPropertyEditable method.
`IsPropertyVisible`	IsPropertyVisible method.
`MapToInternalVariableType`	MapToInternalVariableType method.
`PropertyByAPIName`	Get a property by its API name.
`PropertyById`	PropertyById method.
`PropertyByName`	Get a property by its unique name.
`Remove`
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.
`ToString`	ToString method.
`TryInsertRow`
`TryRemoveRow`

Properties

`APDLName`	Gets or sets the name of the Table when explicitly written to the APDL input file.
`AttachedRefs`	AttachedRefs property.
`CanRemove`
`Children`	Gets the list of children.
`ClsId`	ClsId property.
`ColumnNames`
`Columns`
`Comments`	Gets the list of associated comments.
`Count`
`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.
`IsFixedColumnCount`
`IsFixedRowCount`
`IsImported`	Returns whether the Table has any imported columns.
`IsReadOnly`
`IsStrictSizing`	Whether column add/create/import/refresh operations cannot grow the number of rows.
`Item`	Item property.
`Metadata`
`Name`
`ObjectId`	ObjectId property.
`ObjectState`	ObjectState property.
`ObjectTags`	ObjectTags property.
`Parent`	Parent property.
`PathType`	Gets or sets the PathType.
`Properties`	Gets the list of properties for this object.
`RefreshImportOn`	Gets or sets the RefreshImportOn.
`RowCount`
`SendToSolver`	Get whether the Table will be explicitly written to the APDL input file.
`SpatialCoordinateSystem`	Gets or sets the coordinate system applied to the Table's spatial independent columns.
`State`	State property.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property Table.APDLName: str | None#: Gets or sets the name of the Table when explicitly written to the APDL input file.

property Table.AttachedRefs: List[int] | None#: AttachedRefs property.

property Table.CanRemove: bool | None#

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

property Table.ClsId: int | None#: ClsId property.

property Table.ColumnNames: tuple[str] | None#

property Table.Columns: List[Ansys.Mechanical.Interfaces.IDataSeries] | None#

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

property Table.Count: int | None#

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

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

property Table.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#: GroupingFolder property.

property Table.IconName: str | None#: IconName property.

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

property Table.InternalObject: Ansys.Common.Interop.DSTableObjects.IDSTableAuto | None#: Gets the internal object. For advanced usage only.

property Table.IsFixedColumnCount: bool | None#

property Table.IsFixedRowCount: bool | None#

property Table.IsImported: bool | None#: Returns whether the Table has any imported columns.

property Table.IsReadOnly: bool | None#

property Table.IsStrictSizing: bool | None#

Whether column add/create/import/refresh operations cannot grow the number of rows.

will always be true when is

true.

When is true, any operation that would change the table row count will fail. This includes operations such as creating and adding a column, importing columns.

property Table.Item: Ansys.Mechanical.Interfaces.IDataSeries | None#: Item property.

property Table.Metadata: dict[str, Any] | None#

property Table.Name: str | None#

property Table.ObjectId: int | None#: ObjectId property.

property Table.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None#: ObjectState property.

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

property Table.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#: Parent property.

property Table.PathType: Ansys.Mechanical.DataModel.MechanicalEnums.Common.PathType | None#: Gets or sets the PathType.

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

property Table.RefreshImportOn: Ansys.Mechanical.DataModel.MechanicalEnums.Table.TableRefreshImportOn | None#: Gets or sets the RefreshImportOn.

property Table.RowCount: int | None#

property Table.SendToSolver: bool | None#: Get whether the Table will be explicitly written to the APDL input file.

property Table.SpatialCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#: Gets or sets the coordinate system applied to the Table's spatial independent columns.

property Table.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None#: State property.

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

Method detail#

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

Table.Add(dataSeries: Ansys.Mechanical.Interfaces.IDataSeries) → None#

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

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

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

Table.Clear() → None#

Table.Contains(name: str) → bool#

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

Table.CreateAndAddColumn(variableType: Ansys.Mechanical.DataModel.MechanicalEnums.Table.VariableType, variableClassification: Ansys.Mechanical.DataModel.MechanicalEnums.Table.VariableClassification, data: Iterable, unit: str, name: str) → Ansys.Mechanical.Interfaces.IDataSeries#

Creates and adds a new column (data series) to the table.

If `data` is provided, the number of rows (length of `data`) must be identical to the
number of rows already in the table. If `data` is not provided, the returned series will
have the same number of rows as the table with default-initialized values. If there are
no rows in the table and `data` is provided, this will initialize the number of rows in
the table to the length of `data`.

Table.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef#: CreateObjRef method.

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

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

Table.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool#: Equals method.

Table.ExecutePropertySetViaApi(propertyName: str) → bool#

Table.GetAPIName(dispId: int) → str#: Property name bound to dispId.

Table.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]#: GetAllProperties method.

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

Table.GetDataURI(newColumn: Ansys.ACT.Automation.Mechanical.Table.Column) → str#: Gets the data URI from which the tabular data was imported.

Table.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData#: GetDetailsView method.

Table.GetEnumName(enumType: type, value: int, dispId: int) → str#: Enum name bound to value

Table.GetEnumerator() → Iterator[Ansys.Mechanical.Interfaces.IDataSeries]#

Table.GetHashCode() → int#: GetHashCode method.

Table.GetIconFile() → System.Byte#: GetIconFile method.

Table.GetImportSettings(newColumn: Ansys.ACT.Automation.Mechanical.Table.Column) → Ansys.Mechanical.Table.ImportSettingsBase#: Get the settings used for an import operation.

Table.GetLifetimeService() → Any#: GetLifetimeService method.

Table.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None#: GetObjectData method.

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

Table.GetPath() → str#: GetPath method.

Table.GetPropertyName(dispId: int) → str#: GetPropertyName method.

Table.GetPropertyValue(name: str) → Any#: GetPropertyValue method.

Table.GetRow(rowIndex: int) → Iterable#

Table.GetType() → type#: GetType method.

Table.GetVisibleProperties() → List[System.Reflection.PropertyInfo]#: GetVisibleProperties method.

Table.GetVisiblePropertyNames() → List[str]#: GetVisiblePropertyNames method.

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

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

Table.Import(dataURI: str, format: Ansys.Mechanical.DataModel.MechanicalEnums.Table.ImportFormat, settings: Ansys.Mechanical.Table.ImportSettingsBase) → List[Ansys.Mechanical.Interfaces.IDataSeries]#

Import data from the provided resource into the table as specified by
format and settings. The column definitions in
settings will be used to define the variable type for each column.
If the table already contains a variable type, that column will be overwritten by the
new definition.

When  is true,  will verify that the
row count of imported data are equivalent to the existing table row count. The
operation will fail if there is a length mismatch. Conversely, when
 is false, a Mechanical warning message will be issued when
any of the data sources are different from each other or the table.

If all the arguments are `null` (Python: `None`) then the stored values will be used,
essentially re-syncing the table data to the external sources.

Table.InitializeLifetimeService() → Any#: InitializeLifetimeService method.

Table.Insert(columnIndex: int, dataSeries: Ansys.Mechanical.Interfaces.IDataSeries) → None#

Table.IsPropertyEditable(dispId: int) → bool#: IsPropertyEditable method.

Table.IsPropertyVisible(dispId: int) → bool#: IsPropertyVisible method.

Table.MapToInternalVariableType(external: Ansys.Mechanical.DataModel.MechanicalEnums.Table.VariableType, classification: Ansys.Mechanical.DataModel.MechanicalEnums.Table.VariableClassification) → Ansys.Mechanical.DataModel.MechanicalEnums.Table.InternalVariableType#: MapToInternalVariableType method.

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

Table.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property#: PropertyById method.

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

Table.Remove(key: Any) → None#

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

Table.ToString() → str#: ToString method.

Table.TryInsertRow(rowIndex: int, values: Iterable) → bool#

Table.TryRemoveRow(rowIndex: int) → bool#

Table#

Overview#

Property detail#

Method detail#

`Table`#