InterOp:Connect/Options/Common Options Detailed

From DocR21

< InterOp:Connect/Options/Common Options

Note: If you specify an option without specifying <Component> (refer to Syntax), then this option will be ignored for those components on which this option is unavailable.

ConvertAnalyticalCurvesToSpline

Description: This option controls the translation of analytic curves as splines. Set this option to true to enable the translation of analytic curves as splines. If you set this option to false, analytic curves are translated as they are.

Default: false

ConvertAnalyticalSurfacesAndCurvesToSpline

Description: This option controls the translation of analytic surfaces and curves as splines. Set this option to true to enable the translation of analytic surfaces and curves as splines. If you set this option to false, analytic surfaces and curves are translated as they are.

Default: false

ConvertAnalyticalSurfacesToSpline

Description: This option controls the translation of analytic surfaces as splines. Set this option to true to enable the translation of analytic surface as splines. If you set this option to false, analytic surface are translated as they are.

Default: false

EnableMissingComponentsData

Description: This option ensures that information about missing parts and missing sub-assemblies when translating to XML E-BOM is given in the destination document. For example, if the part connecting_rod_bolt_nut.prt was missed during translation, then the Missing attribute is attached to it.

<Document Name="connecting_rod_bolt_nut" Type="prt" Identifier="E:\PROEAssembly\connecting_rod_bolt_nut.prt"
FilePath="E:\PROEAssembly\87818\connecting_rod_bolt_nut.prt" SourceUuid="connecting_rod_bolt_nut.prt" Missing="True" />

If the option is not set, then no information regarding the missing component is provided in the XML E-BOM file; thus, the XML file is written as if the missing component did not exist in the assembly).

Default: false

EnableWideCharacter

Description: This option controls transfer of string attributes. If you set this option to true, then all string-based attributes from the source system will be attached as Unicode into the target system. If you set this option to false, then all string-based attributes from the source system will be attached as MBCS into the target system.

Default: false

Healing

Description: This option controls the healing of topological data during the translation process. Set this option to true to enable healing. The input file for translation might contain bad data, which means that the translated file might possibly contain corrupted information. In addition, the geometrical or topological errors might occur during the translation process. To ensure precise and valid translation, Connect provides this option for repairing and healing the translated files. Repairing involves checking the translated file for corrupted data and fixing the invalid data. Healing corrects the differences in precision of source and entities.

Default: true

Operations Performed

The repairing process can be categorized as follows:

Tolerizing of Target Entities (edges and vertices) – Tolerance (precision) of the source entity might be coarser than the target kernel tolerance. This usually results in tolerance-related errors. Edges which perfectly connect at ends in the source system might show gaps in the target, or the vertices that lie on faces may give gap errors. To repair this error, tolerizing is performed on the entities. An appropriate tolerance is computed and applied to every edge and vertex of the body.
Healing of Entities – Healing of entities can be categorized into three types:
- Modification of topology of body – This process involves the removal of duplicate and overlapping vertices, removal of small edges, removal of sliver faces from the body, and splitting of edges having large G1 discontinuities in their pcurves. If the target system is Parasolid, then this involves removal of small edges, and removal of sliver faces from the body.
- Modification of geometry of body – This involves reconstruction of self-intersecting and irregular curve geometry of edges, co-edges, and surface geometry of faces, as well as the trimming and sub-setting of underlying surfaces of faces to a uv-box of a face. If the target system is Parasolid, then InterOp does not modify the geometry of the body under this option; however, the DeepHealing option does.
- Fixing of other invalid data in the body such as loop errors.

Errors Handled

The Healing option's purpose is to resolve the following errors:

PK_EDGE_state_bad_vertex_c
PK_FACE_state_bad_edge_c
PK_FACE_state_bad_vertex_c
PK_EDGE_state_vertices_touch_c
PK_FACE_state_self_int_c
PK_FACE_state_bad_loops_c

Effect on Performance

The process of healing affects the performance of the translator. The two main factors are:

