pw:: IOMode

The base IO mode type

Derives From

pw::Object pw::Mode

Summary
The base IO mode type
This action initializes the mode with the file type and name.
This action gets the counts of foreign entities processed by the mode.
This action gets the details of the last IO operation.
This action gets the number of warnings that occurred during the last IO operation.
This action gets the information of the given warning.
This action gets the number of errors that occurred during the last IO operation.
This action gets the code of the given error.
This action gets the information of the given error.
This action gets the unique errors from the last IO operation.
This action gets the groups that were created during import to group left over entities when an entity has conversion problems.
This action gets the mode’s file type.
This action gets the mode’s file type.
This action gets the mode’s file version.
This action returns a list of the names of the currently available IO mode attributes.
This action returns the number of currently available IO mode attributes.
This action gets the definition of the given IO mode attribute.
This action gets the named IO mode attribute.
This action sets the named IO mode attribute.
The valid IOMode attributes.
Export block faces only.
Only export the grid’s boundary condition data.
Split domains at this angle.
Split domains that have multiple edges.
Domain surface degree.
Ignore entities with existing names.
Set GridPro export filter type.
Specifies the file format’s entity mesh style.
Handling for entity visibility data.
Should donor information be written in the ZoneGridConnectivity_t node when writing a CGNS file.
Should parent elements be included in Element_t nodes when writing a CGNS file.
File byte order.
Use Native CAD Reader format specific conversion settings.
Use Native CAD Reader topology healing functionality.
File format.
Use Nastran “large” format.
Use information from the file to set the model size during import.
Floating-point precision.
File units specification.
Specifies the block dimensionality.
Specifies the file format’s grid block style.
Set mirroring on export.
Domain surface degree.
Set the interface data type to be used to establish connectivity between blocks of differing type (structured and unstructured).
Iblank array type.
Assemble models with the given tolerance.
Automatically converts free surfaces into models with a single quilt and trimmed surfaces.
Export the file using Pointwise extensions.
Set Pyramid Style for Nastran.
Assemble quilts at the given angle.
Shell cell handling mode.
Split shells at this angle.
Spline the control points of imported bilinear surfaces.
Split surfaces at discontinuities.
Set Tecplot binary file format: Tecplot Binary (.plt) is the legacy format written by Tecplot 360 and Tecplot Focus.
Set the interface data type to be used to establish connectivity between unstructured blocks.

Instance Actions

initialize

$io initialize ?-type file_type? filename

This action initializes the mode with the file type and name.

Parameters

-type file_typeThis optional parameter is the string file type of the file with options < Automatic | GG | DBA | IGES | STL | GridPro | VRML | VRML97 | PLOT3D | Network | Segment | Patran | Nastran | UCD | Xpatch | FVUNS | CGNS | CGNS-STRUCT | CGNS-UNSTR | UGRID | NMB >.  The default is Automatic, which selects the file type based on the filename extension.
filenameThis parameter is the string full path and name of the file to import.

Returns

This action returns a boolean where true if initialized, false if not.

Notes

If -type Automatic was specified (or defaulted), it is possible the file type selected internally is incorrect because some file types ambiguously use the same extension.

getForeignEntityCounts

$io getForeignEntityCounts

This action gets the counts of foreign entities processed by the mode.

Parameters

This action has no parameters.

Returns

This action returns a list of strings which are foreign entity name and count pairs.

getDetails

$io getDetails

This action gets the details of the last IO operation.

Parameters

This action has no parameters.

Returns

This action returns a string of text details.

getWarningCount

$io getWarningCount

This action gets the number of warnings that occurred during the last IO operation.

Parameters

This action has no parameters.

Returns

The integer number of errors.

getWarningInformation

$io getWarningInformation index

This action gets the information of the given warning.

Parameters

indexThis parameter is the integer index of the warning to get with the range [1, number of errors].

Returns

This action returns a string of information about the warning.

getErrorCount

$io getErrorCount

This action gets the number of errors that occurred during the last IO operation.

Parameters

This action has no parameters.

Returns

The integer number of errors.

getErrorCode

$io getErrorCode index

This action gets the code of the given error.

Parameters

indexThis parameter is the integer index of the error to get with the range [1, number of errors].

Returns

This action returns a string error code that may be one of the following: AttributeIsInvalid, CannotOpenFile, CannotAccessFile, FormatIsInvalid, DuplicateNameDetected, UnsupportedEntityDetected, UnsupportedByCAEDetected, CannotConvertEntity, Unknown, Fatal, InconsistentDimensionDetected

getErrorInformation

$io getErrorInformation index

This action gets the information of the given error.

Parameters

