Chemical Data Processing Library Python API - Version 1.1.1
Classes | Static Public Member Functions | Static Public Attributes | List of all members
CDPL.Grid.DRegularGridIOManager Class Reference

A singleton class that serves as a global registry for Grid.DRegularGridInputHandler and Grid.DRegularGridOutputHandler implementation instances. More...

+ Inheritance diagram for CDPL.Grid.DRegularGridIOManager:

Classes

class  InputHandlerSequence
 
class  OutputHandlerSequence
 

Static Public Member Functions

None registerInputHandler (DRegularGridInputHandler handler)
 Registers the specified Grid.DRegularGridInputHandler implementation instance. More...
 
DRegularGridInputHandler getInputHandler (int idx)
 Returns a reference to the registered Grid.DRegularGridInputHandler implementation instance with the specified index. More...
 
DRegularGridInputHandler getInputHandlerByFormat (Base.DataFormat fmt)
 Returns a reference to a Grid.DRegularGridInputHandler implementation instance registered for the specified data format. More...
 
DRegularGridInputHandler getInputHandlerByName (str name)
 Returns a reference to a Grid.DRegularGridInputHandler implementation instance registered for the data format with the specified name. More...
 
DRegularGridInputHandler getInputHandlerByFileExtension (str file_ext)
 Returns a reference to a Grid.DRegularGridInputHandler implementation instance registered for the data format with the specified file extension. More...
 
DRegularGridInputHandler getInputHandlerByMimeType (str mime_type)
 Returns a reference to a Grid.DRegularGridInputHandler implementation instance registered for the data format with the specified mime-type. More...
 
bool unregisterInputHandler (Base.DataFormat fmt)
 Unregisters the Grid.DRegularGridInputHandler implementation instance for the specified data format. More...
 
None unregisterInputHandler (int idx)
 Unregisters the Grid.DRegularGridInputHandler implementation instance with the specified index. More...
 
bool unregisterInputHandler (DRegularGridInputHandler handler)
 Unregisters the specified Grid.DRegularGridInputHandler implementation instance. More...
 
int getNumInputHandlers ()
 Returns the number of registered Grid.DRegularGridInputHandler implementation instances. More...
 
InputHandlerSequence getInputHandlers ()
 
None registerOutputHandler (DRegularGridOutputHandler handler)
 Registers the specified Grid.DRegularGridOutputHandler implementation instance. More...
 
DRegularGridOutputHandler getOutputHandler (int idx)
 Returns a reference to the registered Grid.DRegularGridOutputHandler implementation instance with the specified index. More...
 
DRegularGridOutputHandler getOutputHandlerByFormat (Base.DataFormat fmt)
 Returns a reference to a Grid.DRegularGridOutputHandler implementation instance registered for the specified data format. More...
 
DRegularGridOutputHandler getOutputHandlerByName (str name)
 Returns a reference to a Grid.DRegularGridOutputHandler implementation instance registered for the data format with the specified name. More...
 
DRegularGridOutputHandler getOutputHandlerByFileExtension (str file_ext)
 Returns a reference to a Grid.DRegularGridOutputHandler implementation instance registered for the data format with the specified file extension. More...
 
DRegularGridOutputHandler getOutputHandlerByMimeType (str mime_type)
 Returns a reference to a Grid.DRegularGridOutputHandler implementation instance registered for the data format with the specified mime-type. More...
 
bool unregisterOutputHandler (Base.DataFormat fmt)
 Unregisters the Grid.DRegularGridOutputHandler implementation instance for the specified data format. More...
 
None unregisterOutputHandler (int idx)
 Unregisters the Grid.DRegularGridOutputHandler implementation instance with the specified index. More...
 
bool unregisterOutputHandler (DRegularGridOutputHandler handler)
 Unregisters the specified Grid.DRegularGridOutputHandler implementation instance. More...
 
int getNumOutputHandlers ()
 Returns the number of registered Grid.DRegularGridOutputHandler implementation instances. More...
 
OutputHandlerSequence getOutputHandlers ()
 

Static Public Attributes

 inputHandlers = _HIDDEN_VALUE_
 
int numInputHandlers = 3
 
 outputHandlers = _HIDDEN_VALUE_
 
int numOutputHandlers = 3
 

Detailed Description

A singleton class that serves as a global registry for Grid.DRegularGridInputHandler and Grid.DRegularGridOutputHandler implementation instances.

DataIOManager provides static methods for the registration and lookup of Grid.DRegularGridInputHandler and Grid.DRegularGridOutputHandler 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.

Member Function Documentation

◆ registerInputHandler()

None CDPL.Grid.DRegularGridIOManager.registerInputHandler ( DRegularGridInputHandler  handler)
static

