A singleton class that serves as a global registry for Pharm.PharmacophoreInputHandler and Pharm.PharmacophoreOutputHandler implementation instances. More...

Inheritance diagram for CDPL.Pharm.PharmacophoreIOManager:

Classes
class	InputHandlerSequence

class	OutputHandlerSequence

Static Public Member Functions
None	registerInputHandler (PharmacophoreInputHandler handler)
	Registers the specified Pharm.PharmacophoreInputHandler implementation instance. More...

PharmacophoreInputHandler	getInputHandler (int idx)
	Returns a reference to the registered Pharm.PharmacophoreInputHandler implementation instance with the specified index. More...

PharmacophoreInputHandler	getInputHandlerByFormat (Base.DataFormat fmt)
	Returns a reference to a Pharm.PharmacophoreInputHandler implementation instance registered for the specified data format. More...

PharmacophoreInputHandler	getInputHandlerByName (str name)
	Returns a reference to a Pharm.PharmacophoreInputHandler implementation instance registered for the data format with the specified name. More...

PharmacophoreInputHandler	getInputHandlerByFileExtension (str file_ext)
	Returns a reference to a Pharm.PharmacophoreInputHandler implementation instance registered for the data format with the specified file extension. More...

PharmacophoreInputHandler	getInputHandlerByFileName (str file_name)
	Returns a reference to a Pharm.PharmacophoreInputHandler implementation instance registered for the data format matching the extension of file_name. More...

PharmacophoreInputHandler	getInputHandlerByMimeType (str mime_type)
	Returns a reference to a Pharm.PharmacophoreInputHandler implementation instance registered for the data format with the specified mime-type. More...

bool	unregisterInputHandler (Base.DataFormat fmt)
	Unregisters the Pharm.PharmacophoreInputHandler implementation instance for the specified data format. More...

None	unregisterInputHandler (int idx)
	Unregisters the Pharm.PharmacophoreInputHandler implementation instance with the specified index. More...

bool	unregisterInputHandler (PharmacophoreInputHandler handler)
	Unregisters the specified Pharm.PharmacophoreInputHandler implementation instance. More...

int	getNumInputHandlers ()
	Returns the number of registered Pharm.PharmacophoreInputHandler implementation instances. More...

InputHandlerSequence	getInputHandlers ()

None	registerOutputHandler (object handler)
	Registers the specified Pharm.PharmacophoreOutputHandler implementation instance. More...

object	getOutputHandler (int idx)
	Returns a reference to the registered Pharm.PharmacophoreOutputHandler implementation instance with the specified index. More...

object	getOutputHandlerByFormat (Base.DataFormat fmt)
	Returns a reference to a Pharm.PharmacophoreOutputHandler implementation instance registered for the specified data format. More...

object	getOutputHandlerByName (str name)
	Returns a reference to a Pharm.PharmacophoreOutputHandler implementation instance registered for the data format with the specified name. More...

object	getOutputHandlerByFileExtension (str file_ext)
	Returns a reference to a Pharm.PharmacophoreOutputHandler implementation instance registered for the data format with the specified file extension. More...

object	getOutputHandlerByFileName (str file_name)
	Returns a reference to a Pharm.PharmacophoreOutputHandler implementation instance registered for the data format matching the extension of file_name. More...

object	getOutputHandlerByMimeType (str mime_type)
	Returns a reference to a Pharm.PharmacophoreOutputHandler implementation instance registered for the data format with the specified mime-type. More...

bool	unregisterOutputHandler (Base.DataFormat fmt)
	Unregisters the Pharm.PharmacophoreOutputHandler implementation instance for the specified data format. More...

None	unregisterOutputHandler (int idx)
	Unregisters the Pharm.PharmacophoreOutputHandler implementation instance with the specified index. More...

bool	unregisterOutputHandler (object handler)
	Unregisters the specified Pharm.PharmacophoreOutputHandler implementation instance. More...

int	getNumOutputHandlers ()
	Returns the number of registered Pharm.PharmacophoreOutputHandler implementation instances. More...

OutputHandlerSequence	getOutputHandlers ()

Static Public Attributes
	inputHandlers = _HIDDEN_VALUE_

int	numInputHandlers = 5

	outputHandlers = _HIDDEN_VALUE_

int	numOutputHandlers = 0

Detailed Description

A singleton class that serves as a global registry for Pharm.PharmacophoreInputHandler and Pharm.PharmacophoreOutputHandler implementation instances.

DataIOManager provides static methods for the registration and lookup of Pharm.PharmacophoreInputHandler and Pharm.PharmacophoreOutputHandler 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.Pharm.PharmacophoreIOManager.registerInputHandler ( PharmacophoreInputHandler handler )

static

Registers the specified Pharm.PharmacophoreInputHandler implementation instance.

Parameters

handler The Pharm.PharmacophoreInputHandler implementation instance to register.