indexThis parameter is the integer index of the error to get with the range [1, number of errors].

Returns

This action returns a string of extra information about the error.

getUniqueErrorCodes

$io getUniqueErrorCodes

This action gets the unique errors from the last IO operation.

Parameters

This action has no parameters.

Returns

A list of string error codes.  See getErrorCode for a list of possible values.

getFailureGroups

$io getFailureGroups

This action gets the groups that were created during import to group left over entities when an entity has conversion problems.

Parameters

This action has no parameters.

Returns

A list of pw::Group objects

getFileType

$io getFileType ?-nomap?

This action gets the mode’s file type.

Parameters

-nomapThis optional flag forces the return of the unmapped -type value passed to initialize.  In this case, it is possible for “Automatic” to be returned.  See the initialize Notes for some caveats.

Returns

This action returns a file type string.

getFileSubType

$io getFileSubType

This action gets the mode’s file type.

Parameters

This action has no parameters.

Returns

This action returns a file subtype string or an empty string if a subtype is not defined.

getFileVersion

$io getFileVersion

This action gets the mode’s file version.

Parameters

This action has no parameters.

Returns

This action returns a version string or an empty string if a version is not defined.

getAttributeNames

$io getAttributeNames ?-regex? ?pattern?

This action returns a list of the names of the currently available IO mode attributes.

Parameters

-regexThis optional flag signifies that the given pattern should be considered a regular expression pattern rather than a glob pattern.
patternThis optional parameter is the string pattern used to filter the returned attribute names.

Returns

A list of strings of the names of the currently available IO mode attributes that fit the filter pattern.  If a pattern is not given, all attribute names will be in the list.

See Also

Attributes

getAttributeCount

$io getAttributeCount

This action returns the number of currently available IO mode attributes.

Parameters

This action has no parameters.

Returns

The integer number of IO mode attributes.

See Also

Attributes

getAttributeDefinition

$io getAttributeDefinition < index | name >

This action gets the definition of the given IO mode attribute.

Parameters

indexThis parameter is the integer index of the IO mode attribute to get with the range [1, number of attributes].
nameThis parameter is the string parameter name.

Returns

This action returns the attribute definition which will be a list of { name type description enum_values }:

See Also

Attributes

getAttribute

$io getAttribute att_name

This action gets the named IO mode attribute.

Parameters

att_nameThis parameter is the name of the attribute to get.

Returns

This action returns the value of the attribute.

See Also

Attributes

setAttribute

$io setAttribute att_name att_value

This action sets the named IO mode attribute.

Parameters

att_nameThis parameter is the name of the attribute to set.
att_valueThis parameter is the value to set the attribute.

Returns

This action returns nothing.

See Also

Attributes

Attributes

The valid IOMode attributes.

Not all attributes are supported by every IOMode instance.  Use getAttributeNames to obtain the attributes supported by a particular IOMode object.

BlockFacesOnly

$io get/setAttribute BlockFacesOnly att_value

Export block faces only.

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by all grid export types.

BoundaryConditionsOnly

$io get/setAttribute BoundaryConditionsOnly att_value

Only export the grid’s boundary condition data.

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is not used by any import types.

Exporters

This attribute is available to any CaeExporter that supports it.

CellCombineAnisotropic

$io get/setAttribute CellCombineAnisotropic att_value
DeprecatedFormerly combine anisotropic tet cells into pyramids and prisms.  Use of this attribute for querying or setting will cause an error.

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is not used by any import types.

Exporters

This attribute is not used by any export types.

DomainSplitAngle

$io get/setAttribute DomainSplitAngle att_value

Split domains at this angle.

Type

This attribute is of type float.

Default

The default for this attribute is 0.0

Importers

This attribute is used by all grid import types.

Exporters

This attribute is not used by any export types.

DomainSplitMultipleEdges

$io get/setAttribute DomainSplitMultipleEdges att_value

Split domains that have multiple edges.

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is used by all grid import types.

Exporters

This attribute is not used by any export types.

DomainSurfaceDegree

$io get/setAttribute DomainSurfaceDegree att_value

Domain surface degree.

Type

This attribute is of type string; < Bilinear | Bicubic >.

Default

The default for this attribute is Bilinear.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the IGES export types.

EntityIgnoreIfNameUsed

$io get/setAttribute EntityIgnoreIfNameUsed att_value

Ignore entities with existing names.

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is used by all import types.

Exporters

This attribute is not used by any export types.

EntityExportFilter

$io get/setAttribute EntityExportFilter att_value

Set GridPro export filter type.  This attribute determines how an ambiguous entity selection of structured and unstructured domains should be written to a file.

