External Data

External Data
This container holds data to expose external results or data files 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

GetExternalLoadData

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

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

GetExternalLoadOutput

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 OBSOLETE PARAMETER; kept to provide compatability with older scripts Inserts the data files in the specified location in the internal list. It is 0-based.
Type int

InsertRegisteredFile

Adds a data file to the outline

Required Arguments

AllowDuplicates No details are provided for this entry.
Type bool
File The file
Type DataReference

InsertSupportFile

Inserts a support file to the associated FileData

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
FilePath The support file path
Type string

RereadDataFiles

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.

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

ExternalDataSetup

This is the DataObject which represents the data transfer provider for the External Data setup container.

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

ImportType

option that we copy the files or reference the files

Type string
Read Only No

TransferDataObject

The data transfer object provided by this provider

Type DataReference
Read Only No

ExternalLoadColumnData

This entity contains information about the column data

Properties

DataType

DataType of this column data

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

Identifier

Identifier of this column data. This will be used by the down stream applications

Type string
Read Only No

QuantityType

QuantityType of this column data

Type string
Read Only No

Unit

Unit of this column data

Type string
Read Only No

ExternalLoadData

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

Contains 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

GetExternalLoadFileData

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 ExternalLoadFileData entity
Type string

ExternalLoadFileData

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

Master

Makes the Data file as a Master or not. Only one Data file can be a Master.

Type bool
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.

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

SetAsMaster

Changes the Master property on the FileData

Required Arguments

Master controls the whether to make it as Master or not
Type bool

SetDelimiterCharacter

Changes the Delimited Character on the FileDataProperty

Required Arguments

Delimiter New Delimiter for the FileDataProperty
Type string
FileDataProperty FileDataProperty that needs to be modified
Type DataReference

SetDelimiterType

Changes the DelimiterType on the FileDataProperty

Required Arguments

Delimiter New DelimiterType for the FileDataProperty
Type DelimiterType
DelimiterString New Delimiter string for the FileDataProperty
Type string
FileDataProperty FileDataProperty that needs to be modified
Type DataReference

Example

    solution1.SetDelimiterType(
    FileData=fileData, 
    FileDataProperty=fileDataProperty,
    Delimiter=DelimiterType.Comma,
    DelimiterString=",")

SetDummyNetData

Sets the Material Field Data property

Required Arguments

FileDataProperty FileDataProperty that needs to be modified
Type DataReference
ImportDummyNetData New DelimiterType for the FileDataProperty
Type bool

SetFormatType

Changes the FormatType on the FileDataProperty

Required Arguments

FileDataProperty FileDataProperty that needs to be modified
Type DataReference
Type New Format Type for the FileDataProperty
Type FormatType

SetMaterialFieldData

Sets the Material Field Data property

Required Arguments

MaterialData New DelimiterType for the FileDataProperty
Type bool

SetStartImportAtLine

Changes the Start Import at Line on the FileDataProperty

Required Arguments

FileDataProperty FileDataProperty that needs to be modified
Type DataReference
LineNumber New LineNumber for the FileDataProperty
Type int

ExternalLoadFileDataOutput

This entity contains information about each supporting file

Properties

Dirty

Contains the reference to the FileDataProperty

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

File

FileReference maintained by the project

Type DataReference
Read Only No

FileDataProperty

Contains the reference to the FileDataProperty

Type DataReference
Read Only No

TranslationIdentifier

Contains the reference to the unique translation identifier

Type string
Read Only No

ExternalLoadFileDataProperty

Contains information displayed on the Properties pane

Properties

ColumnsData

Contains the list references to the Column Data

Type List<DataReference>
Read Only No

ConversionOption

Contains the option on how to convert the data

Type VariableConversionOption
Read Only No

CoordinateSystemType

Specifies whether to use the Cartesian or Cylindrical coordinate system. The default value is Cartesian

Type CoordinateSystemType
Read Only No

DelimiterCharacter

Contains the delimiter character. Based on this value, number of columns are calculated

Type string
Read Only No

DelimiterType

Contains either the predefined delimiter or the user defined delimiter type

Type DelimiterType
Read Only No

Dimensions

You can choose to either import data from 2D or 3D models. If the 2D option is selected, you will be able to import data only at the X and Y coordinates. The Z coordinate is not supported for the 2D option.

Type DimensionsType
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

DummyNetData

DummyNetData flag for trace mapping

Type bool
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

FormatString

Contains the FormatString. Based on this value, number of columns are calculated

Type string
Read Only No

FormatType

This can be either Delimited or User-Defined. If the value is Delimited - Delimiter Character field is valid If the value is User-Defined - FormatString field is valid

Type FormatType
Read Only No

LengthUnit

The units of measurement to be used.

Type string
Read Only No

MaterialFieldData

MaterialsData flag for EngineeringData

Type bool
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

ScaleX

Contains the Scale X string

Type string
Read Only No

ScaleXToolTip

Contains the tool tip of the Scale X

Type string
Read Only No

ScaleXValid

Contains the whether the Scale X string is valid or not

Type bool
Read Only No

ScaleY

Contains the Scale Y string

Type string
Read Only No

ScaleYToolTip

Contains the tool tip of the Scale Y

Type string
Read Only No

ScaleYValid

Contains the whether the Scale Y string is valid or not

Type bool
Read Only No

ScaleZ

Contains the Scale Z string

Type string
Read Only No

ScaleZToolTip

Contains the tool tip of the Scale Z

Type string
Read Only No

ScaleZValid

Contains the whether the Scale Z string is valid or not

Type bool
Read Only No

Sliver

Sliver Size for ECAD Files translation

Type double
Read Only No

StartImportAtLine

The line number at which you want the data import to start. Line numbers start at 1.

Type int
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

Methods

GetColumnData

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

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

Required Arguments

Name Name of the ExternalLoadColumnData entity
Type string

SetColumnDataType

Changes the column data type of the given ColumnData

Required Arguments

ColumnData ColumnData to be mofied
Type DataReference
DataType New DataType for the ColumnData
Type string

SetCoordinateSystemType

Changes the CoordinateSystem type in the FileDataProperty

Required Arguments

Type New Coordinate System Type for the FileDataProperty
Type CoordinateSystemType

SetDimensionLengthUnit

Changes the Data Type on the specified X,Y,Z coordinate

Required Arguments

Coordinate Coordinate X,Y,Z
Type string
Unit New Length Unit for the FileDataProperty
Type string

SetDimensionType

Changes the DimensionsType on the FileDataProperty

Required Arguments

Dimensions New DimensionsType for the FileDataProperty
Type DimensionsType

SetFormatString

Changes the FormatString on the FileDataProperty

Required Arguments

Format New Format string for the FileDataProperty
Type string

SetLengthUnit

Changes the Length Unit on the FileDataProperty

Required Arguments

Unit New Length Unit for the FileDataProperty
Type string

ExternalLoadSupportingFileData

This entity contains information about each supporting file

Properties

Description

Supporting file Description

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

Supporting file reference

Type DataReference
Read Only No

FileIdentifier

Supporting file identifier

Type string
Read Only No

FileType

Supporting file type

Type SupportFileFormatType
Read Only No