External Model Setup

External Model Setup
This container holds data to expose external model setup data within the Workbench project.

Methods

AddDataFile

Adds a data file to the outline

Return     Returns the reference to the FileData object
    Type     DataReference

Required Arguments

FilePath    The data file path
    Type     string

AddRepositoryFile

Adds a data file to the outline

Return     Returns the reference to the FileData object
    Type     DataReference

Required Arguments

File    The repository file
    Type     DataReference

GetExternalModelData

Query to return the reference to the container's ExternalLoadData data entity.

Return     A reference to the requested ExternalLoadData data entity.
    Type     DataReference

GetExternalModelOutput

Query to return the reference to the container's ExternalDataOutput data entity.

Return     A reference to the requested ExternalLoadData data entity.
    Type     DataReference

InsertDataFile

Adds a data file to the outline

Return     Returns the reference to the FileData object
    Type     DataReference

Required Arguments

FilePath    The data file path
    Type     string
Index    Inserts the data files in the specified location in the internal list. It is 0-based.
    Type     int

InsertRepositorySupportFile

Inserts a support file to the associated FileData in the repository

Required Arguments

File    The support file path
    Type     DataReference
FileData    ExternalLoadFileData reference to add the support file
    Type     DataReference

InsertSupportFile

No details are provided for this entry.

Return     Returns the reference to the File reference object
    Type     DataReference

Required Arguments

FileData    ExternalLoadFileData reference to add the support file
    Type     DataReference
FilePath    The support file path
    Type     string

ModifyRepositoryFile

Changes the file path of the existing FileData

Required Arguments

FileData    Reference to the FileData to be modified
    Type     DataReference
RepositoryFile    File to be modified in the FileData
    Type     DataReference

ModifyRespositorySupportFile

No details are provided for this entry.

Required Arguments

FileData    Reference to the FileData to be modified
    Type     DataReference
FileIdentifier    The support file to replace
    Type     string
RepositoryFile    File to be modified in the FileData
    Type     DataReference
Example

Required example does not exist.


ModifySupportFile

No details are provided for this entry.

Required Arguments

FileData    ExternalLoadFileData reference to add the support file
    Type     DataReference
FileIdentifier    The support file to replace
    Type     string
FilePath    The support file path
    Type     string
Example

Required example does not exist.


RereadDataFiles

When you modify an External Model system's data file outside of the Workbench and you need to cause the Workbench to re-read the data file.


ScanForFileChanges

This command is useful, when you modify an External Data system's data file outside of the Workbench and you need to cause the Workbench to re-read the data file.


Data Entities

ExternalModelData

This is the root level entity for the external data add-in

Properties

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type     string
Read Only    No
FilesData

Cotnains the List of FileData references

Type     List<DataReference>
Read Only    No

Methods

DeleteFileData

Removes a data file from the outline

Required Arguments

FileData    Reference to the FileData
    Type     DataReference
DuplicateFileData

Removes a data file from the outline

Required Arguments

FileData    Reference to the FileData
    Type     DataReference
GetExternalModelFileData

Query to return the reference to the container's ExternalLoadFileData data entity.

Return     A reference to the requested ExternalLoadFileData data entity.
    Type     DataReference

Required Arguments

Name    Name of the ExternalModelFileData entity
    Type     string

ExternalModelFileData

This entity contains information for the DataFile added to the outline

Properties

Description

Contains the description about the Data file

Type     string
Read Only    No
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type     string
Read Only    No
File

FileReference maintained by the project

Type     DataReference
Read Only    No
FileDataProperty

Contains the reference to the FileDataProperty

Type     DataReference
Read Only    No

Methods

GetDataProperty

Query to return the reference to the container's ExternalLoadFileDataProperty data entity.

Return     A reference to the requested ExternalLoadFileData data entity.
    Type     DataReference
ModifyFileData

Changes the file path of the existing FileData

Required Arguments

FilePath    FilePath to be modified in the FileData
    Type     string

ExternalModelFileDataProperty

Contains information displayed on the properties view

Properties

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type     string
Read Only    No
ElementComponentKey

Filter element components based on the component key

Type     string
Read Only    No
ElementOffset

Number to offset mesh elements by

Type     int
Read Only    No
FaceComponentKey

Filter element components based on the component key

Type     string
Read Only    No
FileIdentifier

A string that can be used to identify the file in the downstream Mechanical application. The data identifiers, from the Table pane, are appended to this string so that you can pick the correct source data in the downstream Mechanical application.

Type     string
Read Only    No
NodalComponentKey

Filter nodal components based on the component key

Type     string
Read Only    No
NodeAndElementRenumberingMethod

By default this value is Automatic, specifies whether the user would like us to automatically renumber his mesh elements to prevent unique id conflicts during assembly

Type     NodeAndElementRenumberingMethodType
Read Only    No
NodeOffset

Number to offset mesh nodes by

Type     int
Read Only    No
NumberOfCopies

Number of copies to be created by downstream consumer

Type     int
Read Only    No
OriginX

Contains the OriginX value

Type     double
Read Only    No
OriginXUnit

Contains the unit of the OriginX

Type     string
Read Only    No
OriginY

Contains the OriginY value

Type     double
Read Only    No
OriginYUnit

Contains the unit of the OriginY

Type     string
Read Only    No
OriginZ

Contains the OriginZ value

Type     double
Read Only    No
OriginZUnit

Contains the unit of the OriginZ

Type     string
Read Only    No
ProcessElementComponents

Process Element Components. On by default

Type     bool
Read Only    No
ProcessFaceComponents

Process Element Components. On by default

Type     bool
Read Only    No
ProcessModelData

Process Model Data like Coordinate Systems, Element Orientations etc. On by default

Type     bool
Read Only    No
ProcessNodalComponents

Process nodal Components. On by default

Type     bool
Read Only    No
SupportingFiles

Contains the list to all additional Supporting files

Type     List<DataReference>
Read Only    No
ThetaXY

Contains the ThetaXY value

Type     double
Read Only    No
ThetaXYUnit

Contains the unit of the ThetaXY

Type     string
Read Only    No
ThetaYZ

Contains the ThetaYZ value

Type     double
Read Only    No
ThetaYZUnit

Contains the unit of the ThetaYZ

Type     string
Read Only    No
ThetaZX

Contains the ThetaZX value

Type     double
Read Only    No
ThetaZXUnit

Contains the unit of the ThetaZX

Type     string
Read Only    No
TransformOriginal

Whether or not we are going to transform the first instance of the model

Type     bool
Read Only    No
UnitSystem

The unit system the user is using; the length unit is set based on this property

Type     string
Read Only    No

Methods

SetUnitSystem

Changes the Unit System on the FileDataProperty

Required Arguments

System    New Unit System for the FileDataProperty
    Type     string


Release 18.2 - © ANSYS, Inc. All rights reserved.