ReaderInfo#

class ansys.pyensight.core.libuserd.ReaderInfo(userd: LibUserd, pb: ReaderInfo)#

This class represents an available reader, before it has been instantiated. The read_dataset() function actually tries to open a dataset and returns a Reader instance that is reading the data.

The class contains a list of options that can control/configure the reader. These include “boolean”, “option” and “field” options. These include defaults supplied by the reader. To use these, change the value or value_index fields to the desired values before calling read_dataset.

Parameters:
userd

The LibUserd instance this query is associated with.

pb

The protobuffer that represents this object.

Attributes:
idint

The reader id.

namestr

The reader name.

descriptionstr

A brief description of the reader and in some cases its operation.

fileLabel1str

A string appropriate for a “file select” button for the primary filename.

fileLabel2str

A string appropriate for a “file select” button for the secondary filename.

opt_booleansList[dict]

The boolean user options.

opt_optionsList[dict]

The option user options suitable for display via an option menu.

opt_fieldsList[dict]

The field user options suitable for display via a text field.

Methods

ReaderInfo.read_dataset(file1[, file2])

Attempt to read some files on disk using this reader and the specified options.