Chemical Data Processing Library Python API - Version 1.1.1
|
A singleton class that serves as a global registry for Grid.DRegularGridSetInputHandler and Grid.DRegularGridSetOutputHandler implementation instances. More...
Classes | |
class | InputHandlerSequence |
class | OutputHandlerSequence |
Static Public Member Functions | |
None | registerInputHandler (DRegularGridSetInputHandler handler) |
Registers the specified Grid.DRegularGridSetInputHandler implementation instance. More... | |
DRegularGridSetInputHandler | getInputHandler (int idx) |
Returns a reference to the registered Grid.DRegularGridSetInputHandler implementation instance with the specified index. More... | |
DRegularGridSetInputHandler | getInputHandlerByFormat (Base.DataFormat fmt) |
Returns a reference to a Grid.DRegularGridSetInputHandler implementation instance registered for the specified data format. More... | |
DRegularGridSetInputHandler | getInputHandlerByName (str name) |
Returns a reference to a Grid.DRegularGridSetInputHandler implementation instance registered for the data format with the specified name. More... | |
DRegularGridSetInputHandler | getInputHandlerByFileExtension (str file_ext) |
Returns a reference to a Grid.DRegularGridSetInputHandler implementation instance registered for the data format with the specified file extension. More... | |
DRegularGridSetInputHandler | getInputHandlerByMimeType (str mime_type) |
Returns a reference to a Grid.DRegularGridSetInputHandler implementation instance registered for the data format with the specified mime-type. More... | |
bool | unregisterInputHandler (Base.DataFormat fmt) |
Unregisters the Grid.DRegularGridSetInputHandler implementation instance for the specified data format. More... | |
None | unregisterInputHandler (int idx) |
Unregisters the Grid.DRegularGridSetInputHandler implementation instance with the specified index. More... | |
bool | unregisterInputHandler (DRegularGridSetInputHandler handler) |
Unregisters the specified Grid.DRegularGridSetInputHandler implementation instance. More... | |
int | getNumInputHandlers () |
Returns the number of registered Grid.DRegularGridSetInputHandler implementation instances. More... | |
InputHandlerSequence | getInputHandlers () |
None | registerOutputHandler (DRegularGridSetOutputHandler handler) |
Registers the specified Grid.DRegularGridSetOutputHandler implementation instance. More... | |
DRegularGridSetOutputHandler | getOutputHandler (int idx) |
Returns a reference to the registered Grid.DRegularGridSetOutputHandler implementation instance with the specified index. More... | |
DRegularGridSetOutputHandler | getOutputHandlerByFormat (Base.DataFormat fmt) |
Returns a reference to a Grid.DRegularGridSetOutputHandler implementation instance registered for the specified data format. More... | |
DRegularGridSetOutputHandler | getOutputHandlerByName (str name) |
Returns a reference to a Grid.DRegularGridSetOutputHandler implementation instance registered for the data format with the specified name. More... | |
DRegularGridSetOutputHandler | getOutputHandlerByFileExtension (str file_ext) |
Returns a reference to a Grid.DRegularGridSetOutputHandler implementation instance registered for the data format with the specified file extension. More... | |
DRegularGridSetOutputHandler | getOutputHandlerByMimeType (str mime_type) |
Returns a reference to a Grid.DRegularGridSetOutputHandler implementation instance registered for the data format with the specified mime-type. More... | |
bool | unregisterOutputHandler (Base.DataFormat fmt) |
Unregisters the Grid.DRegularGridSetOutputHandler implementation instance for the specified data format. More... | |
None | unregisterOutputHandler (int idx) |
Unregisters the Grid.DRegularGridSetOutputHandler implementation instance with the specified index. More... | |
bool | unregisterOutputHandler (DRegularGridSetOutputHandler handler) |
Unregisters the specified Grid.DRegularGridSetOutputHandler implementation instance. More... | |
int | getNumOutputHandlers () |
Returns the number of registered Grid.DRegularGridSetOutputHandler implementation instances. More... | |
OutputHandlerSequence | getOutputHandlers () |
Static Public Attributes | |
inputHandlers = _HIDDEN_VALUE_ | |
int | numInputHandlers = 3 |
outputHandlers = _HIDDEN_VALUE_ | |
int | numOutputHandlers = 3 |
A singleton class that serves as a global registry for Grid.DRegularGridSetInputHandler and Grid.DRegularGridSetOutputHandler implementation instances.
DataIOManager
provides static methods for the registration and lookup of Grid.DRegularGridSetInputHandler and Grid.DRegularGridSetOutputHandler implementation instances that handle different input and output storage formats.
Input and output handlers are registered by the methods registerInputHandler() and registerOutputHandler(). These methods expect a reference to an instance of the respective handler implementation as an argument (please note that the registered instance must not be destroyed as long as it is accessible via the DataIOManager
interface!).
For the removal of registered handlers the unregisterInputHandler() and unregisterOutputHandler() family of overloaded methods is provided. These methods accept a reference to the registered handler instance, the handler index, the handled data format or an iterator pointing to the handler as an argument.
Registered input handlers can be queried by the methods getInputHandlerByFormat(), getInputHandlerByName(), getInputHandlerByFileExtension() and getInputHandlerByMimeType(), which allow to find a suitable handler for a given data format, data format name, file extension or mime-type. For the registered output handlers similar methods are provided.
I/O handlers for data formats and object types supported by the CDPL are registered in the static library initialization code. These built-in handlers are accessible by the linking client code as soon as the library initialization has finished.
|
static |
Registers the specified Grid.DRegularGridSetInputHandler implementation instance.
handler | The Grid.DRegularGridSetInputHandler implementation instance to register. |
|
static |
Returns a reference to the registered Grid.DRegularGridSetInputHandler implementation instance with the specified index.
idx | The zero-based index of the Grid.DRegularGridSetInputHandler implementation instance to return. |
Base.IndexError | if idx is out of bounds. |
|
static |
Returns a reference to a Grid.DRegularGridSetInputHandler implementation instance registered for the specified data format.
fmt | Specifies the data format that is associated with the requested Grid.DRegularGridSetInputHandler implementation instance. |
|
static |
Returns a reference to a Grid.DRegularGridSetInputHandler implementation instance registered for the data format with the specified name.
name | Specifies the name of the data format that is associated with the requested Grid.DRegularGridSetInputHandler implementation instance. |
|
static |
Returns a reference to a Grid.DRegularGridSetInputHandler implementation instance registered for the data format with the specified file extension.
file_ext | Specifies the file extension of the data format that is associated with the requested Grid.DRegularGridSetInputHandler implementation instance. |
|
static |
Returns a reference to a Grid.DRegularGridSetInputHandler implementation instance registered for the data format with the specified mime-type.
mime_type | Specifies the mime-type of the data format that is associated with the requested Grid.DRegularGridSetInputHandler implementation instance. |
|
static |
Unregisters the Grid.DRegularGridSetInputHandler implementation instance for the specified data format.
Only one handler instance at a time will be unregistered (in a first in - first out manner). If more than one handler instance has been registered for the given data format, the method has to be called multiple times to unregister all instances.
fmt | Specifies the data format that is associated with the handler instance to unregister. |
True
if a handler instance for the specified data format was found and has been unregistered, and False
otherwise.
|
static |
Unregisters the Grid.DRegularGridSetInputHandler implementation instance with the specified index.
idx | The zero-based index of the Grid.DRegularGridSetInputHandler implementation instance to unregister. |
Base.IndexError | if idx is out of bounds. |
|
static |
Unregisters the specified Grid.DRegularGridSetInputHandler implementation instance.
handler | The Grid.DRegularGridSetInputHandler implementation instance to unregister. |
True
if the handler instance was found and has been unregistered, and False
otherwise.
|
static |
Returns the number of registered Grid.DRegularGridSetInputHandler implementation instances.
|
static |
<br> |
|
static |
Registers the specified Grid.DRegularGridSetOutputHandler implementation instance.
handler | The Grid.DRegularGridSetOutputHandler implementation instance to register. |
|
static |
Returns a reference to the registered Grid.DRegularGridSetOutputHandler implementation instance with the specified index.
idx | The zero-based index of the Grid.DRegularGridSetOutputHandler implementation instance to return. |
Base.IndexError | if idx is out of bounds. |
|
static |
Returns a reference to a Grid.DRegularGridSetOutputHandler implementation instance registered for the specified data format.
fmt | Specifies the data format that is associated with the requested Grid.DRegularGridSetOutputHandler implementation instance. |
|
static |
Returns a reference to a Grid.DRegularGridSetOutputHandler implementation instance registered for the data format with the specified name.
name | Specifies the name of the data format that is associated with the requested Grid.DRegularGridSetOutputHandler implementation instance. |
|
static |
Returns a reference to a Grid.DRegularGridSetOutputHandler implementation instance registered for the data format with the specified file extension.
file_ext | Specifies the file extension of the data format that is associated with the requested Grid.DRegularGridSetOutputHandler implementation instance. |
|
static |
Returns a reference to a Grid.DRegularGridSetOutputHandler implementation instance registered for the data format with the specified mime-type.
mime_type | Specifies the mime-type of the data format that is associated with the requested Grid.DRegularGridSetOutputHandler implementation instance. |
|
static |
Unregisters the Grid.DRegularGridSetOutputHandler implementation instance for the specified data format.
Only one handler instance at a time will be unregistered (in a first in - first out manner). If more than one handler instance has been registered for the given data format, the method has to be called multiple times to unregister all instances.
fmt | Specifies the data format that is associated with the handler instance to unregister. |
True
if a handler instance for the specified data format was found and has been unregistered, and False
otherwise.
|
static |
Unregisters the Grid.DRegularGridSetOutputHandler implementation instance with the specified index.
idx | The zero-based index of the Grid.DRegularGridSetOutputHandler implementation instance to unregister. |
Base.IndexError | if idx is out of bounds. |
|
static |
Unregisters the specified Grid.DRegularGridSetOutputHandler implementation instance.
handler | The Grid.DRegularGridSetOutputHandler implementation instance to unregister. |
True
if the handler instance was found and has been unregistered, and False
otherwise.
|
static |
Returns the number of registered Grid.DRegularGridSetOutputHandler implementation instances.
|
static |
<br> |