...
SYNTAX:
xpxWriteStepFileEx (repositoryName, modelName : STRING; headerRepositoryName, headerModelName : STRING; STEPfile, diagFile, shortNamesFile : STRING; options, realPrecisision : INTEGER; VAR nWarnings, VAR nErrors, VAR sdaiError : INTEGER) status : INTEGER;
The xpxWriteStepFileEx function can be used to produce a STEP Physical File (Part 21 file) of specified model.
The arguments in the xpxWriteStepFileEx have the following meaning:
...
Argument:
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
FUNCTION xpxWriteStepFileEx (repositoryName, modelName : STRING;
headerRepositoryName, headerModelName : STRING;
STEPfile, diagFile, shortNamesFile : STRING;
options, realPrecision : INTEGER;
VAR nWarnings, VAR nErrors : INTEGER;
VAR sdaiError : INTEGER)
status : INTEGER;
|
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 |
| STRING | repositoryName | Specifies the name of the data repository that holds the model to make a P21 representation of. Repository names are case sensitive. |
| STRING | modelName |
| Specifies the name of the |
| data model to be mapped to the |
| specified STEP Physical File. |
headerRepositoryName
| Model names are case sensitive. | ||
| STRING | headerRepositoryName | |
| STRING | 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. |
meaning that the Header Section of the actual STEP Physical File will be produced according to a standard procedureSTEPfile
| All instances in the specified <headerModelName> will be mapped to the STEP file Header Section as is, except that the attribute FILE_DESCRIPTION.IMPLEMENTATION_LEVEL is set according to the mapping method specified by one of the following options: CONFORMANCE_CLASS_1, CONFORMANCE_CLASS_2 or EDM_PRIVATE_FORMAT. The attribute FILE_NAME.TIME_STAMP is set to the current date and time, i.e., the date and time when the STEP file is produced. When the NO_HEADER_CHANGE option is set, the specified header model will be mapped as is, i.e., also the three attribute values described above will be mapped from the specified header model to the STEP file. When the <headerModelName> argument is blank, a default Header Section is produced. This default header section can be configured by setting the EDM system variable EDM_STEP_FILE_AUTHOR. | ||
| STRING | STEPfile | Specifies the name of the file that will |
| hold the |
diagFile
Diagnostic file. The xpxWriteStepFileEx function will record all diagnostics found during mapping of the actual sdai model to the actual STEP Physical File on this <diagFile>. When the <diagFile> argument is set to an empty string or to indeterminate , then no diagnostic recording will be produced.
shortNamesFile
Short Entity Names file. When the xpxShortNames option is set, the xpxWriteStepFile will use the short entity names found on the specified shortNamesFile argument instead of the entity names found in the underlying schema of the actual sdai model mapped to the STEP file.
For information on the format of the file in argument <shortNamesFile>, see Short names in the EDMsupervisor User Guide.
options
The options are equivalent to the options used in the EDMinterface function edmiWriteStepFileEx.
realPrecisision
Specifies the precision of the REAL data type on the STEP file. Default value is used when <realPrecision> argument is set to zero.
nWarnings
This argument will receive the number of warnings detected during the xpxWriteStepFileEx operation.
nErrors
This argument will receive the number of errors detected during the xpxWriteStepFileEx operation.
sdaiError
If the xpxWriteStepFileEx operation is terminated due to errors in accessing the database, the argument <sdaiError> will receive the actual sdaiErrorCode causing the termination of the xpxWriteStepFileEx operation.
...
| resulting STEP file. Default file extension is ".stp". | ||
| STRING | diagFile | 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. |
| INTEGER | 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. |
| INTEGER | options | The <options> value should be specified as a bitwise OR between the options to enable. |
| INTEGER | 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. |
| INTEGER | nWarnings | Address of a variable that will receive the number of warnings detected during the mapping of the specified data model to the STEP file. |
| INTEGER | nErrors | Address of a variable that will receive the number of errors detected during the mapping of the specified data model to the STEP file. |
| INTEGER | sdaiError | Address of a variable that will receive the EDMinterface error code when the xpxWriteStepFileEx function receives an error code in the communication with the EDMserver. |
Return Value
...
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Options
...
| Option | Comment |
|---|---|
XPXCONFORMANCE_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. The options CONFORMANCE_CLASS_1, CONFORMANCE_CLASS_2 and EDM_PRIVATE_FORMAT are mutually exclusive, i.e., only one of these options should be activated in one execution of the xpxWriteStepFile function. |
XPXCONFORMANCE_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. The options CONFORMANCE_CLASS_1, CONFORMANCE_CLASS_2 and EDM_PRIVATE_FORMAT are mutually exclusive, i.e., only one of these options should be activated in one execution of the xpxWriteStepFile function. |
XPXEDM_PRIVATE_FORMAT | 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. |
XPXSHORT_NAMES | Specifies that the short names specified in the <shortNamesFile> argument will be used for entity names in the resulting STEP file. |
XPXEDM_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. |
XPXNO_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. |
XPXNO_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. |
XPXNO_LINE_BREAKS |
|
XPXKEPT_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. |
XPXCOMPRESSED_FILE |
|
XPXHEADER_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
...
| Code Block | ||
|---|---|---|
| ||
<Missing Example> |
See also
| Filter by label (Content by label) | ||||||
|---|---|---|---|---|---|---|
|