Time – If healing is enabled, the total time for the translation process is increased. Hence, if you are not interested in fixing check errors, then disable healing to accelerate the translation process.
Quality – If healing is enabled, you improve the quality of the translated model. The healing process attempts to fix all the check errors and bad input data in the model as much as possible during the process.

PartTargetDocumentType

Description: This option controls the target document type when translating from any assembly format to XML-EBOM. By default, the part target document type is ACIS, hence the XML-EBOM Writer dumps part references as SAT files (output is XML+SAT). This option overrides the default behavior from XML+SAT to XML+X_T (or other) depending upon the option value.

For example, if PartTargetDocumentType is set to Generic, then the XML-EBOM Writer outputs to XML+X_T files.

The syntax for specifying this option is shown below. For example, to translate CATIA V5 assembly to XML-EBOM (that is, XML+X_T), you would specify the required option as follows:

EBOM.Assembly.Writer.CATIAV5.PartTargetDocumentType=Generic

Also, you may specify the option as follows:

EBOM.Assembly.Writer.*.PartTargetDocumentType=Generic

or

PartTargetDocumentType=Generic

Default: ACIS

RecordingSession

Description: This option specifies the session file for writing the session information. If this option is set to a session file, session information is written to the specified file. When this option is not set to any file, session recording is not performed during the translation process. For more information, refer to Session Recording.

Default: " " (Empty string)

Representation

Refer to Connect Representations for detailed information about the representation concept in InterOp.

The following table lists the Representations supported on InterOp components:


	BRep		Assembly		Visualization		Mesh		PMI		Manufacturing
	Reader	Writer	Reader	Writer	Reader	Writer	Reader	Writer	Reader	Writer	Reader	Writer
ACIS	Y	Y	Y	Y			Y	Y		Y		Y
CATIA V4	Y	Y	Y^**
CATIA V5	Y	Y	Y	Y	Y	Y	Y	Y	Y		Y
E-BOM			Y	Y
HSF				Y		Y
IGES	Y	Y	Y	Y
Inventor	Y		Y
Parasolid	Y	Y	Y	Y
Pro/E	Y		Y						Y		Y
SolidWorks	Y		Y
STEP	Y	Y	Y^*	Y^*
UG	Y		Y						Y
VDA-FS	Y	Y

^{* Not yet available for the Parasolid product line}

^{** Supports reading session files and ditto elements as assembly.}

Description: This option selects the model representation to translate. Valid values for this option include BRep, Assembly, Visualization, Mesh, PMI, and Manufacturing. You can combine the two different representations using a plus (+) sign, for example, BRep+Assembly.

Note: You are advised to use the BRep+Assembly representation for the components where it is not possible to determine whether the input file contains BRep or Assembly or both type of data. For example, you should use this combination for IGES, STEP, Parasolid, and Unigraphics components.

Note: The PMI and Manufacturing representations are associated together. Hence, if you set either of these representations, both are included for translation.

BRep – Boundary Representation. Manages topological and geometrical data.
Assembly – Product data representation. Manages the process of how parts are assembled to define a product.
Visualization – Manages the data (usually facets) that defines the visualization of a model.
Mesh – Collection of triangles that define a shape within the model.
PMI – Product Manufacturing Information. Manages text, annotations, dimensions, and tolerances.
Manufacturing – Manufacturing Features such as Hole data.

Default: " " (empty string)

SewSheetBodies

Description: This option controls the stitching of trimmed faces during the translation process. Set this option to true to stitch the trimmed faces. If you set this option to false, trimmed faces are translated as free faces.

Default: true

SewTolerance

Description: This option controls the tolerance level during the stitching of trimmed faces. Set this option to different tolerance levels through a set of pre-defined values: 1e-6, 0.0001, and 10.0.

Default: 0.0001

SplitAtG1Disc

Description: This option controls the splitting of Pcurves at G1 discontinuities. Set this option to true to split all the Pcurves at G1 discontinuities during translation. If this option is set to false, Pcurves at G1 discontinuities are not split during the translation.

Default: true

SplitPeriodic

Description: This option control the splitting of periodic faces while exporting data. Set this option to true to enable the splitting of periodic faces

Default: true

TranslateAssemblies

Description: This option controls the translation of Assemblies. Set this option to true to enable translation of assemblies and false to disable translation. In case of IGES, this option controls the translation of IGES sub-figure instance entities.

Default: true

TranslateAttributes

Description: This option controls attribute transfer during the translation process. Set this option to true to enable attribute transfer.

Default: false

TranslateFreeCurves

Description: This option controls the translation of free curves and wire bodies. Set this option to true to enable the translation of free curve data and wire bodies in the destination format.

Default: true

Note: For a STEP file, you can translate free curves using the following options:

TranslateFreePoints

Description: This option controls the translation of free point data. Set this option to true to indicate that InterOp is to read and translate free point data.

Default: true

TranslateFreeSurfaces

Description: This option controls the translation of free surface data. Set this option to true to indicate that InterOp is to read and translate free surface data.

Default: true

TranslateHiddenEntities

Description: This option controls the translation of NoShow or hidden entities. Set this option to true to indicate that InterOp is to convert the hidden entities during the translation process.; This option also applies to PMI entities. When set to true and if the representation is set to PMI, hidden PMI entities will also be converted during the translation process.

Default: false

TranslateLayersAndFilters

Description: This option controls the translation of layers and layer filters. Set this option to true to translate layers and layer filters. While converting to and from ACIS, this option provides an enhanced mechanism for handling layers and layer filters. Each layer, or layer filter is treated as an independent entity and converted to SPAGROUP in ACIS. SPAGROUP is a class provided in ACIS that can contain a collection of entities. An instance of the SPAGROUP class is created for each layer or layer filter. All entities belonging to a layer are added to the SPAGROUP corresponding to that layer and all SPAGROUPs representing layers of a layer filter are added to the SPAGROUP corresponding to that layer filter. Also, all the entities of a layer can be directly retrieved from the corresponding SPAGROUP entity. Properties such as name, number, current status of layer or layer filter are attached as attributes on respective SPAGROUPs.

Default: false

TranslateNoPicks

Description: This option controls reading NoPick entities. Set this option to true to enable reading NoPick entities.

Default: false

TranslateSelectionSets

Description: This option controls the translation of Selection sets. Set this option to true to enable the translation of Selection sets. While converting to and from ACIS, this provides an enhanced mechanism for selection sets. Each selection set is treated as an independent entity and converted to SPAGROUP in ACIS. SPAGROUP is a class provided in ACIS that can contain a collection of entities. An instance of the SPAGROUP class is created for each selection set. All entities belonging to a selection set are added to the SPAGROUP corresponding to that selection set. Also, all the entities of a selection set can be directly retrieved from the corresponding SPAGROUP entity. Properties such as name, number, and current status of selection set are attached as attributes on respective SPAGROUPs.

Default: false

TranslateSheetBodies

Description: This option controls the translation of sheet bodies. Set this option to true to indicate that InterOp is to read and translate all the sheet bodies to the destination format.

Default: true

TranslateSolidAsSheets

Description: This option controls whether to export a solid body as a sheet body. Set this option to true to enable translation of a solid body as a sheet body in the destination file format.

Default: false

TranslateSolidAsSolid

Description: This option controls whether to import a solid body as solid body. Set this option to true to translate solid bodies as solid bodies. If this option is set to false, solid bodies are translated as sheets.

Default: true

TranslateSolidAsWires

Description: This option controls whether to translate a solid body as a wire body. Set this option to true to enable translation of a solid body from the source system to a wire body in the destination system. Only the edges of the source solid are translated.

Default: false

TranslateSolidBodies

Description: This option controls whether to translate manifold solid B-Rep object data. Set this option to true to enable the translation of manifold solid B-Rep object data. If the option is set to false, solid bodies are not translated.

Default: true

TranslateSuppressedEntities

Description: This option controls the translation of the suppressed assembly components. Set this option to true to enable the translation of the suppressed assembly components. If this option is set to false, suppressed assembly components are not translated.

Default: false

TranslateWorkPlanes

Description: This option controls the translation of workplanes between the supported formats. Set this option to true to enable the translation of workplanes.

Default: true