DelimitedImportSettings

class ansys.mechanical.stubs.v261.Ansys.Mechanical.Table.DelimitedImportSettings

Bases: object

defines how to import data from a delimited source

for tabular data.

Overview

Constructors

GenerateFromComImportSettings	GenerateFromComImportSettings method.
SaveToComImportSettings	SaveToComImportSettings method.

Methods

Clear
Equals	Equals method.
GetEnumerator
GetHashCode	GetHashCode method.
GetType	GetType method.
RemoveAt	Removes the import definition at the specified index.
ToString	ToString method.
UseColumn	Add a column to be imported from the specified data source column index and configured

Properties

Count	Gets the number of column definitions.
Delimiter	The delimiter used to separate columns.
Format	Gets the existing corresponding format.
Item	Item property.
PathType	Gets or sets the type of URI provided for Table import.
SkipFooter	Gets or sets the number of rows to ignore at the end of the file during import.
SkipRows	Gets or sets the number of rows to skip over at the start of the file during import.

Property detail

property DelimitedImportSettings.Count: int | None

Gets the number of column definitions.

property DelimitedImportSettings.Delimiter: str | None

The delimiter used to separate columns.

property DelimitedImportSettings.Format: Ansys.Mechanical.DataModel.MechanicalEnums.Table.ImportFormat | None

Gets the existing corresponding format.

property DelimitedImportSettings.Item: Ansys.Mechanical.Table.ColumnarDataImportDefinition | None

Item property.

property DelimitedImportSettings.PathType: Ansys.Mechanical.DataModel.MechanicalEnums.Common.PathType | None

Gets or sets the type of URI provided for Table import. Default:

property DelimitedImportSettings.SkipFooter: int | None

Gets or sets the number of rows to ignore at the end of the file during import.

property DelimitedImportSettings.SkipRows: int | None

Gets or sets the number of rows to skip over at the start of the file during import.

Method detail

DelimitedImportSettings.Clear() → None

DelimitedImportSettings.Equals(obj: Any) → bool

Equals method.

classmethod DelimitedImportSettings.GenerateFromComImportSettings(comImportSettings: Ansys.Common.Interop.DSObjects.IDSTableImportSettingsDelimited) → Ansys.Mechanical.Table.ImportSettingsBase

GenerateFromComImportSettings method.

DelimitedImportSettings.GetEnumerator() → Iterator[Ansys.Mechanical.Table.ColumnarDataImportDefinition]

DelimitedImportSettings.GetHashCode() → int

GetHashCode method.

DelimitedImportSettings.GetType() → type

GetType method.

DelimitedImportSettings.RemoveAt(index: int) → None

Removes the import definition at the specified index.

classmethod DelimitedImportSettings.SaveToComImportSettings(importSettings: Ansys.Mechanical.Table.DelimitedImportSettings) → Ansys.Common.Interop.DSObjects.IDSTableImportSettingsBase

SaveToComImportSettings method.

DelimitedImportSettings.ToString() → str

ToString method.

DelimitedImportSettings.UseColumn(index: int, variableType: Ansys.Mechanical.DataModel.MechanicalEnums.Table.VariableType, variableClassification: Ansys.Mechanical.DataModel.MechanicalEnums.Table.VariableClassification, unit: str, name: str) → Ansys.Mechanical.Table.ColumnarDataSourceBase

Add a column to be imported from the specified data source column index and configured
as the specified variable type. The order in which columns are added determines their
order in the data imported to .

If unit is `null`, the default unit (in the active unit system) for the specified
variable type will be assumed during import.

If name is `null` or empty, a unique name will be generated from the specified
variableType during import.

A reference to the instance is returned so that invocations can be chained together.