Type

This attribute is of type string; < StructuredOnly | UnstructuredOnly | DiagonalizeAll >

Default

The default for this attribute is determined by the entity selection.  If the selection is mixed structured and unstructured, then the attribute is set to DiagonalizeAll.  Otherwise, the attribute matches the domain type of the selection.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the GridPro export type.

EntityMeshStyle

$io get/setAttribute EntityMeshStyle att_value

Specifies the file format’s entity mesh style.

Type

This attribute is of type string; < Single | Multiple >.

Single exports all entities as a single mesh.

Multiple exports each entity as a separate mesh.

Default

The export default for this attribute is Single.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the STL export type.

EntityVisibility

$io get/setAttribute EntityVisibility att_value

Handling for entity visibility data.

Type

This attribute is of type string; < Import | ImportAndHideSupports | ShowAll | ShowAllAndHideSupports >.

Default

The default for this attribute is ImportAndHideSupports.

Importers

This attribute is used by all database import types.

Exporters

This attribute is not used by any export types.

ExportDonorInformation

$io get/setAttribute ExportDonorInformation att_value

Should donor information be written in the ZoneGridConnectivity_t node when writing a CGNS file.

Type

This attribute is of type boolean.

Default

The default for this attribute is true.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the CGNS CaeExporter.

ExportParentElements

$io get/setAttribute ExportParentElements att_value

Should parent elements be included in Element_t nodes when writing a CGNS file.

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the CGNS CaeExporter.

FileByteOrder

$io get/setAttribute FileByteOrder att_value

File byte order.

Type

This attribute is of type string; < Native | Swap | LittleEndian | BigEndian >.

Default

The default for this attribute is Native.

Importers

This attribute is used by all import types.

Exporters

This attribute is used by all export types.

FileConvertFormatSettings

$io get/setAttribute FileConvertFormatSettings att_value

Use Native CAD Reader format specific conversion settings.

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is used by the Native CAD Reader import type.

Exporters

This attribute is not used by any of the export types.

FileConvertHealTopology

$io get/setAttribute FileConvertHealTopology att_value

Use Native CAD Reader topology healing functionality.

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is used by the Native CAD Reader import type.

Exporters

This attribute is not used by any of the export types.

FileFormat

$io get/setAttribute FileFormat att_value

File format.

Type

This attribute is of type string; < ASCII | Binary | Unformatted >.

Default

The default for this attribute is varied.

Importers

This attribute is used by all import types.

Exporters

This attribute is used by all export types.

Notes

The Unformatted value is only valid for “FORTRAN” file types.

FileLargeWidthColumns

$io get/setAttribute FileLargeWidthColumns att_value

Use Nastran “large” format.

Type

This attribute is of type boolean.

Default

The default for this attribute is true.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the Nastran export type.

FileModelSizeFromFile

$io get/setAttribute FileModelSizeFromFile att_value

Use information from the file to set the model size during import.

Type

This attribute is of type boolean.

Default

The default for this attribute is true.

Importers

This attribute is used by the IGES and Native Cad Reader types.

Exporters

This attribute is not used by any export types.

FilePrecision

$io get/setAttribute FilePrecision att_value

Floating-point precision.

Type

This attribute is of type string; < Single | Double >.

Default

The default for this attribute is varied.

Importers

This attribute is used by all import types.

Exporters

This attribute is used by all export types.

FileUnits

$io get/setAttribute FileUnits att_value

File units specification.

Type

This attribute is of type string; < Microinches | Mils | Inches | Feet | Miles | Microns | Millimeters | Centimeters | Meters | Kilometers | FromFile >.

Default

The default for this attribute is FromFile for importers and Inches for exporters.

Importers

This attribute is used by the IGES and Native Cad Reader types.

Exporters

This attribute is used by the IGES export type.

GridBlockDimension

$io get/setAttribute GridBlockDimension att_value

Specifies the block dimensionality.

Type

This attribute is of type integer; < 1, 2, 3 >.

Default

The import default for this attribute is 3.  The export default for this attribute is 3.

Importers

This attribute is used by the PLOT3D import type.

Exporters

This attribute is used by the PLOT3D export type.

GridBlockStyle

$io get/setAttribute GridBlockStyle att_value

Specifies the file format’s grid block style.

Type

This attribute is of type string; < Single | Multiple >.

Single exports exactly one PLOT3D block using the single block format.

Multiple exports one or more PLOT3D blocks using the multiple block format.

Default

The import default for this attribute is Single.  The export default for this attribute is Multiple.

Importers

This attribute is used by the PLOT3D import type.

Exporters

This attribute is used by the PLOT3D export type.

GridExportMirrored

$io get/setAttribute GridExportMirrored att_value

Set mirroring on export.

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by all plugin exporters and CGNS, GASP, KESTREL, and TECPLOT exporters.

GridStructuredAsUnstructured

$io get/setAttribute GridStructuredAsUnstructured att_value

Domain surface degree.

Type

This attribute is of type boolean.

Default

The default for this attribute depends on the entity selection.  When only structured blocks are selected, it is false.  When mixed blocks are selected, it is true.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the CGNS and Tecplot CaeExporter.

HybridInterface

Set the interface data type to be used to establish connectivity between blocks of differing type (structured and unstructured).

Type

This attribute is of type string; < FaceToFace | NodeToNode | CellToCell >.

Default

The default for this attribute is FaceToFace.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the CGNS CaeExporter.

IblankStyle

$io get/setAttribute IblankStyle att_value

Iblank array type.

Type

This attribute is of type string; < None | PointBased >.

Default

The default for this attribute is None.

Importers

This attribute is used by the PLOT3D import type.

Exporters

This attribute is used by the PLOT3D export type.

ModelAssembleTolerance

$io get/setAttribute ModelAssembleTolerance att_value

Assemble models with the given tolerance.

Type

This attribute is of type float.

Default

The default for this attribute is 0.0.

Importers

This attribute is used by all database import types.

Exporters

This attribute is not used by any export types.

ModelFromFreeSurface

$io get/setAttribute ModelFromFreeSurface att_value

Automatically converts free surfaces into models with a single quilt and trimmed surfaces.

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is used by all database import types.

Exporters

This attribute is not used by any export types.

PointwiseCompatibilityMode

$io get/setAttribute PointwiseCompatibilityMode att_value

Export the file using Pointwise extensions.

Type

This attribute is of type boolean.

Default

The default for this attribute is true.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the IGES export type.

PyramidStyle

$io get/setAttribute PyramidStyle att_value

Set Pyramid Style for Nastran.

Type

This attribute is of type string; < CPENTA | CPYRAM >.

Default

The default for this attribute is CPENTA.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the Nastran export type.

QuiltAssembleAngle

$io get/setAttribute QuiltAssembleAngle att_value

Assemble quilts at the given angle.

Type

This attribute is of type float.

Default

The default for this attribute is 0.0.

Importers

This attribute is used by all database import types.

Exporters

This attribute is not used by any export types.

ShellCellMode

$io get/setAttribute ShellCellMode att_value

Shell cell handling mode.

Type

This attribute is of type string; < AsTriangles | AsTrianglesAndQuadrilaterals | AsIs | MergeCoplanar ).

Default

The default for this attribute is AsTriangles.

Importers

This attribute is used by all faceted database import types.

Exporters

This attribute is not used by any export types.

ShellSplitAngle

$io get/setAttribute ShellSplitAngle att_value

Split shells at this angle.

Type

This attribute is of type float.

Default

The default for this attribute is 0.0.

Importers

This attribute is used by all faceted database import types.

Exporters

This attribute is not used by any export types.

SurfaceSplineBilinear

$io get/setAttribute SurfaceSplineBilinear att_value

Spline the control points of imported bilinear surfaces.

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is used by the PLOT3D and Network import types.

Exporters

This attribute is not used by any export types.

SurfaceSplitDiscontinuous

$io get/setAttribute SurfaceSplitDiscontinuous att_value

Split surfaces at discontinuities.

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is used by the IGES import type.

Exporters

This attribute is not used by any export types.

TecplotFileFormat

$io get/setAttribute TecplotFileFormat att_value

Set Tecplot binary file format: Tecplot Binary (.plt) is the legacy format written by Tecplot 360 and Tecplot Focus.  Tecplot Subzone Loadable (.szplt) was introduced with Tecplot 360 EX.

Type

This attribute is of type string; < PLT | SZPLT >

Default

The default for this attribute is PLT

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the Tecplot CaeExporter.

UnstructuredInterface

$io get/setAttribute UnstructuredInterface att_value

Set the interface data type to be used to establish connectivity between unstructured blocks.

Type

This attribute is of type string; < FaceToFace | NodeToNode | CellToCell >.

Default

The default for this attribute is FaceToFace.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the CGNS CaeExporter.

