edmiRemoteWriteStepFile3Ex

EdmiError   edmiRemoteWriteStepFile3Ex (SdaiServerContext       serverContextId,
                                        SdaiString              remoteModelRepositoryName,
                                        SdaiString              remoteModelName,
                                        SdaiString              remoteHeaderModelRepositoryName,
                                        SdaiString              remoteHeaderModelName,
                                        SdaiString              stepFile,
                                        SdaiString              diaFileName,
                                        SdaiString              shortNamesFile,
                                        SdaiOptions             options,
                                        SdaiInteger             realPrecision,
                                        SdaiInteger             stringEncodingCode,
                                        SdaiString              schemaNameOnStepFile, 
                                        SdaiVoid                filterBuffer,         
                                        SdaiInteger            *nbWarnings,
                                        SdaiInteger            *nbErrors,
                                        EdmiError              *sdaiError,
                                        SdaiInvocationId       *edmiInvocationId);

Invokes the EDMp21Handler to produce a STEP Physical File representation of the population of an edmModel in the remote EDMdatabase specified by the given server context. 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 one EDMdatabase and any ISO 10303-21 conformant application. The STEP Physical File can also be used for long-term archiving of the data. The Header Section part of the STEP Physical 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.

Instance types are defined by names, i.e., an entity name in the underlying schema of the actual model is "checked" against an entity with the same name in the schemaNameOnStepFile" schema.

Arguments

1	Type	Name	Comment
2	SdaiServerContext	serverContextId	Context identification, from edmiDefineServerContext
3	SdaiString	remoteModelRepositoryName	The name of the edmRepository in the remote EDMdatabase that contains the edmModel. Repository names are case sensitive.
4	SdaiString	remoteModelName	The name of the edmModel. Model names are case sensitive.
5	SdaiString	remoteHeaderModelRepositoryName	The name of the edmRepository in the remote EDMdatabase that contains the STEP Header Model. Repository names are case sensitive.
6	SdaiString	remoteHeaderModelName	The name of the STEP Header Model that will be mapped to the Header Section in the resulting STEP Physical file. Model names are case sensitive. All instances in the STEP Header Model will be mapped to as is to the STEP Physical file Header Section, except for the attribute FILE_DESCRIPTION.IMPLEMENTATION_LEVEL which will be set according to the mapping method specified by one of the options CONFORMANCE_CLASS_1, CONFORMANCE_CLASS_2 and EDM_PRIVATE_FORMAT. The attribute FILE_NAME.TIME_STAMP will be set to current date and time. When the NO_HEADER_CHANGE option is set, the specified STEP header model will be mapped as is, i.e., also the attribute values described above will be mapped from the specified STEP header model to the STEP Physical file. When this argument is left blank, a default STEP Header Section is generated. The default header section can be configured by setting the EDM system variable EDM_STEP_FILE_AUTHOR.
7	SdaiString	stepFile	The name of the STEP Physical File to create on the local disk. The default file extension is .stp
8	SdaiString	diaFileName	The name of an optional file that will receive the diagnostic information resulting from the generating of the STEP Physical File. If this argument is NULL, the diagnostics will be written to the EDMinterface current output device. The EDMinterface current output device can be defined by the edmiDefineOutputFunction operation.
9	SdaiString	shortNamesFile	The name of the file containing the mapping matrix between the full entity names and their corresponding unique short names.
10	SdaiOptions	options	See list of available options below.
11	SdaiInteger	realPrecision	Denotes the number of significant digits after the decimal point for REAL numbers in the resulting STEP Physical file. When <realPrecision> is set to zero, a system dependent default value is used.
12	SdaiInteger	stringEncodingCode	The file string encoding
13	SdaiString	schemaNameOnStepFile	express schema name written i header section of step file
14	SdaiVoid	filterBuffer	address to NULL terminated InstanceId or entity name buffer
15	SdaiInteger	nbWarnings	Variable that will receive the number of warnings resulting from exporting the STEP Physical file.
16	SdaiInteger	nbErrors	Variable that will receive the number of errors resulting from exporting the STEP Physical file.
17	EdmiError	sdaiError	Variable that will receive any EDMinterface error code resulting from exporting the data in the STEP Physical file it self. System errors in general wil not be returned in this variable.
18	SdaiInvocationId	edmiInvocationId	Currently not used.

Return Value

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'US:_r_EDMInterface'.

Options

1	Option	Comment
2	ENTITY_INSTANCE_ID_FILTER	The filterBuffer is an array of entityInstanceIds
3	ENTITY_NAME_FILTER	The filterBuffer is an array of entityNames
4	INCLUDE_ENTITIES_FILTER	The filterBuffer is an include filter, i.e., only the instance types in the filterBuffer will be written to the STEP file
5	EXCLUDE_ENTITIES_FILTER	All instance types in the actual model, except those specified in the filterBuffer, will be written to the STEP file
6	NO_STRING_ENCODING	Specifies that no encoding will take place when mapping a STRING data type to the STEP Physical file. The ISO 10303-21 specifies that all characters in a string with an ASCII value less than 32 or greater than 126 should be encoded in a STEP Physical file.
7	NO_LINE_BREAKS	The exported instances will not be separated with new-line characters in the STEP Physical file.
8	NO_HEADER_CHANGE	The header model specified by the <headerModelName> argument will be mapped to the actual STEP Physical file without any changes. Normally the mapping method, time stamp, and schema name will be provided by the EDMstepHandler function, but not when this option is set. This argument is only effective when a header model is specified in the <headerModelName> argument.
9	SHORT_NAMES	The short names specified in the <shortNamesFile> argument will be used for entity names in the resulting STEP Physical file.
10	EDM_IDENTIFIERS	Specifies that the EDMdatabase instanceID will be used as instance identifiers in the STEP Physical File. This makes it easier to find the correlation between a stepIds in the STEP Physical file and their corresponding instanceIds in the EDMdatabase.
11	CONFORMANCE_CLASS_1	The STEP Physical file will be exported according to ISO 10303-21:1994/TC1 CC1. The mapping format will be written to the header section of the STEP file. CONFORMANCE_CLASS_1 is the default mapping method. The options CONFORMANCE_CLASS_1, CONFORMANCE_CLASS_2, and EDM_PRIVATE_FORMAT are mutually exclusive.
12	UTF8_ENCODED_FILE_NAMES	Can use UTF8 string encoding in file names
13	ONE_FILE_STEP_FILE_PACKAGE
14	NUMBER_OF_SUBTYPE_INSTANCES_STATISTICS
15	STEP_FILE_PACKAGE
16	NO_COMMENT_SECTION
17	IFC_VIEWER_INSTANCES
18	AGGREGATE_IN_SDAIERROR_ARG
19	ONLY_USER_DEFINED_ENTITIES
20	ORDER_BY_INSTANCE_TYPE
21	FORMAT_STEP_FILE
22	EDM_IDENTIFIERS
23	USE_MODEL_STRING_ENCODING
24	EXCLUDE_USER_DEFINED_ENTITIES
25	NUMBER_OF_INSTANCES_STATISTICS
26	HEADER_MODEL_ONLY
27	CONFORMANCE_CLASS_2
28	ZIPPED_FILE
29	KEPT_STEP_IDENTIFIERS

EDMsix

edmiRemoteWriteStepFile3Ex

Arguments

Return Value

Options

Example

See also

Filter by label