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
-
ReturnReturns the reference to the FileData object - Type DataReference
Required Arguments
- FilePath The data file path
- Type string
GetExternalModelData
Query to return the reference to the container's ExternalLoadData data entity.
-
ReturnA reference to the requested ExternalLoadData data entity. - Type DataReference
GetExternalModelOutput
Query to return the reference to the container's ExternalDataOutput data entity.
-
ReturnA reference to the requested ExternalLoadData data entity. - Type DataReference
InsertDataFile
Adds a data file to the outline
-
ReturnReturns the reference to the FileData object - Type DataReference
Required Arguments
InsertSupportFile
Inserts a support file to the associated FileData
-
ReturnReturns 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
ModifySupportFile
Updates a support file to the associated FileData
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.
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
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.
-
ReturnA 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
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
Output
Contains the reference to the Translated FileData output object
- Type DataReference
- Read Only No
Methods
GetDataProperty
Query to return the reference to the container's ExternalLoadFileDataProperty data entity.
-
ReturnA 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
ExternalModelFileDataOutput
Output data object for parsed/translated files
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
TranslationIdentifier
Contains the reference to the unique translation identifier
- Type string
- Read Only No
ExternalModelFileDataProperty
Contains information displayed on the Properties pane
Properties
CheckValidBlockedCdbFile
Check wether the given file is a valid CDB File. Default is true
- Type bool
- 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
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
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
ProcessMesh200FromCdb
Process Mesh200 elements from CDB File. Default is false
- Type bool
- Read Only No
ProcessModelData
Process Model Data like Coordinate Systems, Element Orientations etc. On by default
- Type bool
- Read Only No
SupportingFiles
Contains the list to all additional Supporting files
- Type List<DataReference>
- Read Only No
TransformationType
Which type of transform we should display to the user
- Type TransformType
- 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
SetApplicationSource
Set the application source for a FileData
Required Arguments
- ApplicationSource ApplicationSource for the FileDataProperty
- Type string
SetUnitSystem
Changes the Unit System on the FileDataProperty
Required Arguments
- System New Unit System for the FileDataProperty
- Type string
ExternalModelSupportingFileData
Entity to for any additionally linked files
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