All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPCBoardUseItf CATPcbImportExportMode

Usage: you must use this class as is. You should never derive it.

public class CATPcbImportExportMode

Class to Get/Set Export/Import information.

Role: To provide services to set and get various settings for Importing and Exporting IDF files. Following settings could be set and retrieve using this class:
IDF file location : Refer and methods.
IDF file Name : Refer and methods.
LIB file location: Refer and methods.
LIB file Name : Refer and methods.
CSV file location & Name : Refer and methods.
CSV file location & Name : Refer and methods.
Component datasource : Refer and methods.
Hole drill option : Refer and methods.
PLM document attachment option : Refer and methods.
PLM document vesioning option : Refer and methods.
PLM Document creation type : Refer and methods.
Exported file co-ordinate unit : Refer and methods.
Exported IDF verison : Refer and methods.
Decimal used for exported IDF file : Refer and methods.

Constructor and Destructor Index

o CATPcbImportExportMode(): Constructs CATPcbImportExportMode object.
o ~CATPcbImportExportMode(): Destructs CATPcbImportExportMode object.

Method Index

o GetCSVFile(CATUnicodeString*): Gets CSV file name.
o GetCSVFileMode(ImportExportMode*): Gets the CSV file Export/Import Mode.
o GetComponentCatalogFileName(CATUnicodeString*): Gets Component Catalog File Name file name.
o GetComponentDataSource(ComponentDataSource*): Gets Component data source for IDF Import.
o GetDecimalSeparator(CATUnicodeString*): Gets decimal separator to be used in IDF file to export
Role:
o GetExportUnit(CATUnicodeString*): Gets unit for the IDF file to export
Role:
o GetExportedFileVersion(int*): Gets version of IDF file to export
Role:
o GetFileName(CATUnicodeString*): Gets IDF file name
Role: This method is used to get IDF file name for Import/Export.
o GetIDFImportExportMode(ImportExportMode*): Gets the IDF ImportExport Mode.
o GetImportDrillHolesMode(HoleOptions*): Gets holes import mode.
o GetLibName(CATUnicodeString*): Gets component library file name.
o GetLibraryImportExportMode(ImportExportMode*): Gets the component Library Import Mode.
o GetPLMDocumentAttachmentOption(PLMDocumentAttachment*): Gets PLM Document Attachment option for IDF export.
o GetPLMDocumentCreationTypeOption(PLMDocumentCreationType*): Gets creation type of IDF exported as PLM Document.
o GetPLMDocumentVersioningOption(PLMDocumentVersioning*): Gets Versioning option for board assembly Export to PLM Document.
o SetCSVFile(CATUnicodeString): Sets CSV file name.
o SetCSVFileMode(ImportExportMode): Sets the CSV file Export/Import Mode.
o SetComponentCatalogFileName(CATUnicodeString): Sets Component Catalog File Name file name.
o SetComponentDataSource(ComponentDataSource): Sets Component data source for IDF Import.
o SetDecimalSeparator(CATUnicodeString): Sets decimal separator to be used in IDF file to export
Role:
o SetExportUnit(CATUnicodeString): Sets unit for the IDF file to export
Role:
o SetExportedFileVersion(int): Sets version of IDF file to export
Role:
o SetFileName(CATUnicodeString): Sets IDF file name
Role: This method is used to set IDF file name for Import/Export.
o SetIDFImportExportMode(ImportExportMode): Sets the IDF ImportExport Mode.
o SetImportDrillHolesMode(HoleOptions): Sets holes import mode.
o SetLibName(CATUnicodeString): Sets component library file name.
o SetLibraryImportExportMode(ImportExportMode): Sets the component Library Import Mode.
o SetPLMDocumentAttachmentOption(PLMDocumentAttachment): Sets PLM Document Attachment option for IDF export.
o SetPLMDocumentCreationTypeOption(PLMDocumentCreationType): Sets creation type of IDF exported as PLM Document.
o SetPLMDocumentVersioningOption(PLMDocumentVersioning): Sets Versioning option for board assembly Export to PLM Document.

o ComponentDataSource: Component data source for IDF import.
o HoleOptions: Hole drilling option for IDF Import.
o ImportExportMode: IDF Import/Export mode.
o PLMDocumentAttachment: IDF Exported as PLM document attachment option.
o PLMDocumentCreationType: IDF Exported as PLM document creation mode.
o PLMDocumentVersioning: IDF Exported as PLM document versioning option when existing PLM document is to be updated.

Constructor and Destructor

o CATPcbImportExportMode

public CATPcbImportExportMode(

)

Constructs CATPcbImportExportMode object.
Role:

o ~CATPcbImportExportMode

public ~CATPcbImportExportMode(

)

Destructs CATPcbImportExportMode object.
Role:

Methods

o GetCSVFile

public GetCSVFile( oCSVfileName)

Gets CSV file name.
Role: This method is used to get CSV file name for Import/Export of Board assembly.

Parameters:

oCSVfileName: The name of the CSV file.

Returns:

An HRESULT value.
Legal values:

S_OK: CSV file Name retrieved successfully
E_FAIL: CSV file Name could not be retrieved

o GetCSVFileMode

public GetCSVFileMode( oCSVImportExportMode)

Gets the CSV file Export/Import Mode.
Role: This method is used to get CSV file location mode for Board Import/Export.

Parameters:

oCSVImportExportMode

CSV file location mode
Legal values:

FILEBASEMODE: CSV File location for is local directory
PLMDOCUMENTMODE: CSV File location is database;CSV file is PLM Document

Returns:

An HRESULT value.
Legal values:

S_OK: CSV file location found
E_FAIL: CSV file location not found

o GetComponentCatalogFileName

public GetComponentCatalogFileName( oCompCatalogfileName)

Gets Component Catalog File Name file name.
Role: This method is used to get Component catalog file name for Importing Board assembly.

Parameters:

oCompCatalogfileName: The name of the component catalog file.

Returns:

An HRESULT value.
Legal values:

S_OK: Component catalog file Name retrieved successfully
E_FAIL: Component catalog file Name could not be retrieved

o GetComponentDataSource

public GetComponentDataSource( oCompDataSource)

Gets Component data source for IDF Import.
Role: This method is used to get component data source for IDF import. This method succeeds when component datasource is either NONE or DATABASE

Parameters:

oCompDataSource

Component data source
Legal values:

NONE: Component geometry is not searched
DATABASE: Component should be searched in database
CATALOG: Component should be searched in database

Returns:

An HRESULT value.
Legal values:

S_OK: Component Datasource found successfully.
E_FAIL: Component Datasource cound not be found

o GetDecimalSeparator

public GetDecimalSeparator( oUserDefinedDecimalValue)

Gets decimal separator to be used in IDF file to export
Role:

Returns:

decimal separator used in IDF file to export
Legal values:

.: dot
,: comma

Returns:

An HRESULT value.
Legal values:

S_OK: IDF export Decimal Separator retrieved successfully
E_FAIL: IDF export Decimal Separator retrieval failed

o GetExportUnit

public GetExportUnit( oExportedUnit)

Gets unit for the IDF file to export
Role:

Parameters:

oExportedUnit

Unit for IDF file to export
Legal values:

MM: Unit of exported co-ordinates is millimeter
THOU: Unit of exported co-ordinates is thou

Returns:

An HRESULT value.
Legal values:

S_OK: Export Unit retrieved successfully
E_FAIL: Export Unit retrieval failed

o GetExportedFileVersion

public GetExportedFileVersion( oUnit)

Gets version of IDF file to export
Role:

Parameters:

oUnit

version of IDF file to export
Legal values:

2: Version of IDF file to export is IDF2.0
3: Version of IDF file to export is IDF3.0

Returns:

An HRESULT value.
Legal values:

S_OK: Exported IDF version retrieved successfully
E_FAIL: Exported IDF version retrieval failed

o GetFileName

public GetFileName( oFileName)

Gets IDF file name
Role: This method is used to get IDF file name for Import/Export.

Parameters:

oFileName: The name of the IDF file.

Returns:

An HRESULT value.
Legal values:

S_OK: IDF file Name retrieved successfully
E_FAIL: IDF file Name could not be retrieved

o GetIDFImportExportMode

public GetIDFImportExportMode( oIDFImportExportMode)

Gets the IDF ImportExport Mode.
Role: This method is used to get mode of IDF file Export/Import.Mode defines the location of IDF File.

Parameters:

oIDFImportExportMode

IDF file location for Export/Import.
Legal values:

FILEBASEMODE: IDF File location for export/import is local directory
DESIGNERCENTRALMODE: IDF File location for export/import is design central; IDF file is versioned document
PLMDOCUMENTMODE: IDF File location is for export/import is database;IDF file is PLM Document

Returns:

An HRESULT value.
Legal values:

S_OK: IDF file location found
E_FAIL: IDF file location not found

o GetImportDrillHolesMode

public GetImportDrillHolesMode( oDrilledHolesMode)

Gets holes import mode.
Role: This method is used to get holes import mode for IDF import.

Parameters:

oDrilledHolesMode

Hole import mode
Legal values:

DRILLED: Hole imported should be drilled
NOTDRILLED: Hole imported should NOT be drilled. Only representation are drawn i.e. CBDHoles are created

Returns:

An HRESULT value.
Legal values:

S_OK: Hole Drill mode retrieved successfully
E_FAIL: Hole Drill mode retrieval failed

o GetLibName

public GetLibName( oLIBFileName)

Gets component library file name.
Role: This method is used to get component library file name for Import.

Parameters:

oLIBFileName: The name of the LIB file.

Returns:

An HRESULT value.
Legal values:

S_OK: IDF file Name retrieved successfully
E_FAIL: IDF file Name could not be retrieved

o GetLibraryImportExportMode

public GetLibraryImportExportMode( oLIBImportExportMode)

Gets the component Library Import Mode.
Role: This method is used to get mode of component library file for Board assembly Import.

Parameters:

oLIBImportExportMode

Component Library location for Import mode
Legal values:

FILEBASEMODE: LIB File location for is local directory
PLMDOCUMENTMODE: LIB File location is database;LIB file is PLM Document

Returns:

An HRESULT value.
Legal values:

S_OK: LIB file location found
E_FAIL: LIB file location not found

o GetPLMDocumentAttachmentOption

public GetPLMDocumentAttachmentOption( oPLMDocumentAttachmentOption)

Gets PLM Document Attachment option for IDF export.
Role: This method is used to get option of attaching "IDF exported as PLM Document" to the Root Document when board is exported as PLM Document

Parameters:

oPLMDocumentAttachmentOption

IDF Exported as "PLM Document" attachment option.
Legal values:

ATTACHED: Exported PLM Document is attached to the Root Document
NOTATTACHED: Exported PLM Document is NOT attached to the Root Document

Returns:

An HRESULT value.
Legal values:

S_OK: PLMdocument Attachment Mode retrieved successfully
E_FAIL: PLMdocument Attachment Mode retrieval failed

o GetPLMDocumentCreationTypeOption

public GetPLMDocumentCreationTypeOption( oPLMDocumentCreationTypeOption)

Gets creation type of IDF exported as PLM Document.
Role: This method is used to get creation type of IDF exported as PLM Document.

Parameters:

oPLMDocumentCreationTypeOption

IDF Exported as "PLM Document" creaton type.
Legal values:

CREATE_NEWDOC: New PLM Document is to be created
UPDATE_EXISTING_DOC: Existing PLM Document is to be updated

Returns:

An HRESULT value.
Legal values:

S_OK: PLMdocument creatio type retrieved successfully
E_FAIL: PLMdocument creatio type retrieval failed

o GetPLMDocumentVersioningOption

public GetPLMDocumentVersioningOption( oPLMDocumentVersioningOption)

Gets Versioning option for board assembly Export to PLM Document.
Role: This method is used to get Versioning option for board assembly Export to PLM Document. To be used in conbination with

Parameters:

oPLMDocumentVersioningOption

IDF Exported to "PLM Document" versioning option.
Legal values:

NEWVERSION: New version of attached document should be created
CRUSHOLDER: Existing version of attached document should be overwritten

Returns:

An HRESULT value.
Legal values:

S_OK: PLMdocument versioning option retrieved successfully
E_FAIL: PLMdocument versioning option retrieval failed

o SetCSVFile

public SetCSVFile( const iCSVfileName)

Sets CSV file name.
Role: This method is used to set CSV file name for Import/Export of Board assembly.

Parameters:

iCSVfileName: The name of the CSV file. If Import/Export mode is FILEBASEMODE then iCSVfileName should contain full path of the file else only document name should be provided.

Returns:

An HRESULT value.
Legal values:

S_OK: CSV file name set successfully
E_FAIL: CSV file name setting failed

o SetCSVFileMode

public SetCSVFileMode( const iCSVImportExportMode)

Sets the CSV file Export/Import Mode.
Role: This method is used to set mode of CSV file location for Board Import/Export.

Parameters:

iCSVImportExportMode

CSV file location mode
Legal values:

FILEBASEMODE: CSV File location for is local directory
PLMDOCUMENTMODE: CSV File location is database;CSV file is PLM Document

Returns:

An HRESULT value.
Legal values:

S_OK: Mode set successful
E_FAIL: Mode setting failed

o SetComponentCatalogFileName

public SetComponentCatalogFileName( const iCompCatalogfileName)

Sets Component Catalog File Name file name.
Role: This method is used to set component catalog file name for Import of board assembly.This method should be called when component datasource is CATALOG.