◆ getInputHandler()

PharmacophoreInputHandler CDPL.Pharm.PharmacophoreIOManager.getInputHandler ( int idx )

static

Returns a reference to the registered Pharm.PharmacophoreInputHandler implementation instance with the specified index.

Parameters

idx	The zero-based index of the Pharm.PharmacophoreInputHandler implementation instance to return.

Returns: A reference to the Pharm.PharmacophoreInputHandler implementation instance with the specified index.

Exceptions

Base.IndexError if idx is out of bounds.

◆ getInputHandlerByFormat()

PharmacophoreInputHandler CDPL.Pharm.PharmacophoreIOManager.getInputHandlerByFormat ( Base.DataFormat fmt )

static

Returns a reference to a Pharm.PharmacophoreInputHandler implementation instance registered for the specified data format.

Parameters

fmt	Specifies the data format that is associated with the requested Pharm.PharmacophoreInputHandler implementation instance.

Returns: A reference to a Pharm.PharmacophoreInputHandler implementation instance registered for the specified data format, or None if not available.

◆ getInputHandlerByName()

PharmacophoreInputHandler CDPL.Pharm.PharmacophoreIOManager.getInputHandlerByName ( str name )

static

Returns a reference to a Pharm.PharmacophoreInputHandler implementation instance registered for the data format with the specified name.

Parameters

name	Specifies the name of the data format that is associated with the requested Pharm.PharmacophoreInputHandler implementation instance.

Returns: A reference to a Pharm.PharmacophoreInputHandler 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()

PharmacophoreInputHandler CDPL.Pharm.PharmacophoreIOManager.getInputHandlerByFileExtension ( str file_ext )

static

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

Parameters

file_ext Specifies the file extension of the data format that is associated with the requested Pharm.PharmacophoreInputHandler implementation instance.

Returns: A reference to a Pharm.PharmacophoreInputHandler 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.

◆ getInputHandlerByFileName()

PharmacophoreInputHandler CDPL.Pharm.PharmacophoreIOManager.getInputHandlerByFileName ( str file_name )

static

Returns a reference to a Pharm.PharmacophoreInputHandler implementation instance registered for the data format matching the extension of file_name.

Parameters

file_name Specifies the file name for which to search for a data format that matches its extension.

Returns: A reference to a Pharm.PharmacophoreInputHandler implementation instance registered for the data format matching the extension of file_name, or None if not available.

Note: The matching of the file extension is not case-sensitive.

◆ getInputHandlerByMimeType()

PharmacophoreInputHandler CDPL.Pharm.PharmacophoreIOManager.getInputHandlerByMimeType ( str mime_type )

static

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

Parameters

mime_type Specifies the mime-type of the data format that is associated with the requested Pharm.PharmacophoreInputHandler implementation instance.

Returns: A reference to a Pharm.PharmacophoreInputHandler 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.Pharm.PharmacophoreIOManager.unregisterInputHandler ( Base.DataFormat fmt )

static

Unregisters the Pharm.PharmacophoreInputHandler 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

fmt	Specifies 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.Pharm.PharmacophoreIOManager.unregisterInputHandler ( int idx )

static

Unregisters the Pharm.PharmacophoreInputHandler implementation instance with the specified index.

Parameters

idx	The zero-based index of the Pharm.PharmacophoreInputHandler implementation instance to unregister.

Exceptions

Base.IndexError if idx is out of bounds.

◆ unregisterInputHandler() [3/3]

bool CDPL.Pharm.PharmacophoreIOManager.unregisterInputHandler ( PharmacophoreInputHandler handler )

static

Unregisters the specified Pharm.PharmacophoreInputHandler implementation instance.

Parameters

handler The Pharm.PharmacophoreInputHandler implementation instance to unregister.

Returns: True if the handler instance was found and has been unregistered, and False otherwise.

◆ getNumInputHandlers()

int CDPL.Pharm.PharmacophoreIOManager.getNumInputHandlers ( )

static

Returns the number of registered Pharm.PharmacophoreInputHandler implementation instances.

Returns: The number of registered Pharm.PharmacophoreInputHandler implementation instances.

◆ getInputHandlers()

InputHandlerSequence CDPL.Pharm.PharmacophoreIOManager.getInputHandlers ( )

static

Parameters

<br>

Returns

◆ registerOutputHandler()

None CDPL.Pharm.PharmacophoreIOManager.registerOutputHandler ( object handler )

static

Registers the specified Pharm.PharmacophoreOutputHandler implementation instance.

Parameters

handler The Pharm.PharmacophoreOutputHandler implementation instance to register.

◆ getOutputHandler()

object CDPL.Pharm.PharmacophoreIOManager.getOutputHandler ( int idx )

static

Returns a reference to the registered Pharm.PharmacophoreOutputHandler implementation instance with the specified index.

Parameters

idx	The zero-based index of the Pharm.PharmacophoreOutputHandler implementation instance to return.

