< Home

< Table of Contents

REFERENCE MANUAL

HPS.Exchange.File Class Reference

The File class provides functions to import and export CAD files via Exchange. More...

Public Types

enum  Format {
  Format.Unsupported = 0, Format.ACIS = 1, Format.CADDS = 2, Format.CATIAV4 = 3,
  Format.CATIAV5 = 4, Format.CGR = 5, Format.COLLADA = 6, Format.CreoProE = 7,
  Format.IDEAS = 8, Format.IFC = 9, Format.IGES = 10, Format.Inventor = 11,
  Format.JT = 12, Format.KeyholeMarkupLanguage = 13, Format.LatticeXVL = 14, Format.OneSpaceDesigner = 15,
  Format.Parasolid = 16, Format.PDF = 17, Format.PRC = 18, Format.Rhino = 19,
  Format.NXUnigraphics = 20, Format.SolidEdge = 21, Format.SolidWorks = 22, Format.STEP = 23,
  Format.StereoLithography = 24, Format.ThreeDStudioMax = 25, Format.ThreeDXML = 26, Format.Universal3D = 27,
  Format.VDAFS = 28, Format.VRML = 29, Format.WavefrontObject = 30
}
 Enumerates the formats Exchange can recognize. More...
 

Static Public Member Functions

static void ExportACIS (HPS.Exchange.CADModel in_cad_model, string in_file_name, HPS.Exchange.ExportACISOptionsKit in_options)
 Performs a synchronous ACIS export of the given CADModel with the provided options to a given filename. More...
 
static void ExportIGES (HPS.Exchange.CADModel in_cad_model, string in_file_name, HPS.Exchange.ExportIGESOptionsKit in_options)
 Performs a synchronous IGES export of the given CADModel with the provided options to a given filename. More...
 
static void ExportJT (HPS.Exchange.CADModel in_cad_model, string in_file_name, HPS.Exchange.ExportJTOptionsKit in_options)
 Performs a synchronous JT export of the given CADModel with the provided options to a given filename. More...
 
static void ExportParasolid (HPS.Exchange.CADModel in_cad_model, string in_file_name, HPS.Exchange.ExportParasolidOptionsKit in_options)
 Performs a synchronous Parasolid export of the given CADModel with the provided options to a given filename. More...
 
static void ExportPRC (HPS.Exchange.CADModel in_cad_model, string in_file_name, HPS.Exchange.ExportPRCOptionsKit in_options)
 Performs a synchronous PRC export of the given CADModel with the provided options to a given filename. More...
 
static void ExportSTEP (HPS.Exchange.CADModel in_cad_model, string in_file_name, HPS.Exchange.ExportSTEPOptionsKit in_options)
 Performs a synchronous STEP export of the given CADModel with the provided options to a given filename. More...
 
static void ExportSTL (HPS.Exchange.CADModel in_cad_model, string in_file_name, HPS.Exchange.ExportSTLOptionsKit in_options)
 Performs a synchronous STL export of the given CADModel with the provided options to a given filename. More...
 
static void ExportU3D (HPS.Exchange.CADModel in_cad_model, string in_file_name, HPS.Exchange.ExportU3DOptionsKit in_options)
 Performs a synchronous U3D export of the given CADModel with the provided options to a given filename. More...
 
static void ExportVRML (HPS.Exchange.CADModel in_cad_model, string in_file_name)
 Performs a synchronous VRML export of the given CADModel with the provided options to a given filename. More...
 
static void ExportXML (HPS.Exchange.CADModel in_cad_model, string in_file_name, HPS.Exchange.ExportXMLOptionsKit in_options)
 Performs a synchronous XML export of the given CADModel with the provided options to a given filename. More...
 
static HPS.Exchange.Configuration[] GetConfigurations (string in_file_name)
 Gets a list of configurations for the given file (if any). More...
 
static HPS.Exchange.File.Format GetFormat (string in_file_name)
 Gets the format for the given file as determined by Exchange. More...
 
static HPS.Exchange.ImportNotifier Import (string in_file_name, HPS.Exchange.ImportOptionsKit in_options)
 Performs an asynchronous import of the specified CAD file with the provided options. More...
 
