< Home

< Table of Contents

REFERENCE MANUAL

Exchange::File Class Reference

#include <sprk_exchange.h>

Public Types

enum  Format {
  Format::Unsupported, Format::ACIS, Format::CADDS, Format::CATIAV4,
  Format::CATIAV5, Format::CGR, Format::COLLADA, Format::CreoProE,
  Format::IDEAS, Format::IFC, Format::IGES, Format::Inventor,
  Format::JT, Format::KeyholeMarkupLanguage, Format::LatticeXVL, Format::OneSpaceDesigner,
  Format::Parasolid, Format::PDF, Format::PRC, Format::Rhino,
  Format::NXUnigraphics, Format::SolidEdge, Format::SolidWorks, Format::STEP,
  Format::StereoLithography, Format::ThreeDStudioMax, Format::ThreeDXML, Format::Universal3D,
  Format::VDAFS, Format::VRML, Format::WavefrontObject
}
 

Static Public Member Functions

static void ExportACIS (CADModel const &in_cad_model, char const *in_file_name, ExportACISOptionsKit const &in_options)
 
static void ExportIGES (CADModel const &in_cad_model, char const *in_file_name, ExportIGESOptionsKit const &in_options)
 
static void ExportJT (CADModel const &in_cad_model, char const *in_file_name, ExportJTOptionsKit const &in_options)
 
static void ExportParasolid (CADModel const &in_cad_model, char const *in_file_name, ExportParasolidOptionsKit const &in_options)
 
static void ExportPRC (CADModel const &in_cad_model, char const *in_file_name, ExportPRCOptionsKit const &in_options)
 
static ExportNotifier ExportPRC (SprocketPath const &in_source, char const *in_file_name, bool in_compress_tessellation=false)
 
static ExportNotifier ExportPRC (SprocketPath const &in_source)
 
static void ExportSTEP (CADModel const &in_cad_model, char const *in_file_name, ExportSTEPOptionsKit const &in_options)
 
static void ExportSTL (CADModel const &in_cad_model, char const *in_file_name, ExportSTLOptionsKit const &in_options)
 
static void ExportU3D (CADModel const &in_cad_model, char const *in_file_name, ExportU3DOptionsKit const &in_options)
 
static void ExportVRML (CADModel const &in_cad_model, char const *in_file_name)
 
static void ExportXML (CADModel const &in_cad_model, char const *in_file_name, ExportXMLOptionsKit const &in_options)
 
static ConfigurationArray GetConfigurations (char const *in_file_name)
 
static Format GetFormat (char const *in_file_name)
 
static ImportNotifier Import (char const *in_file_name, ImportOptionsKit const &in_options)
 
static ImportNotifier Import (A3DAsmModelFile const *in_model_file, ModelFileImportOptionsKit const &in_options)
 
static TranslationNotifier Translate (char const *in_file_name, ImportOptionsKit const &in_options, ExportParasolidOptionsKit const &in_parasolid_options)
 

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 Exchange::File::ExportACIS ( CADModel const &  in_cad_model,
char const *  in_file_name,
ExportACISOptionsKit const &  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 CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, 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 Exchange::File::ExportIGES ( CADModel const &  in_cad_model,
char const *  in_file_name,
ExportIGESOptionsKit const &  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 CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, 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 Exchange::File::ExportJT ( CADModel const &  in_cad_model,
char const *  in_file_name,
ExportJTOptionsKit const &  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 CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, if it did not, the export will not succeed.
in_file_nameThe name of the file to write the JT data to.
in_optionsThe options controlling the export of the JT data.
static void Exchange::File::ExportParasolid ( CADModel const &  in_cad_model,
char const *  in_file_name,
ExportParasolidOptionsKit const &  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 CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, 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 Exchange::File::ExportPRC ( CADModel const &  in_cad_model,
char const *  in_file_name,
ExportPRCOptionsKit const &  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 CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, if it did not, the export will not succeed.
in_file_nameThe name of the file to write the PRC data to.
in_optionsThe options controlling the export of the PRC data.
static ExportNotifier Exchange::File::ExportPRC ( SprocketPath const &  in_source,
char const *  in_file_name,
bool  in_compress_tessellation = false 
)
static

Performs an asynchronous PRC export from an A3DAsmModelFile created from a SprocketPath.

Parameters
in_sourceThe SprocketPath containing the data to export. The geometry and segments under this SprocketPath will be used to create the A3DAsmModelFile to export as PRC.
in_file_nameThe name of the file to write the PRC data to.
in_compress_tessellationWhether to compress the tessellation data in the PRC data. Defaults to false.
Returns
An ExportNotfier object that can be used to query the export progress and status.
static ExportNotifier Exchange::File::ExportPRC ( SprocketPath const &  in_source)
static

Performs an asynchronous creation of an A3DAsmModelFile from a SprocketPath.

Parameters
in_sourceThe SprocketPath containing the data to export. The geometry and segments under this SprocketPath will be used to create the A3DAsmModelFile.
Returns
An ExportNotfier object that can be used to query the export progress and status.
static void Exchange::File::ExportSTEP ( CADModel const &  in_cad_model,
char const *  in_file_name,
ExportSTEPOptionsKit const &  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 CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, if it did not, the export will not succeed.
in_file_nameThe name of the file to write the STEP data to.
in_optionsThe options controlling the export of the STEP data.
static void Exchange::File::ExportSTL ( CADModel const &  in_cad_model,
char const *  in_file_name,
ExportSTLOptionsKit const &  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 CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, 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 Exchange::File::ExportU3D ( CADModel const &  in_cad_model,
char const *  in_file_name,
ExportU3DOptionsKit const &  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 CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, if it did not, the export will not succeed.
in_file_nameThe name of the file to write the U3D data to.
in_optionsThe options controlling the export of the U3D data.
static void Exchange::File::ExportVRML ( CADModel const &  in_cad_model,
char const *  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 CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, if it did not, the export will not succeed.
in_file_nameThe name of the file to write the VRML data to.
static void Exchange::File::ExportXML ( CADModel const &  in_cad_model,
char const *  in_file_name,
ExportXMLOptionsKit const &  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 CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, 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 ConfigurationArray Exchange::File::GetConfigurations ( char const *  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 Format Exchange::File::GetFormat ( char const *  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 ImportNotifier Exchange::File::Import ( char const *  in_file_name,
ImportOptionsKit const &  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. Note that if the import is successful, the CADModel created from this import will own its associated A3DAsmModelFile (see Exchange::CADModel::GetEntityOwnership for more details).

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 ImportNotifier Exchange::File::Import ( A3DAsmModelFile const *  in_model_file,
ModelFileImportOptionsKit const &  in_options 
)
static

Performs an asynchronous import of the specified A3DAsmModelFile with the provided options. May throw an IOException prior to starting the asynchronous import. Note that if the import is successful, the CADModel created from this import will not own its associated A3DAsmModelFile (see Exchange::CADModel::GetEntityOwnership for more details).

Parameters
in_file_nameThe name of the CAD file to import.
in_optionsThe options controlling the import of the CAD file. Whether these options will have any effect depends on how the A3DAsmModelFile was created.
Returns
An ImportNotfier object that can be used to query the import progress and status.
static TranslationNotifier Exchange::File::Translate ( char const *  in_file_name,
ImportOptionsKit const &  in_options,
ExportParasolidOptionsKit const &  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: