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:
- id
int The reader id.
- name
str The reader name.
- description
str A brief description of the reader and in some cases its operation.
- fileLabel1
str A string appropriate for a “file select” button for the primary filename.
- fileLabel2
str A string appropriate for a “file select” button for the secondary filename.
- opt_booleans
List[dict] The boolean user options.
- opt_options
List[dict] The option user options suitable for display via an option menu.
- opt_fields
List[dict] The field user options suitable for display via a text field.
- id
Methods
ReaderInfo.read_dataset(file1[, file2])Attempt to read some files on disk using this reader and the specified options.