static
HPS.Exchange.TranslationNotifier 
Translate (string in_file_name, HPS.Exchange.ImportOptionsKit in_options, HPS.Exchange.ExportParasolidOptionsKit in_parasolid_options)
 Asynchronously translates the specified CAD files into an array of Parasolid parts, using the options provided. More...
 

Detailed Description

The File class provides functions to import and export CAD files via Exchange.

Member Enumeration Documentation

Enumerates the formats Exchange can recognize.

Enumerator
Unsupported 

Format cannot be imported via Exchange.

ACIS 

ACIS file (A3DEModellerType::kA3DModellerAcis).

CADDS 

CADDS file (A3DEModellerType::kA3DModellerCadds).

This format requires the "From The Vault" libraries to import.

CATIAV4 

CATIA V4 file (A3DEModellerType::kA3DModellerCatia).

CATIAV5 

CATIA V5 file (A3DEModellerType::kA3DModellerCatiaV5).

CGR 

CATIA Graphical Represenation file (A3DEModellerType::kA3DModellerCgr).

COLLADA 

COLLADA (DAE) file (A3DEModellerType::kA3DModellerDAE).

This format requires the "From The Vault" libraries to import.

CreoProE 

Creo (Pro/E) file (A3DEModellerType::kA3DModellerProE).

IDEAS 

I-DEAS file (A3DEModellerType::kA3DModellerIdeas).

IFC 

Industry Foundation Classes (IFC) file (A3DEModellerType::kA3DModellerIFC).

IGES 

IGES file (A3DEModellerType::kA3DModellerIges).

Inventor 

Autodesk Inventor file (A3DEModellerType::kA3DModellerInventor).

JT 

JT file (A3DEModellerType::kA3DModellerJt).

KeyholeMarkupLanguage 

Keyhole Markup Language (KMZ) file (A3DEModellerType::kA3DModellerKMZ).

This format requires the "From The Vault" libraries.

LatticeXVL 

Lattice XVL file (A3DEModellerType::kA3DModellerXvl).

This format requires the "From The Vault" libraries to import.

OneSpaceDesigner 

OneSpace Designer file (A3DEModellerType::kA3DModellerOneSpaceDesigner).

This format requires the "From The Vault" libraries to import.

Parasolid 

Parasolid file (A3DEModellerType::kA3DModellerParasolid).

PDF 

PDF file (A3DEModellerType::kA3DModellerPDF).

PRC or U3D data stored inside the PDF can be imported.

PRC 

Product Representation Compact (PRC) file (A3DEModellerType::kA3DModellerPrc).

Rhino 

Rhinocerous 3D file (A3DEModellerType::kA3DModellerRhino).

NXUnigraphics 

NX (Unigraphics) file (A3DEModellerType::kA3DModellerUnigraphics).

SolidEdge 

Solid Edge file (A3DEModellerType::kA3DModellerSE).

SolidWorks 

SolidWorks file (A3DEModellerType::kA3DModellerSlw).

STEP 

STEP file (A3DEModellerType::kA3DModellerStep).

StereoLithography 

Stereo Lithography (STL) file (A3DEModellerType::kA3DModellerStl).

ThreeDStudioMax 

Autodesk 3D Studio Max file (A3DEModellerType::kA3DModeller3DS).

This format requires the "From The Vault" libraries to import.

ThreeDXML 

3DXML file (A3DEModellerType::kA3DModeller3dxml).

Universal3D 

Universal 3D (U3D) file (A3DEModellerType::kA3DModellerU3D).

VDAFS 

VDA-FS file (A3DEModellerType::kA3DModellerVda).

VRML 

VRML file (A3DEModellerType::kA3DModellerWrl).

WavefrontObject 

Wavefront Object (OBJ) file (A3DEModellerType::kA3DModellerOBJ).

This format requires the "From The Vault" libraries to import.

Member Function Documentation

static void HPS.Exchange.File.ExportACIS ( HPS.Exchange.CADModel  in_cad_model,
string  in_file_name,
HPS.Exchange.ExportACISOptionsKit  in_options 
)
static

Performs a synchronous ACIS export of the given CADModel with the provided options to a given filename.

