#include <libuserd_interface.h>

Inheritance diagram for libuserd::ReaderInfo:

Public Member Functions
ErrorCode	read_dataset (const std::string &file1, const std::string &file2, IReader *&reader) override
	read_dataset

Static Public Member Functions
static bool	get_userd_xtra_gui_values (int reader_id, Options &userd_options)
	Retrieves extra GUI values for a specified reader.

Friends
class	LibUserd

Detailed Description

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

Definition at line 314 of file libuserd_interface.h.

Member Function Documentation

◆ get_userd_xtra_gui_values()

static bool libuserd::ReaderInfo::get_userd_xtra_gui_values	(	int	reader_id,
		Options &	userd_options )

static

Retrieves extra GUI values for a specified reader.

This static method fetches additional GUI values associated with the given reader ID and stores them in the provided Options object.

Parameters

[in]	reader_id	The ID of the reader for which to retrieve the GUI values.
[out]	userd_options	The Options object where the retrieved GUI values will be stored.

Returns: True if there are any extra GUI values and false otherwise.

◆ read_dataset()

ErrorCode libuserd::ReaderInfo::read_dataset	(	const std::string &	file1,
		const std::string &	file2,
		IReader *&	reader )

override

read_dataset

Attempt to read some files on disk using this reader and the specified options. If successful, return an actual reader instance.

Note: The returned Reader pointer is owned by the LibUserd instance. It should not be deleted by the caller.

Parameters

[in]	const	std::string & file1 ///< the pimary filename (e.g. .cas)
[in]	const	std::string & file2 ///< an optional secondary filename (e.g. .dat)
[out]	Reader	* & reader ///< the actual reader instance

Returns: ErrorCode

Friends And Related Symbol Documentation

◆ LibUserd

friend class LibUserd

friend

Definition at line 351 of file libuserd_interface.h.

The documentation for this class was generated from the following file:

D:/ANSYSDev/Product-src/ensight/server/userd/include/libuserd_interface.h

EnSight 2025 R2

libuserd::ReaderInfo Class Reference

Public Member Functions

Static Public Member Functions

Friends