pw:: GridImporter

The GridImporter IO mode type

Derives From

pw::Object pw::Mode pw::IOMode

Summary
The GridImporter IO mode type
This action gets a list of the file types that are supported for grid entity import, with certain file types excluded based on the current CAE and dimension.
This action verifies the IO mode attributes and tries to read the file that is being imported.
This action checks if there is data that will be converted when the read action is used.
This action converts the data read in by creating pw::GridEntity objects based on the imported data.

Instance Actions

getFileTypes

$io getFileTypes

This action gets a list of the file types that are supported for grid entity import, with certain file types excluded based on the current CAE and dimension.

Parameters

This action has no parameters.

Returns

This action returns a list containing file type names that can be used in the <initialize> command.

read

$io read

This action verifies the IO mode attributes and tries to read the file that is being imported.

Parameters

This action has no parameters.

Returns

This action returns a boolean of true if read, false if not.

Note

This action must be called after initialize, but before convert.

Possible Errors

AttributeIsInvalid, CannotOpenFile, CannotAccessFile, FormatIsInvalid, DuplicateNameDetected, MissingReferencesDetected, UnsupportedEntityDetected, UnsupportedByCAEDetected, Unknown, InconsistentDimensionDetected

canConvert

$io canConvert

This action checks if there is data that will be converted when the read action is used.

Parameters

This action has no parameters.

Returns

This action returns a boolean of true if convert will convert data, false if not.

convert

$io convert

This action converts the data read in by creating pw::GridEntity objects based on the imported data.

Parameters

This action has no parameters.

Returns

This action returns a boolean of true if read, false if not.

Note

This action must be called after initialize and read.

Possible Errors

CannotConvertEntity, Unknown

$io getFileTypes
This action gets a list of the file types that are supported for grid entity import, with certain file types excluded based on the current CAE and dimension.
$io read
This action verifies the IO mode attributes and tries to read the file that is being imported.
$io canConvert
This action checks if there is data that will be converted when the read action is used.
$io convert
This action converts the data read in by creating pw::GridEntity objects based on the imported data.
Base type for all glyph types
The mode base type
The base IO mode type
A boolean is represented as a 0 or 1, with 0 being false and 1 being true.