An exception will be thrown if a problem is encountered during export.

Parameters
in_cad_modelThe <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> containing the data to export. This <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> must have come from a CAD file imported via <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref>, if it did not, the export will not succeed.
in_file_nameThe name of the file to write the ACIS data to.
in_optionsThe options controlling the export of the ACIS data.
static void HPS.Exchange.File.ExportIGES ( HPS.Exchange.CADModel  in_cad_model,
string  in_file_name,
HPS.Exchange.ExportIGESOptionsKit  in_options 
)
static

Performs a synchronous IGES export of the given CADModel with the provided options to a given filename.

An exception will be thrown if a problem is encountered during export.

Parameters
in_cad_modelThe <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> containing the data to export. This <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> must have come from a CAD file imported via <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref>, if it did not, the export will not succeed.
in_file_nameThe name of the file to write the IGES data to.
in_optionsThe options controlling the export of the IGES data.
static void HPS.Exchange.File.ExportJT ( HPS.Exchange.CADModel  in_cad_model,
string  in_file_name,
HPS.Exchange.ExportJTOptionsKit  in_options 
)
static

Performs a synchronous JT export of the given CADModel with the provided options to a given filename.

An exception will be thrown if a problem is encountered during export.

Parameters
in_cad_modelThe <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> containing the data to export. This <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> must have come from a CAD file imported via <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref>, if it did not, the export will not succeed.
in_file_nameThe name of the file to write the <ref refid="class_h_p_s_1_1_exchange_1_1_j_t" kindref="compound">JT</ref> data to.
in_optionsThe options controlling the export of the <ref refid="class_h_p_s_1_1_exchange_1_1_j_t" kindref="compound">JT</ref> data.
static void HPS.Exchange.File.ExportParasolid ( HPS.Exchange.CADModel  in_cad_model,
string  in_file_name,
HPS.Exchange.ExportParasolidOptionsKit  in_options 
)
static

Performs a synchronous Parasolid export of the given CADModel with the provided options to a given filename.

An exception will be thrown if a problem is encountered during export.

Parameters
in_cad_modelThe <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> containing the data to export. This <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> must have come from a CAD file imported via <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref>, if it did not, the export will not succeed.
in_file_nameThe name of the file to write the Parasolid data to.
in_optionsThe options controlling the export of the Parasolid data.
static void HPS.Exchange.File.ExportPRC ( HPS.Exchange.CADModel  in_cad_model,
string  in_file_name,
HPS.Exchange.ExportPRCOptionsKit  in_options 
)
static

Performs a synchronous PRC export of the given CADModel with the provided options to a given filename.

An exception will be thrown if a problem is encountered during export.

Parameters
in_cad_modelThe <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> containing the data to export. This <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> must have come from a CAD file imported via <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref>, if it did not, the export will not succeed.
in_file_nameThe name of the file to write the <ref refid="class_h_p_s_1_1_exchange_1_1_p_r_c" kindref="compound">PRC</ref> data to.
in_optionsThe options controlling the export of the <ref refid="class_h_p_s_1_1_exchange_1_1_p_r_c" kindref="compound">PRC</ref> data.
static void HPS.Exchange.File.ExportSTEP ( HPS.Exchange.CADModel  in_cad_model,
string  in_file_name,
HPS.Exchange.ExportSTEPOptionsKit  in_options 
)
static

Performs a synchronous STEP export of the given CADModel with the provided options to a given filename.

An exception will be thrown if a problem is encountered during export.

Parameters
in_cad_modelThe <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> containing the data to export. This <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> must have come from a CAD file imported via <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref>, if it did not, the export will not succeed.
in_file_nameThe name of the file to write the <ref refid="class_h_p_s_1_1_exchange_1_1_s_t_e_p" kindref="compound">STEP</ref> data to.
in_optionsThe options controlling the export of the <ref refid="class_h_p_s_1_1_exchange_1_1_s_t_e_p" kindref="compound">STEP</ref> data.
static void HPS.Exchange.File.ExportSTL ( HPS.Exchange.CADModel  in_cad_model,
string  in_file_name,
HPS.Exchange.ExportSTLOptionsKit  in_options 
)
static

