Table
Last update: 14.01.2025
Table
class Ansys.ACT.Automation.Mechanical.Table
Bases: object
Defines a Table.
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. |
CreateAndAddColumn |
Creates and adds a new column (data series) to the table. |
CreateParameter |
Creates a new parameter for a Property. |
Duplicate |
Creates a copy of the current DataModelObject. |
GetChildren |
Gets the list of children, filtered by type. |
GetDataURI |
Gets the data URI from which the tabular data was imported. |
GetImportSettings |
Get the settings used for an import operation. |
GetParameter |
Gets the parameter corresponding to the given property. |
GroupAllSimilarChildren |
Run the GroupAllSimilarChildren action. |
GroupSimilarObjects |
Run the GroupSimilarObjects action. |
Import |
|
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 |
---|---|
APDLName |
Gets or sets the name of the Table when explicitly written to the APDL input file. |
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. |
InternalObject |
Gets the internal object. For advanced usage only. |
IsStrictSizing |
Whether column add/create/import/refresh operations cannot grow the number of rows. |
PathType |
Gets or sets the PathType. |
Properties |
Gets the list of properties for this object. |
RefreshImportOn |
Gets or sets the RefreshImportOn. |
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. |
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.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
property Table.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
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.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
property Table.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSTableAuto | None
Gets the internal object. For advanced usage only.
property Table.IsStrictSizing : bool | None
Whether column add/create/import/refresh operations cannot grow the number of rows.
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.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.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
Method detail
Table.Activate()
Activate the current object.
Table.AddComment()
Creates a new child Comment.
Table.AddFigure()
Creates a new child Figure.
Table.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.
Table.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)
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)
Creates and adds a new column (data series) to the table.
Table.CreateParameter(propName: str)
Creates a new parameter for a Property.
Table.Duplicate()
Creates a copy of the current DataModelObject.
Table.GetChildren(recurses: bool, children: List[ChildrenType])
Gets the list of children, filtered by type.
Table.GetDataURI(newColumn: Ansys.ACT.Automation.Mechanical.Table.Column)
Gets the data URI from which the tabular data was imported.
Table.GetImportSettings(newColumn: Ansys.ACT.Automation.Mechanical.Table.Column)
Get the settings used for an import operation.
Table.GetParameter(propName: str)
Gets the parameter corresponding to the given property.
Table.GroupAllSimilarChildren()
Run the GroupAllSimilarChildren action.
Table.GroupSimilarObjects()
Run the GroupSimilarObjects action.
Table.Import(dataURI: str, format: Ansys.Mechanical.DataModel.MechanicalEnums.Table.ImportFormat, settings: Ansys.Mechanical.Table.ImportSettingsBase)
Table.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.
Table.PropertyByName(name: str)
Get a property by its unique name.
Table.RemoveParameter(propName: str)
Removes the parameter from the parameter set corresponding to the given property.