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

#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::DWG, Format::DXF, 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 }
	Enumerates the formats Exchange can recognize. More...

Static Public Member Functions
static Format	GetFormat (char const *in_file_name)
	Gets the format for the given file as determined by Exchange. More...

static ConfigurationArray	GetConfigurations (char const *in_file_name)
	Gets a list of configurations for the given file (if any). More...

static void	GetInformation (const char *in_file_name, Format &out_format, UTF8 &out_model_name, UTF8 &out_version, UTF8 &out_author, UTF8 &out_organization, UTF8 &out_time_stamp)
	Returns information associated with the given file as determined by Exchange, without performing a full conversion. More...

static HPS::ImageKit	GetThumbnailImage (const char *in_file_name)
	Returns the thumbnail image associated with the given file as determined by Exchange, if any. More...

static ImportNotifier	Import (char const *in_file_name, ImportOptionsKit const &in_options)
	Performs an asynchronous import of the specified CAD file with the provided options. More...

static ImportNotifier	Import (A3DAsmModelFile const *in_model_file, ModelFileImportOptionsKit const &in_options)
	Performs an asynchronous import of the specified A3DAsmModelFile with the provided options. More...

static ImportNotifier	Import (size_t in_byte_count, byte const in_prc_data[], ModelFileImportOptionsKit const &in_options)
	Performs an asynchronous import of the specified PRC data with the provided options. More...

static ImportNotifier	Import (ByteArray const &in_prc_data, ModelFileImportOptionsKit const &in_options)
	Performs an asynchronous import of the specified PRC data with the provided options. More...

static TranslationNotifier	Translate (char const *in_file_name, ImportOptionsKit const &in_options, TranslationOptionsKit const &in_translation_options)
	Asynchronously translates the specified CAD files into an array of Parasolid parts, using the options provided. More...

static ExportNotifier	Export3MF (CADModel const &in_cad_model, char const *in_file_name, Export3MFOptionsKit const &in_options)
	Performs an asynchronous 3MF export of the given CADModel with the provided options to a given filename. More...

static ExportNotifier	Export3MF (KeyPathArray const &in_source, char const *in_file_name, Export3MFOptionsKit const &in_options)
	Performs an asynchronous 3MF export of the given CADModel with the provided options to a given filename. More...

static ExportNotifier	Export3MF (size_t in_count, KeyPath const in_source[], char const *in_file_name, Export3MFOptionsKit const &in_options)
	Performs an asynchronous 3MF export of the given CADModel with the provided options to a given filename. More...

static ExportNotifier	Export3MF (KeyPath in_source, char const *in_file_name, Export3MFOptionsKit const &in_options)
	Performs an asynchronous 3MF export of the given CADModel with the provided options to a given filename. More...

static void	ExportACIS (CADModel const &in_cad_model, char const *in_file_name, ExportACISOptionsKit const &in_options)
	Performs a synchronous ACIS export of the given CADModel with the provided options to a given filename. More...

static void	ExportJT (CADModel const &in_cad_model, char const *in_file_name, ExportJTOptionsKit const &in_options)
	Performs a synchronous JT export of the given CADModel with the provided options to a given filename. More...

static ExportNotifier	ExportPRC (CADModel const &in_cad_model, char const *in_file_name, ExportPRCOptionsKit const &in_options)
	Performs an asynchronous PRC export of the given CADModel with the provided options to a given filename. More...

static ExportNotifier	ExportPRC (KeyPathArray const &in_source, char const *in_file_name, bool in_compress_tessellation=false)
	Performs an asynchronous PRC export from an A3DAsmModelFile created from a KeyPathArray. More...

static ExportNotifier	ExportPRC (size_t in_count, KeyPath const in_source [], char const *in_file_name, bool in_compress_tessellation=false)
	Performs an asynchronous PRC export from an A3DAsmModelFile created from a KeyPathArray. More...

static ExportNotifier	ExportPRC (KeyPath const &in_source, char const *in_file_name, bool in_compress_tessellation=false)
	Performs an asynchronous PRC export from an A3DAsmModelFile created from a KeyPath. More...

static ExportNotifier	ExportPRC (KeyPathArray const &in_source)
	Performs an asynchronous creation of an A3DAsmModelFile from a KeyPathArray. More...