Performs a synchronous STL export of the given CADModel with the provided options to a given filename.

An exception will be thrown if a problem is encountered during export.

Parameters
in_cad_modelThe <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> containing the data to export. This <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> must have come from a CAD file imported via <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref>, if it did not, the export will not succeed.
in_file_nameThe name of the file to write the STL data to.
in_optionsThe options controlling the export of the STL data.
static void HPS.Exchange.File.ExportU3D ( HPS.Exchange.CADModel  in_cad_model,
string  in_file_name,
HPS.Exchange.ExportU3DOptionsKit  in_options 
)
static

Performs a synchronous U3D export of the given CADModel with the provided options to a given filename.

An exception will be thrown if a problem is encountered during export.

Parameters
in_cad_modelThe <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> containing the data to export. This <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> must have come from a CAD file imported via <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref>, if it did not, the export will not succeed.
in_file_nameThe name of the file to write the <ref refid="class_h_p_s_1_1_exchange_1_1_u3_d" kindref="compound">U3D</ref> data to.
in_optionsThe options controlling the export of the <ref refid="class_h_p_s_1_1_exchange_1_1_u3_d" kindref="compound">U3D</ref> data.
static void HPS.Exchange.File.ExportVRML ( HPS.Exchange.CADModel  in_cad_model,
string  in_file_name 
)
static

Performs a synchronous VRML export of the given CADModel with the provided options to a given filename.

An exception will be thrown if a problem is encountered during export.

Parameters
in_cad_modelThe <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> containing the data to export. This <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> must have come from a CAD file imported via <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref>, if it did not, the export will not succeed.
in_file_nameThe name of the file to write the VRML data to.
static void HPS.Exchange.File.ExportXML ( HPS.Exchange.CADModel  in_cad_model,
string  in_file_name,
HPS.Exchange.ExportXMLOptionsKit  in_options 
)
static

Performs a synchronous XML export of the given CADModel with the provided options to a given filename.

An exception will be thrown if a problem is encountered during export.

Parameters
in_cad_modelThe <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> containing the data to export. This <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> must have come from a CAD file imported via <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref>, if it did not, the export will not succeed.
in_file_nameThe name of the file to write the XML data to.
in_optionsThe options controlling the export of the XML data.
static HPS.Exchange.Configuration [] HPS.Exchange.File.GetConfigurations ( string  in_file_name)
static

Gets a list of configurations for the given file (if any).

It should be called prior to Import if a file has configurations and the user wants or needs to specify the configuration to import and requires a list of the available configurations. If there are configurations, the function will return an array which has been populated with the list of configurations. If there are no configurations, the function will return an empty array. May throw an IOException if a problem is encountered when querying the configurations.

static HPS.Exchange.File.Format HPS.Exchange.File.GetFormat ( string  in_file_name)
static

Gets the format for the given file as determined by Exchange.

May throw an IOException if a problem is encountered when querying the format.

static HPS.Exchange.ImportNotifier HPS.Exchange.File.Import ( string  in_file_name,
HPS.Exchange.ImportOptionsKit  in_options 
)
static

Performs an asynchronous import of the specified CAD file with the provided options.

May throw an IOException prior to starting the asynchronous import.

Parameters
in_file_nameThe name of the CAD file to import.
in_optionsThe options controlling the import of the CAD file.
Returns
An ImportNotfier object that can be used to query the import progress and status.
static HPS.Exchange.TranslationNotifier HPS.Exchange.File.Translate ( string  in_file_name,
HPS.Exchange.ImportOptionsKit  in_options,
HPS.Exchange.ExportParasolidOptionsKit  in_parasolid_options 
)
static

Asynchronously translates the specified CAD files into an array of Parasolid parts, using the options provided.

A valid Parasolid session is required for this function to succeed.

Parameters
in_file_nameThe name of the CAD file to translate.
in_optionsThe options controlling the translation of the CAD file.
in_parasolid_optionsParasolid specific options used during the translation.
Returns
An TranslationNotifier object that can be used to query the import progress and status.

The documentation for this class was generated from the following file: