libuserd::LibUserd Class Reference

get_active_reader

Return the currently active reader if any.

Returns

libuserd::Reader* The currently active reader or nullptr if ReaderInfo::read_dataset has not been called.

get_all_readers

Return a list of the readers that are available.

Parameters

[out]

std::vector<ReaderInfo>

& info

Returns

ErrorCode

get_available_reader_count

Return a count of the readers that are available.

Returns

size_t Number of available readers

initialize

This call initializes the libuserd system. It causes the library to scan for available readers and set up any required reduction engine bits. It can only be called once.

Note

number_of_ranks is not currently implemented. It is used to specify the number of parallel servers to use to read the dataset. The values 0 and 1 both represent serial data access. Current code should use the value 0.

Returns

ErrorCode

library_interface

Get the pointer to the library interface.

Note: LibUserd is a singleton and this function will return the existing instance or create a new instance.

Returns

libuserd::LibUserd* The library interface

query_format

For a given dataset (filename(s)), ask the readers if they should be able to read that data.

Parameters

[in]	const	std::string & name1 Primary input filename
[in]	const	std::string & name2 Optional, secondary input filename
[out]	std::vector<ReaderInfo>	& reader_info a list of readers that might be able to read the dataset

Returns

ErrorCode

set_message_handler

Many readers can output diagnostic information. This function allows an application to intercept and handle that type of information.

Parameters

[in]	ErrorProc	The called supplied function to be called when output is generated
[in]	void	* userdata A user supplied pointer that is passed to the function.

Returns

ErrorCode

set_reader_path

By default, the library looks for reader shared libraries by looking for Ansys distributions that align with the version number of the libuserd library. A user may override this search path using this function.

Note: This function must be called before initialize() is called and once intialize() has been called, this method will return

Parameters

[in]

const

std::string & path

Returns

ErrorCode returns IGNORED_AFTER_INITIALIZE if called after initialize()

shutdown

Shutdown the libuserd library, stopping any active reader and any reduction engine. Once this is called, the LibUserd interface can no longer be used in the current process.

Returns

ErrorCode

Definition at line 648 of file libuserd_interface.h.