Registers the specified Grid.DRegularGridInputHandler implementation instance.

Parameters
handlerThe Grid.DRegularGridInputHandler implementation instance to register.

◆ getInputHandler()

DRegularGridInputHandler CDPL.Grid.DRegularGridIOManager.getInputHandler ( int  idx)
static

Returns a reference to the registered Grid.DRegularGridInputHandler implementation instance with the specified index.

Parameters
idxThe zero-based index of the Grid.DRegularGridInputHandler implementation instance to return.
Returns
A reference to the Grid.DRegularGridInputHandler implementation instance with the specified index.
Exceptions
Base.IndexErrorif idx is out of bounds.

◆ getInputHandlerByFormat()

DRegularGridInputHandler CDPL.Grid.DRegularGridIOManager.getInputHandlerByFormat ( Base.DataFormat  fmt)
static

Returns a reference to a Grid.DRegularGridInputHandler implementation instance registered for the specified data format.

Parameters
fmtSpecifies the data format that is associated with the requested Grid.DRegularGridInputHandler implementation instance.
Returns
A reference to a Grid.DRegularGridInputHandler implementation instance registered for the specified data format, or None if not available.

◆ getInputHandlerByName()

DRegularGridInputHandler CDPL.Grid.DRegularGridIOManager.getInputHandlerByName ( str  name)
static

Returns a reference to a Grid.DRegularGridInputHandler implementation instance registered for the data format with the specified name.

Parameters
nameSpecifies the name of the data format that is associated with the requested Grid.DRegularGridInputHandler implementation instance.
Returns
A reference to a Grid.DRegularGridInputHandler implementation instance registered for the data format with the specified name, or None if not available.
Note
The matching of the name is not case-sensitive.

◆ getInputHandlerByFileExtension()

DRegularGridInputHandler CDPL.Grid.DRegularGridIOManager.getInputHandlerByFileExtension ( str  file_ext)
static

Returns a reference to a Grid.DRegularGridInputHandler implementation instance registered for the data format with the specified file extension.

Parameters
file_extSpecifies the file extension of the data format that is associated with the requested Grid.DRegularGridInputHandler implementation instance.
Returns
A reference to a Grid.DRegularGridInputHandler implementation instance registered for the data format with the specified file extension, or None if not available.
Note
The matching of the file extension is not case-sensitive.

◆ getInputHandlerByMimeType()

DRegularGridInputHandler CDPL.Grid.DRegularGridIOManager.getInputHandlerByMimeType ( str  mime_type)
static

Returns a reference to a Grid.DRegularGridInputHandler implementation instance registered for the data format with the specified mime-type.

Parameters
mime_typeSpecifies the mime-type of the data format that is associated with the requested Grid.DRegularGridInputHandler implementation instance.
Returns
A reference to a Grid.DRegularGridInputHandler implementation instance registered for the data format with the specified mime-type, or None if not available.
Note
The matching of the mime-type is not case-sensitive.

◆ unregisterInputHandler() [1/3]

bool CDPL.Grid.DRegularGridIOManager.unregisterInputHandler ( Base.DataFormat  fmt)
static

Unregisters the Grid.DRegularGridInputHandler 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.

Parameters
fmtSpecifies the data format that is associated with the handler instance to unregister.
Returns
True if a handler instance for the specified data format was found and has been unregistered, and False otherwise.

◆ unregisterInputHandler() [2/3]

None CDPL.Grid.DRegularGridIOManager.unregisterInputHandler ( int  idx)
static

Unregisters the Grid.DRegularGridInputHandler implementation instance with the specified index.

Parameters
idxThe zero-based index of the Grid.DRegularGridInputHandler implementation instance to unregister.
Exceptions
Base.IndexErrorif idx is out of bounds.

◆ unregisterInputHandler() [3/3]

bool CDPL.Grid.DRegularGridIOManager.unregisterInputHandler ( DRegularGridInputHandler  handler)
static

Unregisters the specified Grid.DRegularGridInputHandler implementation instance.

Parameters
handlerThe Grid.DRegularGridInputHandler implementation instance to unregister.
Returns
True if the handler instance was found and has been unregistered, and False otherwise.

◆ getNumInputHandlers()

int CDPL.Grid.DRegularGridIOManager.getNumInputHandlers ( )
static

Returns the number of registered Grid.DRegularGridInputHandler implementation instances.

Returns
The number of registered Grid.DRegularGridInputHandler implementation instances.

◆ getInputHandlers()

InputHandlerSequence CDPL.Grid.DRegularGridIOManager.getInputHandlers ( )
static
Parameters
<br>
Returns

◆ registerOutputHandler()

None CDPL.Grid.DRegularGridIOManager.registerOutputHandler ( DRegularGridOutputHandler  handler)
static