$io initialize ?-type file_type? filename
This action initializes the mode with the file type and name.
$io getForeignEntityCounts
This action gets the counts of foreign entities processed by the mode.
$io getDetails
This action gets the details of the last IO operation.
$io getWarningCount
This action gets the number of warnings that occurred during the last IO operation.
$io getWarningInformation index
This action gets the information of the given warning.
$io getErrorCount
This action gets the number of errors that occurred during the last IO operation.
$io getErrorCode index
This action gets the code of the given error.
$io getErrorInformation index
This action gets the information of the given error.
$io getUniqueErrorCodes
This action gets the unique errors from the last IO operation.
$io getFailureGroups
This action gets the groups that were created during import to group left over entities when an entity has conversion problems.
$io getFileType ?-nomap?
This action gets the mode’s file type.
$io getFileSubType
This action gets the mode’s file type.
$io getFileVersion
This action gets the mode’s file version.
$io getAttributeNames ?-regex? ?pattern?
This action returns a list of the names of the currently available IO mode attributes.
$io getAttributeCount
This action returns the number of currently available IO mode attributes.
$io getAttributeDefinition < index | name >
This action gets the definition of the given IO mode attribute.
$io getAttribute att_name
This action gets the named IO mode attribute.
$io setAttribute att_name att_value
This action sets the named IO mode attribute.
$io get/setAttribute BlockFacesOnly att_value
Export block faces only.
$io get/setAttribute BoundaryConditionsOnly att_value
Only export the grid’s boundary condition data.
$io get/setAttribute CellCombineAnisotropic att_value
$io get/setAttribute DomainSplitAngle att_value
Split domains at this angle.
$io get/setAttribute DomainSplitMultipleEdges att_value
Split domains that have multiple edges.
$io get/setAttribute DomainSurfaceDegree att_value
Domain surface degree.
$io get/setAttribute EntityIgnoreIfNameUsed att_value
Ignore entities with existing names.
$io get/setAttribute EntityExportFilter att_value
Set GridPro export filter type.
$io get/setAttribute EntityMeshStyle att_value
Specifies the file format’s entity mesh style.
$io get/setAttribute EntityVisibility att_value
Handling for entity visibility data.
$io get/setAttribute ExportDonorInformation att_value
Should donor information be written in the ZoneGridConnectivity_t node when writing a CGNS file.
$io get/setAttribute ExportParentElements att_value
Should parent elements be included in Element_t nodes when writing a CGNS file.
$io get/setAttribute FileByteOrder att_value
File byte order.
$io get/setAttribute FileConvertFormatSettings att_value
Use Native CAD Reader format specific conversion settings.
$io get/setAttribute FileConvertHealTopology att_value
Use Native CAD Reader topology healing functionality.
$io get/setAttribute FileFormat att_value
File format.
$io get/setAttribute FileLargeWidthColumns att_value
Use Nastran “large” format.
$io get/setAttribute FileModelSizeFromFile att_value
Use information from the file to set the model size during import.
$io get/setAttribute FilePrecision att_value
Floating-point precision.
$io get/setAttribute FileUnits att_value
File units specification.
$io get/setAttribute GridBlockDimension att_value
Specifies the block dimensionality.
$io get/setAttribute GridBlockStyle att_value
Specifies the file format’s grid block style.
$io get/setAttribute GridExportMirrored att_value
Set mirroring on export.
$io get/setAttribute GridStructuredAsUnstructured att_value
Domain surface degree.
$io get/setAttribute IblankStyle att_value
Iblank array type.
$io get/setAttribute ModelAssembleTolerance att_value
Assemble models with the given tolerance.
$io get/setAttribute ModelFromFreeSurface att_value
Automatically converts free surfaces into models with a single quilt and trimmed surfaces.
$io get/setAttribute PointwiseCompatibilityMode att_value
Export the file using Pointwise extensions.
$io get/setAttribute PyramidStyle att_value
Set Pyramid Style for Nastran.
$io get/setAttribute QuiltAssembleAngle att_value
Assemble quilts at the given angle.
$io get/setAttribute ShellCellMode att_value
Shell cell handling mode.
$io get/setAttribute ShellSplitAngle att_value
Split shells at this angle.
$io get/setAttribute SurfaceSplineBilinear att_value
Spline the control points of imported bilinear surfaces.
$io get/setAttribute SurfaceSplitDiscontinuous att_value
Split surfaces at discontinuities.
$io get/setAttribute TecplotFileFormat att_value
Set Tecplot binary file format: Tecplot Binary (.plt) is the legacy format written by Tecplot 360 and Tecplot Focus.
$io get/setAttribute UnstructuredInterface att_value
Set the interface data type to be used to establish connectivity between unstructured blocks.
Base type for all glyph types
The mode base type
A string is an array of characters.
A boolean is represented as a 0 or 1, with 0 being false and 1 being true.
An integer is a whole number.
Group type
The valid IOMode attributes.
A float is a fractional number.