SYNTAX:
xpxReadStepFileExEx(repositoryName , modelName : STRING;
headerModelRepositoryName , headerModelName : STRING;
STEPfile , logFile , schemaName : STRING;
ShortNamesFile : STRING;
options : INTEGER;
inOptPar1 , inOptPar2 , inOptPar3 : GENERIC;
VAR modelId , VAR containerId : GENERIC;
VAR warnings , VAR errors , VAR sdaiError : INTEGER;
VAR outOptPar1 , VAR outOptPar2 , VAR outOptPar3 : GENERIC)
status : INTEGER;
To be completed
The xpxReadStepFileExEx function is used to create a new model and populate the model with data from the specified STEP Physical File. The arguments in the xpxReadStepFileExEx have the following meaning
:
Argument:: |
Description: |
repositoryName |
Name of the repository where the new created model will be located |
modelName |
The name of the sdai_model that will be created and populated as a result of the xpxReadStepFileEx function |
headerModelRepositoryName |
A STEP Physical File consist of a Header Section and a Data Section. If a sdai_model of the Header Section should be created and populated during the xpxReadStepFileEx operation, then the headerModelName specifies the name of this sdai_model in the database. This model will be located in the repository specified by the repositoryName argument. This argument can be set to an empty string or indeterminate when no creation and population of a STEP Physical File Header Section model is wanted |
headerModelName |
Specifies the name of the STEP Header model to be created and populated. The model must have a name that is unique within the repository that holds the model. The model name must start with a letter and the rest of the model name can be any mix of alphanumeric characters and the underscore character. Model names are case sensitive. |
STEPfile |
The name of the actual STEP Physical File to read into the database |
logFile |
The name of the file where logging from the xpxReadStepFileEx function will be recorded in case logging is enabled. This argument can be set to an empty string or indeterminate when no logging should be performed |
schemaName |
The name of the Express schema that defines the structure of the data in the Data Section of the actual STEP file is found in the attribute FILE_SCHEMA.SCEMA_IDENTIFIERS in the Header Section of the STEP file. This schema will be used as the underlying schema of the new data model resulting from this command, hence this Express schema must exist as a dictionary model in the EDMdatabase when the xpxReadStepFileEx function is invoked. |
shortNamesFile |
The name of a file that contains short entity names of the actual schema that defines the data on the STEP file to be read. A STEP file can be written using the entity names specified in the Express schema that defines the sdai model that is mapped to the STEP file, or a STEP file can be written using short entity names. In case the actual STEP file is written using the short entity names, the shortNamesFile argument must specify a file that contains the mapping from short entity names to the entity names defined in the underlying Express schema of the actual sdai model. |
options |
The options are equivalent to the options used in the EDMinterface function edmiReadStepFile except for the XPX prefix. |
modelId |
|
warnings |
Number of warnings detected during reading the specified step file. |
errors |
Number of errors detected during reading the specified step file. |
sdaiError |
If the xpxReadStepFileEx operation is terminated due to errors in accessing the database, the argument sdaiError will receive the actual sdaiErrorCode causing the termination of the xpxReadStepFileEx operation. |
outOptPar1 |
|
outOptPar2 |
|
outOptPar3 |
|
Options:
ADD_TO_EXISTING_MODEL |
The imported data set (STEP file) will be added to the existing data model <modelName>. The <modelName> data model must be a model with the required underlying schema ,i.e., the schema specified in the header section of the STEP file or the schema specified in the <schemaName> argument. |
CONFORMANCE_CLASS_1 |
Overrules the mapping method given in the Header Section of the actual STEP file such that the STEP file will be interpret according to ISO 10303-21:1994/TC1 CC1. |
CONFORMANCE_CLASS_2 |
Overrules the mapping method given in the Header Section of the actual STEP file such that the STEP file will be interpret according to ISO 10303-21:1994/TC1 CC2. |
DIS_VERSION |
Overrules the mapping method given in the Header Section of the actual STEP file such that the STEP file will be interpret according to ISO 10303-21:1994/TC1 DIS version. |
DELETING_EXISTING_MODEL |
When the specified <modelName> exists, it well be deleted and recreated at the invocation of the edmiReadStepFile operation. |
DELETE_INSTANCE_REFS_ON_DELETE |
The sdaiDeleteInstance operation will be legal for instances with references. The references to the actual instances will automatically be deleted when the actual instance is deleted by the sdaiDeleteInstance operation. |
DELETE_INSTANCES_WITH_REFS |
|
EXCLUDE_USER_DEFINED_ENTITIES |
All instances of UserDefinedEntities in the actual "stepFile" will be skipped, i.e., these instances will not be populated in the |
HEADER_MODEL_ONLY |
|
ISO_8859_1_STRING_ENCODING |
The STRING data types in the resulting new EDMdataModel will be encoded in ISO-LATIN-1 style string encoding. |
INSTANCES_IN_CONTAINER |
All instances created by the actual STEPread operation will be inserted in an EDMcontainer that will be created by the STEPread operation. The actual EDMcontainerId is returned in the "containerId" argument in the actual readStep operation invocation. |
INSTANCES_IN_MODEL_LOCK_CONTAINER |
All instances created by the actual STEPread operation will be inserted in an EDMmodelLockContainer that will be created by the STEPread operation. The actual EDMmodelLockContainerId is returned in the "containerId" argument in the actual readStep operation invocation. |
INSTANCES_IN_MODEL_CONTAINER |
All instances created by the actual STEPread operation will be inserted in an EDMmodelContainer that will be created by the STEPread operation. The actual EDMmodelContainerId is returned in the "containerId" argument in the actual readStep operation invocation. |
INSTANCES_IN_LOCK_CONTAINER |
All instances created by the actual STEPread operation will be inserted in an EDMlockContainer that will be created by the STEPread operation. The actual EDMlockContainerId is returned in the "containerId" argument in the actual STEPread operation invocation. |
LOG_ERRORS_AND_WARNINGS_ONLY |
Limits the log to only include logging of instances related to errors and warnings. |
LOG_TO_FILE |
Logged information will be stored in a file specified by the <Log file> argument. |
LOG_TO_STDOUT |
Logged information will be written to the _EDMinterface_ current output device. The _EDMinterface_ current output device can be defined by the edmiDefineOutputFunction operation. |
KEEP_STEP_IDENTIFIERS |
A STEP Identifier model will be created and connected to the data model created by this operation. The STEP Identifier model will keep the correspondence between the STEP file entity instances (stepID) and the _EDMdatabase_ instanceID that uniquely identifies the same instance. |
NO_STRING_ENCODING |
Specifies that the actual STEP file has no encoding of SdaiString data values, hence no decoding will take place during the read operation. |
NOT_CLOSE_MODEL |
The data model will not be closed by the edmiReadStepFile operation, i.e., the calling application can start using the imported model immediately without opening the model. |
NO_INSTANCE_REFERENCES |
No "instance references tables" will be created and maintained in the actual model. The following operations will not work on the actual data model when this option is enabled:
|
ONE_FILE_STEP_FILE_PACKAGE |
The actual "stepFile" to read is an EDMstepFilePackage consisting of one single file.An EDMstepFilePackage is an EDM proprietary |
ONLY_USER_DEFINED_ENTITIES |
Only instances of UserDefinedEntities in the actual "stepFile" will be populated in the actual EDMdataModel by the STEPread operation. |
OPEN_MODEL_FOR_LOCAL_READ_WRITE |
This option opens the actual resulting EDMdataModel for LocalReadWrite mode, i.e., this model will not be updated on the EDMdatabase |
PARSE_ONLY |
The specified STEP file will be parsed only, i.e. only checked for syntactical correctness, no data will be stored in the EDMdatabase. |
PRE_PARSE_FILE |
Specifies that the actual import process will be performed in two passes, i.e., the actual STEP file will be read twice. |
STEP_FILE_PACKAGE |
The "stepFile" to read in the actual STEPread operation is an EDMstepFilePackage. |
UNPACKED_MODEL |
|
USER_CONTROLLED_INVERSE |
|
UTF8_ENCODED_FILE_NAMES |
|
UTF_8_STRING_ENCODING |
The STRING data types in the resulting new EDMdataModel will be encoded in UTF-8 style string encoding. |
ZIPPED_FILE |
The actual "stepFile" is a "zipped" file. |