ExternalDataFile

class ansys.mechanical.stubs.v251.Ansys.Mechanical.ExternalData.ExternalDataFile(importSettings: Ansys.Mechanical.ExternalData.ImportSettingsBase, filePath: str, identifier: str, description: str, isMainFile: bool, isRootRelativePath: bool)

Bases: object

A basic definition of the external data file.

Overview

Methods

Equals	Equals method.
GetHashCode	GetHashCode method.
GetType	GetType method.
ToString	ToString method.

Properties

Description	Gets or sets the optional description of the external data file.
FilePath	Gets or sets the file path of the external data file.
Identifier	Gets or sets the identifier of the external data file.
ImportSettings	Gets or sets the import settings for current external data file.
IsMainFile	Gets or sets the main file flag of the external data file.
IsRootRelativePath	IsRootRelativePath property.

Property detail

property ExternalDataFile.Description: str | None

Gets or sets the optional description of the external data file.

property ExternalDataFile.FilePath: str | None

Gets or sets the file path of the external data file.

property ExternalDataFile.Identifier: str | None

Gets or sets the identifier of the external data file.

property ExternalDataFile.ImportSettings: Ansys.Mechanical.ExternalData.ImportSettingsBase | None

Gets or sets the import settings for current external data file.

An import settings can be created by calling the GetSettingsForFormat method from the factory class .

property ExternalDataFile.IsMainFile: bool | None

Gets or sets the main file flag of the external data file.

The nodal coordinate data for the selected main file is processed by the mapping utility. The nodal coordinate data will be skipped in all other files.

Only one file can be set as the main file, otherwise, an exception will be thrown during the import.

If the import format is MAPDL, the value of this property will be ignored as the MAPDL CDB file will always be treated as main file during the import.

property ExternalDataFile.IsRootRelativePath: bool | None

IsRootRelativePath property.

Method detail

ExternalDataFile.Equals(obj: Any) → bool

Equals method.

ExternalDataFile.GetHashCode() → int

GetHashCode method.

ExternalDataFile.GetType() → type

GetType method.

ExternalDataFile.ToString() → str

ToString method.