All Categories  Class Hierarchy  This Category  Indexes

STEP Class VPMStepUsrMethod

VPMStepUsrMethod

public class VPMStepUsrMethod

Usage Notes:

These methods allowed to customize the export name for:

catia_model
document
link

Note:
Following convention is used for naming parameters: parameter names prefixed by:

i are input parameters
o are ouput parameters
io are input/output parameters

Method Index

o APxModelBeforeExport(SdaiModelH): This function allows you to check, modify the APx express model - based on schema APx.
o APxModelBeforeImport(SdaiModelH): This function allows you to check, modify the APx express model - based on schema APx.
o GetUsrFullyShatteredExportName(CATDMUsrInstance&,CATUnicodeString&): This function redefines the step file corresponding to the current instance in the FULLY SHATTERED mode.
o LetUsrDocName(): This function keeps the D_PATH attribute as the document name for export.
o LetUsrModelName(): This function keeps the C_NICKNAME attribute as the model name for export.
o SetUsrDocName(CATDMUsrInstance&,CATUnicodeString&): This function redefines the document name during export process.
o SetUsrLinkName(CATDMUsrInstance&,CATUnicodeString&): This function redefines the link name during export process.
o SetUsrModelName(CATDMUsrInstance&,CATUnicodeString&): This function redefines the model name during export process.
o VPMModelBeforeExport(SdaiModelH&): This function allows you to check, modify the VPM express model - based on schema cdma.
o VPMModelBeforeImport(SdaiModelH&): This function allows you to check, modify the VPM express model - based on schema cdma.

Methods

o APxModelBeforeExport

public static Error APxModelBeforeExport( SdaiModelH ioModel)

This function allows you to check, modify the APx express model - based on schema APx.express - after mapping but before exporting it, i.e before writing the step file.

Parameters:

ioModel: APx Express Model.(AP203, AP214, PdmSchema ...)

o APxModelBeforeImport

public static Error APxModelBeforeImport( SdaiModelH ioModel)

This function allows you to check, modify the APx express model - based on schema APx.express - before mapping and importing it, i.e. before starting the comparison vs the database.

Parameters:

ioModel: APx Express Model.(AP203, AP214, PdmSchema ...)

o GetUsrFullyShatteredExportName

public static Error GetUsrFullyShatteredExportName(	CATDMUsrInstance&	`iInst`,
	CATUnicodeString&	`oFSFileName`)

This function redefines the step file corresponding to the current instance in the FULLY SHATTERED mode.
Using the following method, the user is allowed to define his own step file name for each node he is exporting (output CATUnicodeString "oFSFileName").
By default, the file name is a concatenation of "S_" attributes, separated by a given separator.

Parameters:

iInst: Part object.
oFSFileName: The step file name -in Fully Shattered mode- for the Part.

o LetUsrDocName

public static int LetUsrDocName(

)

This function keeps the D_PATH attribute as the document name for export.
In order to avoid duplicate Document names, DS code defines a new single name, which is stored in the STEP_NAME attribute in the STEP export monitor.
The user can keep the CATIA V4 model name stored in the D_PATH attribute using the "LetUsrDocName" method.

Returns:

- return 0: DS code will be executed.
- return 1: D_PATH will not be reset and will be kept as defined.

WARNING :

- if "LetUsrDocName" is used, the attribute STEP_NAME is overwritten in every cases.
- if D_PATH doesn't exist or has no value, the DS code will be executed.

o LetUsrModelName

public static int LetUsrModelName(

)

This function keeps the C_NICKNAME attribute as the model name for export.
In order to avoid duplicate Model names, DS code defines a new single name, which is stored in the STEP_NAME attribute in the STEP export monitor.
The user can keep the CATIA V4 model name stored in the C_NICKNAME attribute using the "LetUsrModelName" method.

Returns:

- 0: DS code will be executed.
- 1: C_NICKNAME will not be reset and will be kept as defined.

WARNING :

- if "LetUsrModelName" is used, the attribute STEP_NAME is overwritten in every cases.
- if C_NICKNAME doesn't exist or has no value, the DS code will be executed.

o SetUsrDocName

public static Error SetUsrDocName(	CATDMUsrInstance&	`iInst`,
	CATUnicodeString&	`oNewDocName`)

This function redefines the document name during export process.
Using the following method, the user can sets the output CATUnicodeString "oNewDocName" with a generic code.
This new name will be saved in the STEP_NAME attribute.
In this case, the user code must generate a single name each time it is invoked.
WARNING :

- if "SetUsrDocName" must be used (i.e. oNewDocName not empty), the "LetUsrDocName" and the DS code will never be executed.

Parameters:

iInst: Document object.
oNewDocName: The new document name.

o SetUsrLinkName

public static Error SetUsrLinkName(	CATDMUsrInstance&	`iInst`,
	CATUnicodeString&	`oTheLinkName`)

This function redefines the link name during export process.
Using the following method, the user can sets the output CATUnicodeString "oThe LinkName" with a generic code.
The new name will be saved in the EXPORT_ID attribute for step export.
WARNING :

- this name set the EXPORT_ID attribute in the temporary SDAI model, it will never be commited in the database.

Parameters:

iInst: Link object.
oTheLinkName: The new link name.

o SetUsrModelName

public static Error SetUsrModelName(	CATDMUsrInstance&	`iInst`,
	CATUnicodeString&	`oNewModelName`)

This function redefines the model name during export process.
Using the following method, the user can sets the output CATUnicodeString "oNewModelName" with a generic code.
This new name will be saved in the STEP_NAME attribute.
In this case, the user code must generate a single name each time it is invoked.
WARNING :

- if "SetUsrModelName" must be used (i.e. oNewModelName not empty), the "LetUsrModelName" and the DS code will never be executed.

Parameters:

iInst: CATIA_MODEL object.
oNewModelName: The new model name.

o VPMModelBeforeExport

public static Error VPMModelBeforeExport( SdaiModelH& ioModel)

This function allows you to check, modify the VPM express model - based on schema cdma.express - before mapping and exporting it, i.e before writing the step file.

Parameters:

ioModel: VPM Express Model.

o VPMModelBeforeImport

public static Error VPMModelBeforeImport( SdaiModelH& ioModel)

This function allows you to check, modify the VPM express model - based on schema cdma.express - after mapping but before importing it, i.e. before starting the comparison vs the database.

Parameters:

ioModel: VPM Express Model.

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