Table

Defines a Table.

Declaration Syntax

public class Table : DataModelObject, IDataTable, IEnumerable<IDataSeries>, IEnumerable, IRemovableDataModelObject, IRecordableProperties, IFolderDataModelObject

Table 345: Members

Property

APDLName

Gets or sets the name of the Table when explicitly written to the APDL input file.

Property

Children

Gets the list of children.

Property

Comments

Gets the list of associated comments.

Property

DataModelObjectCategory

Gets the current DataModelObject's category.

Property

Figures

Gets the list of associated figures.

Property

Images

Gets the list of associated images.

Property

InternalObject

Gets the internal object. For advanced usage only.

Property

IsStrictSizing

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

(See Ansys.ACT.Automation.Mechanical.Table.IsStrictSizing) will always be `true` when (See Ansys.ACT.Automation.Mechanical.Table.IsReadOnly) is `true`.

When (See Ansys.ACT.Automation.Mechanical.Table.IsStrictSizing) 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

PathType

Gets or sets the PathType.

Property

RefreshImportOn

Gets or sets the RefreshImportOn.

Property

SendToSolver

Get whether the Table will be explicitly written to the APDL input file.

Property

SpatialCoordinateSystem

Gets or sets the coordinate system applied to the Table’s spatial independent columns.

Method

AddComment()

Creates a new child Comment.

Method

AddFigure()

Creates a new child Figure.

Method

AddImage(string)

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.

Method

CreateAndAddColumn(VariableType, VariableClassification, IEnumerable, string, string)

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

Method

GetChildren<ChildrenType>(bool, IList<ChildrenType>)

Gets the list of children, filtered by type.

Method

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)

Gets the list of children, filtered by type.

Method

GetDataURI(Column)

Gets the data URI from which the tabular data was imported.

Method

GetImportSettings(Column)

Get the settings used for an import operation.

Method

Import(string, ImportFormat, ImportSettingsBase)

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 (See Ansys.ACT.Automation.Mechanical.Table.IsStrictSizing) is true, (See Ansys.ACT.Automation.Mechanical.Table.Import(System.String,Ansys.Mechanical.DataModel.MechanicalEnums.Table.ImportFormat,Ansys.Mechanical.Table.ImportSettingsBase)) 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 (See Ansys.ACT.Automation.Mechanical.Table.IsStrictSizing) 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.

NestedType

Column

Adapt an Ansys.Common.Interop.AnsMaterial.ILoadVariationVariable instance to an Ansys.Mechanical.Interfaces.IDataSeries.

The individual values may be set, but the length of the series is fixed. Any changes to the number of rows must be made in conjunction with any sibling (See Ansys.ACT.Automation.Mechanical.Table.Column) instances by the parent (See Ansys.Mechanical.Interfaces.IDataTable).