`ColumnarDataSourceBase`#

class ansys.mechanical.stubs.v261.Ansys.Mechanical.ExternalData.ColumnarDataSourceBase#

Bases: object

is a class that provides foundational behavior for

import settings that consume data from columnar data sources (such as delimited or fixed-width files).

Overview#

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.
`Format`	Gets the existing corresponding format.
`Item`	Item property.
`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 ColumnarDataSourceBase.Count: int | None#: Gets the number of column definitions.

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

property ColumnarDataSourceBase.Item: Ansys.Mechanical.ExternalData.ColumnarDataImportDefinition | None#: Item property.

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

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

Method detail#

ColumnarDataSourceBase.Clear() → None#

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

ColumnarDataSourceBase.GetEnumerator() → Iterator[Ansys.Mechanical.ExternalData.ColumnarDataImportDefinition]#

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

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

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

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

ColumnarDataSourceBase.UseColumn(index: int, variableType: Ansys.Mechanical.DataModel.MechanicalEnums.ExternalData.VariableType, unit: str, name: str) → Ansys.Mechanical.ExternalData.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 table/>.

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.