edmiWriteStepFile
- Former user (Deleted)
- Bob Builder
EdmiError edmiWriteStepFile(SdaiString repositoryName,
SdaiString headerModelName,
SdaiString modelName,
SdaiString stepFile,
SdaiString diagnosticFile,
SdaiString shortNamesFile,
SdaiInteger options,
SdaiInteger realPrecision,
SdaiInteger *nbWarnings,
SdaiInteger *nbErrors,
SdaiErrorCode *sdaiError);
Invokes the EDMp21Handler to produce a STEP Physical File representation of a data model in the EDMdatabase. The STEP Physical File format is defined in ISO 10303-21: Clear text encoding of the exchange structures. A STEP Physical File is also referred to as a Part 21 file. STEP Physical File is one of the implementation forms of ISO 10303, and can be used to exchange data between two EDMdatabase s or between an EDMdatabase and any application that conforms to ISO 10303-21. The produced file can also be used for long time archiving of the data. The Header Section part of the STEP file can be produced from an existing header model in the EDMdatabase or a default Header Section can be produced when no header model is specified as input argument to this function. A header model is a model of the HEADER_SECTION_SCHEMA defined in ISO 10303-21. The default Header Section can be configured by setting the EDM system variable EDM_STEP_FILE_AUTHOR. For information on the format of the file in argument <shortNamesFile>, see Short names in the EDMsupervisor User Guide.
Arguments
| Type | Name | Comment |
| SdaiString | repositoryName | Specifies the name of the data repository that holds the model to make a P21 representation of. Repository names are case sensitive. |
| SdaiString | headerModelName | Specifies the name of the STEP Header Model in EDMdatabase that will be mapped to the Header Section in the resulting STEP file. STEP Header Model names are case sensitive. The specified STEP Header Model must be located in the repository specified by the <repositoryName> argument. |
| SdaiString | modelName | Specifies the name of the data model to be mapped to the specified STEP Physical File. Model names are case sensitive. |
| SdaiString | stepFile | Specifies the name of the file that will hold the resulting STEP file. Default file extension is ".stp". |
| SdaiString | diagnosticFile | Specifies the name of a file that will contain diagnostic information generated in the creation of the STEP Physical File. If this argument is empty ( = NULL) the diagnostics will be written to the EDMinterface current output device. The EDMinterface current output device can be defined by the edmiDefineOutputFunction operation. |
| SdaiString | shortNamesFile | Specifies the name of the file containing the mapping matrix between full entity names and its unique short name. This argument is effective only when the SHORT_NAMES option is set. |
| SdaiInteger | options | Specifies the options that are enabled in the invocation of the edmiWriteStepFile function. The <options> value should be specified as a bitwise OR between the options to enable. All option names are defined in the header file sdai.h . |
| SdaiInteger | realPrecision | Specifies an integer that denotes the number of significant digits after the decimal point in a REAL number in the resulting STEP file. When <realPrecision> is set to zero, a system dependent default value is used. |
| SdaiInteger | nbWarnings | Address of a variable that will receive the number of warnings detected during the mapping of the specified data model to the STEP file. |
| SdaiInteger | nbErrors | Address of a variable that will receive the number of errors detected during the mapping of the specified data model to the STEP file. |
| SdaiErrorCode | sdaiError | Address of a variable that will receive the EDMinterface error code when the edmiWriteStepFile function receives an error code in the communication with the EDMserver. The function edmiGetErrorText can be used to get the error message that corresponds to the EDMinterface error code. |
Return Value
Options
| Option | Comment | |
|---|---|---|
CONFORMANCE_CLASS_1 | Enforce the file to be exported according to ISO 10303-21:1994/TC1 conformance class 1 format. Identification of the format is written to the Header Section of the resulting STEP file. | |
CONFORMANCE_CLASS_2 | Enforce the file to be exported according to ISO 10303-21:1994/TC1 conformance class 2 format. Identification of the format is written to the Header Section of the resulting STEP file. | |
EDM_PRIVATE_FORMAT (deprecated) | Exports an EXPRESS Data Manager private format for more compressed exchange between two or more EDMdatabase. Identification of the format is written to the Header Section of the resulting STEP file. | |
| STEP_FILE_PACKAGE | Will allow the STEP file to have EDM types FILE and BLOG. Each data file within the model will be created as a separate file. | |
| ONE_FILE_STEP_FILE_PACKAGE | Must be used with STEP_FILE_PACKAGE . Will create one STEP file that contains the model and all the associated data files. | |
SHORT_NAMES | Specifies that the short names specified in the <shortNamesFile> argument will be used for entity names in the resulting STEP file. | |
EDM_IDENTIFIERS | Specifies that the EDMdatabase instanceID will be used as instance identifiers in the STEP Physical File such that it will be easy to find the correspondence between a mapped instance on the STEP file and the same instance in the EDMdatabase. | |
NO_HEADER_CHANGE | Specifies that the header model specified by the <headerModelName> argument will be mapped to the actual STEP file without any changes. Normally the mapping method, time stamp, and schema name will be provided by the EDMstepHandler function, but no information will be provided by the EDMstepHandler when this option is set. This argument is only effective when a header model is specified in the <headerModelName> argument. | |
NO_STRING_ENCODING | Specifies that no encoding will take place when mapping a STRING data type to the STEP file. The ISO 10303-21 specifies that all character in a STRING data type that have an ASCII value less than 32 or greater than 126 should be encoded in a STEP file. | |
NO_LINE_BREAKS | The exported instances will not be separated with new-line characters in the STEP Physical file. | |
KEPT_STEP_IDENTIFIERS | The instanceIds of the edmModel population will be mapped to the corresponding stepIDs in the STEP Identifier model before they are exported to a STEP file. | |
ZIPPED_FILE COMPRESSED_FILE | The resulting exported STEP Physical file will be in a compressed file format. | |
HEADER_MODEL_ONLY | Specifies that only the Header Section of the specified STEP file will be parsed and a STEP Header Model will be created and populated in the EDMdatabase. No data model will be created when this option is set. |
Example
EdmiError rstat;
SdaiErrorCode sdaiError;
SdaiInteger nbWarnings, nbErrors;
. . .
if (rstat = edmiWriteStepFile (
"DataRepository",
"MyPersonalHeaderModel",
"Building_AXCV9870AB",
"/usr/hkd/IFC/data/Building_AXCV9870AB.stp",
NULL,
NULL,
CONFORMANCE_CLASS_1 | EDM_IDENTIFIERS,
8,
&nbWarnings,
&nbErrors,
&sdaiError)) {
/* Error in operation */
printf("\nError: %s in edmiWriteStepFile\n",
edmiGetErrorText(rstat));
goto error;
}
if (sdaiError) {
printf("\nEDMIerror during operation: %s",
edmiGetErrorText(sdaiError));
}
printf("\Warnings during operation: %ld", nbWarnings);
printf("\nErrors during operation: %ld", nbErrors);
. . .
See also
Filter by label
There are no items with the selected labels at this time.