Registers the specified Grid.DRegularGridOutputHandler implementation instance.

Parameters
handlerThe Grid.DRegularGridOutputHandler implementation instance to register.

◆ getOutputHandler()

DRegularGridOutputHandler CDPL.Grid.DRegularGridIOManager.getOutputHandler ( int  idx)
static

Returns a reference to the registered Grid.DRegularGridOutputHandler implementation instance with the specified index.

Parameters
idxThe zero-based index of the Grid.DRegularGridOutputHandler implementation instance to return.
Returns
A reference to the Grid.DRegularGridOutputHandler implementation instance with the specified index.
Exceptions
Base.IndexErrorif idx is out of bounds.

◆ getOutputHandlerByFormat()

DRegularGridOutputHandler CDPL.Grid.DRegularGridIOManager.getOutputHandlerByFormat ( Base.DataFormat  fmt)
static

Returns a reference to a Grid.DRegularGridOutputHandler implementation instance registered for the specified data format.

Parameters
fmtSpecifies the data format that is associated with the requested Grid.DRegularGridOutputHandler implementation instance.
Returns
A reference to a Grid.DRegularGridOutputHandler implementation instance registered for the specified data format, or None if not available.

◆ getOutputHandlerByName()

DRegularGridOutputHandler CDPL.Grid.DRegularGridIOManager.getOutputHandlerByName ( str  name)
static

Returns a reference to a Grid.DRegularGridOutputHandler implementation instance registered for the data format with the specified name.

Parameters
nameSpecifies the name of the data format that is associated with the requested Grid.DRegularGridOutputHandler implementation instance.
Returns
A reference to a Grid.DRegularGridOutputHandler implementation instance registered for the data format with the specified name, or None if not available.
Note
The matching of the name is not case-sensitive.

◆ getOutputHandlerByFileExtension()

DRegularGridOutputHandler CDPL.Grid.DRegularGridIOManager.getOutputHandlerByFileExtension ( str  file_ext)
static

Returns a reference to a Grid.DRegularGridOutputHandler implementation instance registered for the data format with the specified file extension.

Parameters
file_extSpecifies the file extension of the data format that is associated with the requested Grid.DRegularGridOutputHandler implementation instance.
Returns
A reference to a Grid.DRegularGridOutputHandler implementation instance registered for the data format with the specified file extension, or None if not available.
Note
The matching of the file extension is not case-sensitive.

◆ getOutputHandlerByMimeType()

DRegularGridOutputHandler CDPL.Grid.DRegularGridIOManager.getOutputHandlerByMimeType ( str  mime_type)
static

Returns a reference to a Grid.DRegularGridOutputHandler implementation instance registered for the data format with the specified mime-type.

Parameters
mime_typeSpecifies the mime-type of the data format that is associated with the requested Grid.DRegularGridOutputHandler implementation instance.
Returns
A reference to a Grid.DRegularGridOutputHandler implementation instance registered for the data format with the specified mime-type, or None if not available.
Note
The matching of the mime-type is not case-sensitive.

◆ unregisterOutputHandler() [1/3]

bool CDPL.Grid.DRegularGridIOManager.unregisterOutputHandler ( Base.DataFormat  fmt)
static

Unregisters the Grid.DRegularGridOutputHandler 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.

Parameters
fmtSpecifies the data format that is associated with the handler instance to unregister.
Returns
True if a handler instance for the specified data format was found and has been unregistered, and False otherwise.

◆ unregisterOutputHandler() [2/3]

None CDPL.Grid.DRegularGridIOManager.unregisterOutputHandler ( int  idx)
static

Unregisters the Grid.DRegularGridOutputHandler implementation instance with the specified index.

Parameters
idxThe zero-based index of the Grid.DRegularGridOutputHandler implementation instance to unregister.
Exceptions
Base.IndexErrorif idx is out of bounds.

◆ unregisterOutputHandler() [3/3]

bool CDPL.Grid.DRegularGridIOManager.unregisterOutputHandler ( DRegularGridOutputHandler  handler)
static

Unregisters the specified Grid.DRegularGridOutputHandler implementation instance.

Parameters
handlerThe Grid.DRegularGridOutputHandler implementation instance to unregister.
Returns
True if the handler instance was found and has been unregistered, and False otherwise.

◆ getNumOutputHandlers()

int CDPL.Grid.DRegularGridIOManager.getNumOutputHandlers ( )
static

Returns the number of registered Grid.DRegularGridOutputHandler implementation instances.

Returns
The number of registered Grid.DRegularGridOutputHandler implementation instances.

◆ getOutputHandlers()

OutputHandlerSequence CDPL.Grid.DRegularGridIOManager.getOutputHandlers ( )
static
Parameters
<br>
Returns