static ExportNotifier	ExportPRC (size_t in_count, KeyPath const in_source [])
	Performs an asynchronous creation of an A3DAsmModelFile from a KeyPathArray. More...

static ExportNotifier	ExportPRC (KeyPath const &in_source)
	Performs an asynchronous creation of an A3DAsmModelFile from a KeyPath. More...

static void	ExportSTL (CADModel const &in_cad_model, char const *in_file_name, ExportSTLOptionsKit const &in_options)
	Performs a synchronous STL export of the given CADModel with the provided options to a given filename. More...

static void	ExportU3D (CADModel const &in_cad_model, char const *in_file_name, ExportU3DOptionsKit const &in_options)
	Performs a synchronous U3D export of the given CADModel with the provided options to a given filename. More...

static void	ExportVRML (CADModel const &in_cad_model, char const *in_file_name)
	Performs a synchronous VRML export of the given CADModel with the provided options to a given filename. More...

static void	ExportXML (CADModel const &in_cad_model, char const *in_file_name, ExportXMLOptionsKit const &in_options)
	Performs a synchronous XML export of the given CADModel with the provided options to a given filename. More...

static void	ExportIGES (CADModel const &in_cad_model, char const *in_file_name, ExportIGESOptionsKit const &in_options)
	Performs a synchronous IGES export of the given CADModel with the provided options to a given filename. More...

static void	ExportParasolid (CADModel const &in_cad_model, char const *in_file_name, ExportParasolidOptionsKit const &in_options)
	Performs a synchronous Parasolid export of the given CADModel with the provided options to a given filename. More...

static void	ExportSTEP (CADModel const &in_cad_model, char const *in_file_name, ExportSTEPOptionsKit const &in_options)
	Performs a synchronous STEP export of the given CADModel with the provided options to a given filename. More...

Private Member Functions
	File ()
	Private default constructor to prevent instantiation. More...

Detailed Description

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

Member Enumeration Documentation

◆ Format

enum HPS::Exchange::File::Format

strong

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).
DWG	DWG file (A3DEModellerType::kA3DModellerDWG).
DXF	Dxf file (A3DEModellerType::kA3DModellerDxf).
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.

Constructor & Destructor Documentation

◆ File()

HPS::Exchange::File::File ( )

private

Private default constructor to prevent instantiation.

Member Function Documentation

◆ Export3MF() [1/4]

static ExportNotifier HPS::Exchange::File::Export3MF	(	CADModel const &	in_cad_model,
		char const *	in_file_name,
		Export3MFOptionsKit const &	in_options
	)

static

Performs an asynchronous 3MF 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_model	The 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_name	The name of the file to write the 3MF data to.
in_options	The options controlling the export of the 3MF data.

◆ Export3MF() [2/4]

static ExportNotifier HPS::Exchange::File::Export3MF	(	KeyPathArray const &	in_source,
		char const *	in_file_name,
		Export3MFOptionsKit const &	in_options
	)

static

Performs an asynchronous 3MF 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_source	An array of key paths containing the data to export. The geometry and segments under these key paths will be used to create the A3DAsmModelFile to export as 3MF.
in_file_name	The name of the file to write the 3MF data to.
in_options	The options controlling the export of the 3MF data.

Returns: An ExportNotfier object that can be used to query the export progress and status.

◆ Export3MF() [3/4]

static ExportNotifier HPS::Exchange::File::Export3MF	(	size_t	in_count,
		KeyPath const	in_source[],
		char const *	in_file_name,
		Export3MFOptionsKit const &	in_options
	)

static

Performs an asynchronous 3MF 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_count	The number of key paths stored in in_source.
in_source	An array of key paths containing the data to export. The geometry and segments under these key paths will be used to create the A3DAsmModelFile to export as 3MF.
in_file_name	The name of the file to write the 3MF data to.
in_options	The options controlling the export of the 3MF data.

Returns: An ExportNotfier object that can be used to query the export progress and status.

◆ Export3MF() [4/4]

static ExportNotifier HPS::Exchange::File::Export3MF	(	KeyPath	in_source,
		char const *	in_file_name,
		Export3MFOptionsKit const &	in_options
	)

static

Performs an asynchronous 3MF 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_source	A key path containing the data to export. The geometry and segments under this key path will be used to create the A3DAsmModelFile to export as 3MF.
in_file_name	The name of the file to write the 3MF data to.
in_options	The options controlling the export of the 3MF data.

