`FixedWidthImportSettings`#

class ansys.mechanical.stubs.v261.Ansys.Mechanical.Table.FixedWidthImportSettings#

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

`ColumnWidths`	Gets or sets the specified column widths.
`Count`	Gets the number of column definitions.
`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 FixedWidthImportSettings.ColumnWidths: Any | None#: Gets or sets the specified column widths. When setting, The value provided to may be either:

A string using Fortran-esque fixed-format specifications. This is similar to the “User-Defined” format specifier for External Data as described in the product documentation. Note, however, that regardless of the format specifier all imported columns WILL be interpreted using the .NET command double.TryParse() to support the requirements of the underlying variable data for Table.

An containing the widths of each column. Negative values may be specified to define a negated width, meaning '-2' would be equivalent to the fixed-width string specification '2X'.

property FixedWidthImportSettings.Count: int | None#: Gets the number of column definitions.

property FixedWidthImportSettings.Format: Ansys.Mechanical.DataModel.MechanicalEnums.Table.ImportFormat | None#: Gets the existing corresponding format.

property FixedWidthImportSettings.Item: Ansys.Mechanical.Table.ColumnarDataImportDefinition | None#: Item property.

property FixedWidthImportSettings.PathType: Ansys.Mechanical.DataModel.MechanicalEnums.Common.PathType | None#: Gets or sets the type of URI provided for Table import. Default:

property FixedWidthImportSettings.SkipFooter: int | None#: Gets or sets the number of rows to ignore at the end of the file during import.

property FixedWidthImportSettings.SkipRows: int | None#: Gets or sets the number of rows to skip over at the start of the file during import.

Method detail#

FixedWidthImportSettings.Clear() → None#

FixedWidthImportSettings.Equals(obj: Any) → bool#: Equals method.

classmethod FixedWidthImportSettings.GenerateFromComImportSettings(importSettings: Ansys.Common.Interop.DSObjects.IDSTableImportSettingsFixedWidth) → Ansys.Mechanical.Table.ImportSettingsBase#: GenerateFromComImportSettings method.

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

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

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

FixedWidthImportSettings.RemoveAt(index: int) → None#: Removes the import definition at the specified index.

classmethod FixedWidthImportSettings.SaveToComImportSettings(importSettings: Ansys.Mechanical.Table.FixedWidthImportSettings) → Ansys.Common.Interop.DSObjects.IDSTableImportSettingsBase#: SaveToComImportSettings method.

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

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