Parameters:

iCompCatalogfileName: The name of the component catalog file.

Returns:

An HRESULT value.
Legal values:

S_OK: Component catalog file name set successfully
E_FAIL: Component catalog file name setting failed

o SetComponentDataSource

public SetComponentDataSource( const iCompDataSource)

Sets Component data source for IDF Import.
Role: This method is used to set component data source for IDF import.

Parameters:

iCompDataSource

Component data source
Legal values:

NONE: Component geometry is not searched
DATABASE: Component should be searched in database
CATALOG: Component should be searched in database

Returns:

An HRESULT value.
Legal values:

S_OK: Component datasource set successfully
E_FAIL: Component datasource setting failed

o SetDecimalSeparator

public SetDecimalSeparator( const iUserDefinedDecimalValue)

Sets decimal separator to be used in IDF file to export
Role:

Parameters:

iUserDefinedDecimalValue

decimal separator used in IDF file to export
Legal values:

.: dot
,: comma

Returns:

An HRESULT value.
Legal values:

S_OK: IDF export Decimal Separator set successfully
E_FAIL: IDF export Decimal Separator setting failed

o SetExportUnit

public SetExportUnit( const iExportedUnit)

Sets unit for the IDF file to export
Role:

Parameters:

iExportedUnit

Unit for IDF file to export
Legal values:

MM: Unit of exported co-ordinates is millimeter
THOU: Unit of exported co-ordinates is thou

Returns:

An HRESULT value.
Legal values:

S_OK: Export Unit set successfully
E_FAIL: Export Unit setting failed

o SetExportedFileVersion

public SetExportedFileVersion( const iUnit)

Sets version of IDF file to export
Role:

Parameters:

iUnit

version of IDF file to export
Legal values:

2: Version of IDF file to export is IDF2.0
3: Version of IDF file to export is IDF3.0

Returns:

An HRESULT value.
Legal values:

S_OK: Exported IDF file version set successfully
E_FAIL: Exported IDF file version setting failed

o SetFileName

public SetFileName( const iFileName)

Sets IDF file name
Role: This method is used to set IDF file name for Import/Export.

Parameters:

iFileName: The name of the IDF file. If Export/Import mode is FILEBASEMODE then iFileName should contain full path of the file else only document name should be provided.

Returns:

An HRESULT value.
Legal values:

S_OK: IDF file name set successful
E_FAIL: IDF file name setting failed

o SetIDFImportExportMode

public SetIDFImportExportMode( const iIDFImportExportMode)

Sets the IDF ImportExport Mode.
Role: This method is used to set mode of IDF file Export/Import. Mode defines the location of file.

Parameters:

iIDFImportExportMode

IDF file location for Export/Import
Legal values:

FILEBASEMODE: IDF File location for export/import is local directory
DESIGNERCENTRALMODE: IDF File location for export/import is design central; IDF file is versioned document
PLMDOCUMENTMODE: IDF File location is for export/import is database;IDF file is PLM Document

Returns:

An HRESULT value.
Legal values:

S_OK: Mode set successful
E_FAIL: Mode setting failed

o SetImportDrillHolesMode

public SetImportDrillHolesMode( const iDrilledHolesMode)

Sets holes import mode.
Role: This method is used to set holes import mode for IDF import.

Parameters:

iDrilledHolesMode

Hole import mode
Legal values:

DRILLED: Hole imported should be drilled
NOTDRILLED: Hole imported should NOT be drilled. Only representation are drawn i.e. CBDHoles are created

Returns:

An HRESULT value.
Legal values:

S_OK: Hole Drill Mode set successfully
E_FAIL: Hole Drill Mode setting failed

o SetLibName

public SetLibName( const iLIBFileName)

Sets component library file name.
Role: This method is used to set component library file name for Import.

Parameters:

iFileName: The name of the LIB file. If Import mode is FILEBASEMODE then iFileName should contain full path of the file else only document name should be provided.

Returns:

An HRESULT value.
Legal values:

S_OK: LIB file name set successful
E_FAIL: LIB file name setting failed

o SetLibraryImportExportMode

public SetLibraryImportExportMode( const iLIBImportExportMode)

Sets the component Library Import Mode.
Role: This method is used to set mode of component library file for Board assembly Import.

Parameters:

iLIBImportExportMode

Component Library location for Import mode
Legal values:

FILEBASEMODE: LIB File location for is local directory
PLMDOCUMENTMODE: LIB File location is database;LIB file is PLM Document

Returns:

An HRESULT value.
Legal values:

S_OK: Mode set successful
E_FAIL: Mode setting failed

o SetPLMDocumentAttachmentOption

public SetPLMDocumentAttachmentOption( const iPLMDocumentAttachmentOption)

Sets PLM Document Attachment option for IDF export.
Role: This method is used to set option of attaching "IDF exported as PLM Document" to the Root Document when board is exported as PLM Document

Parameters:

iPLMDocumentAttachmentOption

IDF Exported as "PLM Document" attachment option.
Legal values:

ATTACHED: Exported PLM Document is attached to the Root Document
NOTATTACHED: Exported PLM Document is NOT attached to the Root Document

Returns:

An HRESULT value.
Legal values:

S_OK: PLMdocument Attachment Mode set successfully
E_FAIL: PLMdocument Attachment Mode setting failed

o SetPLMDocumentCreationTypeOption

public SetPLMDocumentCreationTypeOption( const iPLMDocumentCreationTypeOption)

Sets creation type of IDF exported as PLM Document.
Role: This method is used to set creation type of IDF exported as PLM Document.

Parameters:

iPLMDocumentCreationTypeOption

IDF Exported as "PLM Document" creaton type.
Legal values:

CREATE_NEWDOC: New PLM document is to be created
UPDATE_EXISTING_DOC: Existing PLM Document is to be updated

Returns:

An HRESULT value.
Legal values:

S_OK: PLMDocument creation type set successfully
E_FAIL: PLMDocument creation type setting failed

o SetPLMDocumentVersioningOption

public SetPLMDocumentVersioningOption( const iPLMDocumentVersioningOption)

Sets Versioning option for board assembly Export to PLM Document.
Role: This method is used to set Versioning option for board assembly Export to PLM Document.The exported PLM document updates the existing PLM document attached to the root assembly. Use this method when method returns UPDATE_EXISTING_DOC

Parameters:

iPLMDocumentVersioningOption

IDF Exported as "PLM Document" versioning option.
Legal values:

NEWVERSION: New version of attached document should be created
CRUSHOLDER: Existing version of attached document should be overwritten

Returns:

An HRESULT value.
Legal values:

S_OK: PLMdocument versioning option set successfully
E_FAIL: PLMdocument versioning option setting failed

Enumerated Types

o ComponentDataSource

enum ComponentDataSource {
  NONE,
  DATABASE,
  CATALOG
}

Component data source for IDF import.

Parameters:

NONE: Component is not searched in database.
DATABASE: Component is searched in database.
CATALOG: Component is searched in database.

o HoleOptions

enum HoleOptions {
  DRILLED,
  NOTDRILLED
}

Hole drilling option for IDF Import.

Parameters:

DRILLED: Holes imported should be drilled.
NOTDRILLED: Holes imported should NOT be drilled.

o ImportExportMode

enum ImportExportMode {
  FILEBASEMODE,
  DESIGNERCENTRALMODE,
  PLMDOCUMENTMODE
}

IDF Import/Export mode.

Parameters:

FILEBASEMODE: File is stored in a local directory.
DESIGNERCENTRALMODE: File is stored in design central as versioned document.
PLMDOCUMENTMODE: File is stored in database as PLMDocument.

o PLMDocumentAttachment

enum PLMDocumentAttachment {
  ATTACHED,
  NOTATTACHED
}

IDF Exported as PLM document attachment option.

Parameters:

ATTACHED: IDF exported as IDF is to be attached to the Root Product.
NOTATTACHED: IDF exported as IDF should NOT be attached to the Root Product.

o PLMDocumentCreationType

enum PLMDocumentCreationType {
  CREATE_NEWDOC,
  UPDATE_EXISTING_DOC
}

IDF Exported as PLM document creation mode.

Parameters:

CREATE_NEWDOC: New PLMDocument is to be created.
UPDATE_EXISTING_DOC: Existing PLMDocument is to be updated.

o PLMDocumentVersioning

enum PLMDocumentVersioning {
  NEWVERSION,
  CRUSHOLDER
}

IDF Exported as PLM document versioning option when existing PLM document is to be updated.

Parameters:

NEWVERSION: New version of the PLM document is to be created.
CRUSHOLDER: Existing PLM document is to be overwritten.

This object is included in the file: CATPcbImportExportMode.h
If needed, your Imakefile.mk should include the module: CAAIDFImportExport

CATPCBoardUseItf writeClassCharacteristic(); CATPcbImportExportMode

Constructor and Destructor Index

Method Index

Enumerated Type Index

Constructor and Destructor

Methods

Enumerated Types

CATPCBoardUseItf CATPcbImportExportMode