Returns: An ExportNotfier object that can be used to query the export progress and status.

◆ ExportACIS()

static void HPS::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_model	The 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_name	The name of the file to write the ACIS data to.
in_options	The options controlling the export of the ACIS data.

◆ ExportIGES()

static void HPS::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_model	The 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_name	The name of the file to write the IGES data to.
in_options	The options controlling the export of the IGES data.

◆ ExportJT()

static void HPS::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_model	The 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_name	The name of the file to write the JT data to.
in_options	The options controlling the export of the JT data.

◆ ExportParasolid()

static void HPS::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_model	The 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_name	The name of the file to write the Parasolid data to.
in_options	The options controlling the export of the Parasolid data.

◆ ExportPRC() [1/7]

static ExportNotifier HPS::Exchange::File::ExportPRC	(	CADModel const &	in_cad_model,
		char const *	in_file_name,
		ExportPRCOptionsKit const &	in_options
	)

static

Performs an asynchronous 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_model	The 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_name	The name of the file to write the PRC data to.
in_options	The options controlling the export of the PRC data.

Returns: An ExportNotfier object that can be used to query the export progress and status.

◆ ExportPRC() [2/7]

static ExportNotifier HPS::Exchange::File::ExportPRC	(	KeyPathArray 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 KeyPathArray.

Parameters

in_source	An array of key paths containing the data to export. The geometry and segments under these key paths will be used to create the A3DAsmModelFile to export as PRC.
in_file_name	The name of the file to write the PRC data to.
in_compress_tessellation	Whether 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.

◆ ExportPRC() [3/7]

static ExportNotifier HPS::Exchange::File::ExportPRC	(	size_t	in_count,
		KeyPath 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 KeyPathArray.

Parameters

in_count	The size of in_source
in_source	An array of key paths containing the data to export. The geometry and segments under these key paths will be used to create the A3DAsmModelFile to export as PRC.
in_file_name	The name of the file to write the PRC data to.
in_compress_tessellation	Whether 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.

◆ ExportPRC() [4/7]

static ExportNotifier HPS::Exchange::File::ExportPRC	(	KeyPath 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 KeyPath.

Parameters

in_count	The size of in_source
in_source	An array of key paths containing the data to export. The geometry and segments under these key paths will be used to create the A3DAsmModelFile to export as PRC.
in_file_name	The name of the file to write the PRC data to.
in_compress_tessellation	Whether 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.

◆ ExportPRC() [5/7]

static ExportNotifier HPS::Exchange::File::ExportPRC ( KeyPathArray const & in_source )

static

Performs an asynchronous creation of an A3DAsmModelFile from a KeyPathArray.

Parameters

in_source An array of key paths containing the data to export. The geometry and segments under these key paths will be used to create the A3DAsmModelFile.

Returns: An ExportNotfier object that can be used to query the export progress and status.

◆ ExportPRC() [6/7]

static ExportNotifier HPS::Exchange::File::ExportPRC	(	size_t	in_count,
		KeyPath const	in_source[]
	)

static

Performs an asynchronous creation of an A3DAsmModelFile from a KeyPathArray.

Parameters

in_count	The size of in_source
in_source	An array of key paths containing the data to export. The geometry and segments under these key paths will be used to create the A3DAsmModelFile.

Returns: An ExportNotfier object that can be used to query the export progress and status.

◆ ExportPRC() [7/7]

static ExportNotifier HPS::Exchange::File::ExportPRC ( KeyPath const & in_source )

static

Performs an asynchronous creation of an A3DAsmModelFile from a KeyPath.

Parameters

in_source A key path containing the data to export. The geometry and segments under these key paths will be used to create the A3DAsmModelFile.

Returns: An ExportNotfier object that can be used to query the export progress and status.

◆ ExportSTEP()

static void HPS::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_model	The 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_name	The name of the file to write the STEP data to.
in_options	The options controlling the export of the STEP data.

◆ ExportSTL()

static void HPS::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_model	The 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_name	The name of the file to write the STL data to.
in_options	The options controlling the export of the STL data.

◆ ExportU3D()

static void HPS::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_model	The 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_name	The name of the file to write the U3D data to.
in_options	The options controlling the export of the U3D data.

◆ ExportVRML()

static void HPS::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_model	The 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_name	The name of the file to write the VRML data to.

◆ ExportXML()

static void HPS::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_model	The 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_name	The name of the file to write the XML data to.
in_options	The options controlling the export of the XML data.

◆ GetConfigurations()

static ConfigurationArray HPS::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.

◆ GetFormat()

static Format HPS::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.

◆ GetInformation()

static void HPS::Exchange::File::GetInformation	(	const char *	in_file_name,
		Format &	out_format,
		UTF8 &	out_model_name,
		UTF8 &	out_version,
		UTF8 &	out_author,
		UTF8 &	out_organization,
		UTF8 &	out_time_stamp
	)

static

Returns information associated with the given file as determined by Exchange, without performing a full conversion.

CatiaV5 and Solidworks are the only formats currently supported. May thrown an IOException if a problem is encountered. Some of the fields returned may be empty.

Parameters

in_file_name	The file to query
out_format	The format of the file
out_model_name	The name of the model contained in the file
out_version	The software release version
out_author	The file author
out_organization	The organization associated with the file
out_time_stamp	The time stamp

◆ GetThumbnailImage()

static HPS::ImageKit HPS::Exchange::File::GetThumbnailImage ( const char * in_file_name )

static

Returns the thumbnail image associated with the given file as determined by Exchange, if any.

CatiaV5 and Solidworks are the only formats currently supported. May thrown an IOException if a problem is encountered.

Parameters

in_file_name The file to query

Returns: An ImageKit containing the thumbnail

◆ Import() [1/4]

static ImportNotifier HPS::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_name	The name of the CAD file to import.
in_options	The options controlling the import of the CAD file.

Returns: An ImportNotfier object that can be used to query the import progress and status.

◆ Import() [2/4]

static ImportNotifier HPS::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_model_file	The A3DAsmModelFile to import.
in_options	The 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.

◆ Import() [3/4]

static ImportNotifier HPS::Exchange::File::Import	(	size_t	in_byte_count,
		byte const	in_prc_data[],
		ModelFileImportOptionsKit const &	in_options
	)

static

Performs an asynchronous import of the specified PRC data 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_byte_count	Size of the following array.
in_prc_data	Buffer of PRC data to import.
in_options	The options controlling the import of the CAD file. Whether these options will have any effect depends on what is contained in the PRC data.

Returns: An ImportNotfier object that can be used to query the import progress and status.

◆ Import() [4/4]

static ImportNotifier HPS::Exchange::File::Import	(	ByteArray const &	in_prc_data,
		ModelFileImportOptionsKit const &	in_options
	)

static

Performs an asynchronous import of the specified PRC data 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_prc_data	Buffer of PRC data to import.
in_options	The options controlling the import of the CAD file. Whether these options will have any effect depends on what is contained in the PRC data.

Returns: An ImportNotfier object that can be used to query the import progress and status.

◆ Translate()

static TranslationNotifier HPS::Exchange::File::Translate	(	char const *	in_file_name,
		ImportOptionsKit const &	in_options,
		TranslationOptionsKit const &	in_translation_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_name	The name of the CAD file to translate.
in_options	The options controlling the translation of the CAD file.
in_translation_options	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:

sprk_exchange.h

Public Types

Static Public Member Functions

Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ Format

Constructor & Destructor Documentation

◆ File()

Member Function Documentation

◆ Export3MF() [1/4]

◆ Export3MF() [2/4]

◆ Export3MF() [3/4]

◆ Export3MF() [4/4]

◆ ExportACIS()

◆ ExportIGES()

◆ ExportJT()

◆ ExportParasolid()

◆ ExportPRC() [1/7]

◆ ExportPRC() [2/7]

◆ ExportPRC() [3/7]

◆ ExportPRC() [4/7]

◆ ExportPRC() [5/7]

◆ ExportPRC() [6/7]

◆ ExportPRC() [7/7]

◆ ExportSTEP()

◆ ExportSTL()

◆ ExportU3D()

◆ ExportVRML()

◆ ExportXML()

◆ GetConfigurations()

◆ GetFormat()

◆ GetInformation()

◆ GetThumbnailImage()

◆ Import() [1/4]

◆ Import() [2/4]

◆ Import() [3/4]

◆ Import() [4/4]

◆ Translate()