Package edm.edom3

Class EDMConstants.StepOutputOptions

  • Enclosing interface:
    EDMConstants

    public static class EDMConstants.StepOutputOptions
    extends java.lang.Object
    Options for step file writer
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static long CHAR_ENCODING_ISO_8859_1
      Uses ISO 8859-1 string Encoding
      static long CHAR_ENCODING_ISO_8859_2
      Uses ISO 8859-2 string Encoding
      static long CHAR_ENCODING_ISO_8859_3
      Uses ISO 8859-3 string Encoding
      static long CHAR_ENCODING_ISO_8859_4
      Uses ISO 8859-4 string Encoding
      static long CHAR_ENCODING_ISO_8859_5
      Uses ISO 8859-5 string Encoding
      static long CHAR_ENCODING_ISO_8859_6
      Uses ISO 8859-6 string Encoding
      static long CHAR_ENCODING_ISO_8859_7
      Uses ISO 8859-7 string Encoding
      static long CHAR_ENCODING_ISO_8859_8
      Uses ISO 8859-8 string Encoding
      static long CHAR_ENCODING_ISO_8859_9
      Uses ISO 8859-9 string Encoding
      static long CHAR_ENCODING_UTF_16
      Uses UTF-16 string Encoding
      static long CHAR_ENCODING_UTF_8
      Uses UTF-8 string Encoding
      static long CONFORMANCE_CLASS_1
      Enforce the file to be exported according to ISO 10303-21:1994/TC1 conformance class 1 format.
      static long CONFORMANCE_CLASS_2
      Enforce the file to be exported according to ISO 10303-21:1994/TC1 conformance class 2 format.
      static long 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.
      static long ENTITY_INSTANCE_ID_FILTER
      The filterBuffer is an array of entityInstanceIds
      static long ENTITY_NAME_FILTER
      The filterBuffer is an array of entityNames
      static long EXCLUDE_ENTITIES_FILTER
      All instance types in the actual model, except those specified in the filterBuffer, will be written to the STEP file
      static long EXCLUDE_USER_DEFINED_ENTITIES
      no instances of type USER_DEFINED_ENTITY will be written to the STEP file
      static long HEADER_MODEL_ONLY
      Only write the header model
      static long INCLUDE_ENTITY_FILTER
      The filterBuffer is an include filter, i.e., only the instance types in the filterBuffer will be written to the STEP file
      static long 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.
      static long NO_COMMENT_SECTION
      The created STEP file will no have the Header comment section.
      static long NO_HEADER_CHANGE
      Specifies that the header model specified by the implementing class constructors headerModelName argument will be mapped to the actual STEP file without any changes.
      static long NO_LINE_BREAKS
      The exported instances will not be separated with new-line characters in the STEP Physical file.
      static long NO_STRING_ENCODING
      Specifies that no encoding will take place when mapping a STRING data type to the STEP file.
      static long NUMBER_OF_INSTANCES_STATISTICS
      write the "number of instances statistics" as comment on the STEP file.
      static long NUMBER_OF_SUBTYPE_INSTANCES_STATISTICS
      write the "number of subtype instances statistics" as comment on the STEP file.
      static long ONE_FILE_STEP_FILE_PACKAGE
      Used with STEP_FILE_PACKAGE.
      static long ONLY_ENTITIES_IN_SPECIFIED_SCHEMA
      Only instance types defined in the schema specified in the "schemaNameOnStepFile" argument will be written on the STEP file The specified schema must exist as a dictionary model when this option is legal/effective.
      static long ONLY_USER_DEFINED_ENTITIES
      only instances of type USER_DEFINED_ENTITY will be written to the STEP file
      static long STEP_EDITION_3
      STEP edition 3 option for STEP read and write
      static long STEP_FILE_PACKAGE
      Will allow the STEP file to have EDM types FILE and BLOG.
      static long SWRITE_SHORT_NAMES
      Specifies that the short names specified in the implementing class constuctors shortNameFile argument will be used for entity names in the resulting STEP file
      static long USE_MODEL_STRING_ENCODING
      use the same string encoding (Code Page) on the sTEP file as in the actual EDMmodel
      static long UTF8_ENCODED_FILE_NAMES
      File names are UTF-8 encoded
      static long ZIPPED_FILE
      The create STEP file will be compresses as an .gz file.
    • Method Summary

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • CONFORMANCE_CLASS_1

        public static final long 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.
        For import it 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.
        The call conformanceClassOne(), conformanceClassTwo(), if exporting privateFormat(), if importing disVersion() are mutually exclusive, i.e., only one of these methodes should be activated.
        See Also:
        CONFORMANCE_CLASS_2, Constant Field Values
      • CONFORMANCE_CLASS_2

        public static final long 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.
        For import it 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.
        The options conformanceClassOne(), conformanceClassTwo(), if exporting privateFormat(), if importing disVersion() are mutually exclusive, i.e., only one of these methodes should be activated.
        See Also:
        Constant Field Values
      • NO_STRING_ENCODING

        public static final long 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.
        See Also:
        Constant Field Values
      • SWRITE_SHORT_NAMES

        public static final long SWRITE_SHORT_NAMES
        Specifies that the short names specified in the implementing class constuctors shortNameFile argument will be used for entity names in the resulting STEP file
        See Also:
        Constant Field Values
      • NO_HEADER_CHANGE

        public static final long NO_HEADER_CHANGE
        Specifies that the header model specified by the implementing class constructors 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 production, but no information will be provided after this methode is called. This methode is only effective when a header model is specified in the implementing class constuctors headerModelName argument.
        See Also:
        Constant Field Values
      • EDM_IDENTIFIERS

        public static final long 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.
        See Also:
        Constant Field Values
      • NO_COMMENT_SECTION

        public static final long NO_COMMENT_SECTION
        The created STEP file will no have the Header comment section. The header comment section includes information on: The EXPRESS Data Manager Version, Module, Step file Creation date, EDM Host, Database path, Database version, Database creation date Schema name, Model name, Model creation date, EDMuser, EDMgroup, License ID and type, EDMstepFileFactory options
        See Also:
        Constant Field Values
      • UTF8_ENCODED_FILE_NAMES

        public static final long UTF8_ENCODED_FILE_NAMES
        File names are UTF-8 encoded
        See Also:
        Constant Field Values
      • ONE_FILE_STEP_FILE_PACKAGE

        public static final long ONE_FILE_STEP_FILE_PACKAGE
        Used with STEP_FILE_PACKAGE. All files will be witin one STEP file.
        See Also:
        STEP_FILE_PACKAGE, Constant Field Values
      • NUMBER_OF_SUBTYPE_INSTANCES_STATISTICS

        public static final long NUMBER_OF_SUBTYPE_INSTANCES_STATISTICS
        write the "number of subtype instances statistics" as comment on the STEP file.
        See Also:
        Constant Field Values
      • STEP_FILE_PACKAGE

        public static final long 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.
        See Also:
        Constant Field Values
      • NO_LINE_BREAKS

        public static final long NO_LINE_BREAKS
        The exported instances will not be separated with new-line characters in the STEP Physical file.
        See Also:
        Constant Field Values
      • ONLY_USER_DEFINED_ENTITIES

        public static final long ONLY_USER_DEFINED_ENTITIES
        only instances of type USER_DEFINED_ENTITY will be written to the STEP file
        See Also:
        Constant Field Values
      • KEPT_STEP_IDENTIFIERS

        public static final long 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.
        See Also:
        Constant Field Values
      • USE_MODEL_STRING_ENCODING

        public static final long USE_MODEL_STRING_ENCODING
        use the same string encoding (Code Page) on the sTEP file as in the actual EDMmodel
        See Also:
        Constant Field Values
      • EXCLUDE_USER_DEFINED_ENTITIES

        public static final long EXCLUDE_USER_DEFINED_ENTITIES
        no instances of type USER_DEFINED_ENTITY will be written to the STEP file
        See Also:
        Constant Field Values
      • NUMBER_OF_INSTANCES_STATISTICS

        public static final long NUMBER_OF_INSTANCES_STATISTICS
        write the "number of instances statistics" as comment on the STEP file.
        See Also:
        Constant Field Values
      • HEADER_MODEL_ONLY

        public static final long HEADER_MODEL_ONLY
        Only write the header model
        See Also:
        Constant Field Values
      • STEP_EDITION_3

        public static final long STEP_EDITION_3
        STEP edition 3 option for STEP read and write
        See Also:
        Constant Field Values
      • ZIPPED_FILE

        public static final long ZIPPED_FILE
        The create STEP file will be compresses as an .gz file.
        See Also:
        Constant Field Values
      • ENTITY_INSTANCE_ID_FILTER

        public static final long ENTITY_INSTANCE_ID_FILTER
        The filterBuffer is an array of entityInstanceIds
        See Also:
        Constant Field Values
      • ENTITY_NAME_FILTER

        public static final long ENTITY_NAME_FILTER
        The filterBuffer is an array of entityNames
        See Also:
        Constant Field Values
      • INCLUDE_ENTITY_FILTER

        public static final long INCLUDE_ENTITY_FILTER
        The filterBuffer is an include filter, i.e., only the instance types in the filterBuffer will be written to the STEP file
        See Also:
        Constant Field Values
      • EXCLUDE_ENTITIES_FILTER

        public static final long EXCLUDE_ENTITIES_FILTER
        All instance types in the actual model, except those specified in the filterBuffer, will be written to the STEP file
        See Also:
        Constant Field Values
      • ONLY_ENTITIES_IN_SPECIFIED_SCHEMA

        public static final long ONLY_ENTITIES_IN_SPECIFIED_SCHEMA
        Only instance types defined in the schema specified in the "schemaNameOnStepFile" argument will be written on the STEP file The specified schema must exist as a dictionary model when this option is legal/effective. NOTE: 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.
        See Also:
        Constant Field Values
      • CHAR_ENCODING_UTF_8

        public static final long CHAR_ENCODING_UTF_8
        Uses UTF-8 string Encoding
        See Also:
        Constant Field Values
      • CHAR_ENCODING_UTF_16

        public static final long CHAR_ENCODING_UTF_16
        Uses UTF-16 string Encoding
        See Also:
        Constant Field Values
      • CHAR_ENCODING_ISO_8859_1

        public static final long CHAR_ENCODING_ISO_8859_1
        Uses ISO 8859-1 string Encoding
        See Also:
        Constant Field Values
      • CHAR_ENCODING_ISO_8859_2

        public static final long CHAR_ENCODING_ISO_8859_2
        Uses ISO 8859-2 string Encoding
        See Also:
        Constant Field Values
      • CHAR_ENCODING_ISO_8859_3

        public static final long CHAR_ENCODING_ISO_8859_3
        Uses ISO 8859-3 string Encoding
        See Also:
        Constant Field Values
      • CHAR_ENCODING_ISO_8859_4

        public static final long CHAR_ENCODING_ISO_8859_4
        Uses ISO 8859-4 string Encoding
        See Also:
        Constant Field Values
      • CHAR_ENCODING_ISO_8859_5

        public static final long CHAR_ENCODING_ISO_8859_5
        Uses ISO 8859-5 string Encoding
        See Also:
        Constant Field Values
      • CHAR_ENCODING_ISO_8859_6

        public static final long CHAR_ENCODING_ISO_8859_6
        Uses ISO 8859-6 string Encoding
        See Also:
        Constant Field Values
      • CHAR_ENCODING_ISO_8859_7

        public static final long CHAR_ENCODING_ISO_8859_7
        Uses ISO 8859-7 string Encoding
        See Also:
        Constant Field Values
      • CHAR_ENCODING_ISO_8859_8

        public static final long CHAR_ENCODING_ISO_8859_8
        Uses ISO 8859-8 string Encoding
        See Also:
        Constant Field Values
      • CHAR_ENCODING_ISO_8859_9

        public static final long CHAR_ENCODING_ISO_8859_9
        Uses ISO 8859-9 string Encoding
        See Also:
        Constant Field Values
    • Constructor Detail

      • StepOutputOptions

        public StepOutputOptions()