Returns: A reference to the Pharm.PharmacophoreOutputHandler implementation instance with the specified index.

Exceptions

Base.IndexError if idx is out of bounds.

◆ getOutputHandlerByFormat()

object CDPL.Pharm.PharmacophoreIOManager.getOutputHandlerByFormat ( Base.DataFormat fmt )

static

Returns a reference to a Pharm.PharmacophoreOutputHandler implementation instance registered for the specified data format.

Parameters

fmt	Specifies the data format that is associated with the requested Pharm.PharmacophoreOutputHandler implementation instance.

Returns: A reference to a Pharm.PharmacophoreOutputHandler implementation instance registered for the specified data format, or None if not available.

◆ getOutputHandlerByName()

object CDPL.Pharm.PharmacophoreIOManager.getOutputHandlerByName ( str name )

static

Returns a reference to a Pharm.PharmacophoreOutputHandler implementation instance registered for the data format with the specified name.

Parameters

name	Specifies the name of the data format that is associated with the requested Pharm.PharmacophoreOutputHandler implementation instance.

Returns: A reference to a Pharm.PharmacophoreOutputHandler 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()

object CDPL.Pharm.PharmacophoreIOManager.getOutputHandlerByFileExtension ( str file_ext )

static

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

Parameters

file_ext Specifies the file extension of the data format that is associated with the requested Pharm.PharmacophoreOutputHandler implementation instance.

Returns: A reference to a Pharm.PharmacophoreOutputHandler 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.

◆ getOutputHandlerByFileName()

object CDPL.Pharm.PharmacophoreIOManager.getOutputHandlerByFileName ( str file_name )

static

Returns a reference to a Pharm.PharmacophoreOutputHandler implementation instance registered for the data format matching the extension of file_name.

Parameters

file_name Specifies the file name for which to search for a data format that matches its extension.

Returns: A reference to a Pharm.PharmacophoreOutputHandler implementation instance registered for the data format matching the extension of file_name, or None if not available.

Note: The matching of the file extension is not case-sensitive.

◆ getOutputHandlerByMimeType()

object CDPL.Pharm.PharmacophoreIOManager.getOutputHandlerByMimeType ( str mime_type )

static

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

Parameters

mime_type Specifies the mime-type of the data format that is associated with the requested Pharm.PharmacophoreOutputHandler implementation instance.

Returns: A reference to a Pharm.PharmacophoreOutputHandler 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.Pharm.PharmacophoreIOManager.unregisterOutputHandler ( Base.DataFormat fmt )

static

Unregisters the Pharm.PharmacophoreOutputHandler 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

fmt	Specifies 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.Pharm.PharmacophoreIOManager.unregisterOutputHandler ( int idx )

static

Unregisters the Pharm.PharmacophoreOutputHandler implementation instance with the specified index.

Parameters

idx	The zero-based index of the Pharm.PharmacophoreOutputHandler implementation instance to unregister.

Exceptions

Base.IndexError if idx is out of bounds.

◆ unregisterOutputHandler() [3/3]

bool CDPL.Pharm.PharmacophoreIOManager.unregisterOutputHandler ( object handler )

static

Unregisters the specified Pharm.PharmacophoreOutputHandler implementation instance.

Parameters

handler The Pharm.PharmacophoreOutputHandler implementation instance to unregister.

Returns: True if the handler instance was found and has been unregistered, and False otherwise.

◆ getNumOutputHandlers()

int CDPL.Pharm.PharmacophoreIOManager.getNumOutputHandlers ( )

static

Returns the number of registered Pharm.PharmacophoreOutputHandler implementation instances.

Returns: The number of registered Pharm.PharmacophoreOutputHandler implementation instances.

◆ getOutputHandlers()

OutputHandlerSequence CDPL.Pharm.PharmacophoreIOManager.getOutputHandlers ( )

static

Parameters

<br>

Returns

Classes

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ registerInputHandler()

◆ getInputHandler()

◆ getInputHandlerByFormat()

◆ getInputHandlerByName()

◆ getInputHandlerByFileExtension()

◆ getInputHandlerByFileName()

◆ getInputHandlerByMimeType()

◆ unregisterInputHandler() [1/3]

◆ unregisterInputHandler() [2/3]

◆ unregisterInputHandler() [3/3]

◆ getNumInputHandlers()

◆ getInputHandlers()

◆ registerOutputHandler()

◆ getOutputHandler()

◆ getOutputHandlerByFormat()

◆ getOutputHandlerByName()

◆ getOutputHandlerByFileExtension()

◆ getOutputHandlerByFileName()

◆ getOutputHandlerByMimeType()

◆ unregisterOutputHandler() [1/3]

◆ unregisterOutputHandler() [2/3]

◆ unregisterOutputHandler() [3/3]

◆ getNumOutputHandlers()

◆ getOutputHandlers()