Chemical Data Processing Library Python API - Version 1.1.1
Public Member Functions | Properties | List of all members
CDPL.Grid.DRegularGridSetInputHandler Class Reference

A factory interface providing methods for the creation of Grid.DRegularGridSetReaderBase instances for reading data provided in a particular storage format. More...

+ Inheritance diagram for CDPL.Grid.DRegularGridSetInputHandler:

Public Member Functions

None __init__ ()
 Initializes the DRegularGridSetInputHandler instance.
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
Base.DataFormat getDataFormat ()
 Returns a Base.DataFormat object that provides information about the handled input data format. More...
 
DRegularGridSetReaderBase createReader (Base.IStream is)
 Creates a DRegularGridSetReaderBase instance that will read the data from the input stream is. More...
 
DRegularGridSetReaderBase createReader (str file_name, OpenMode mode=Base.IOStream.OpenMode(12))
 Creates a DRegularGridSetReaderBase instance that will read the data from the file specified by file_name. More...
 

Properties

 objectID = property(getObjectID)
 

Detailed Description

A factory interface providing methods for the creation of Grid.DRegularGridSetReaderBase instances for reading data provided in a particular storage format.

Member Function Documentation

◆ getObjectID()

int CDPL.Grid.DRegularGridSetInputHandler.getObjectID ( )

Returns the numeric identifier (ID) of the wrapped C++ class instance.

Different Python DRegularGridSetInputHandler instances may reference the same underlying C++ class instance. The commonly used Python expression a is not b thus cannot tell reliably whether the two DRegularGridSetInputHandler instances a and b reference different C++ objects. The numeric identifier returned by this method allows to correctly implement such an identity test via the simple expression a.getObjectID() != b.getObjectID().

Returns
The numeric ID of the internally referenced C++ class instance.

◆ getDataFormat()

Base.DataFormat CDPL.Grid.DRegularGridSetInputHandler.getDataFormat ( )

Returns a Base.DataFormat object that provides information about the handled input data format.

Returns
A Base.DataFormat object that provides information about the handled data format.

◆ createReader() [1/2]

DRegularGridSetReaderBase CDPL.Grid.DRegularGridSetInputHandler.createReader ( Base.IStream  is)

Creates a DRegularGridSetReaderBase instance that will read the data from the input stream is.

Parameters
isThe input stream to read from.
Returns
The created DRegularGridSetReaderBase instance.

◆ createReader() [2/2]

DRegularGridSetReaderBase CDPL.Grid.DRegularGridSetInputHandler.createReader ( str  file_name,
OpenMode   mode = Base.IOStream.OpenMode(12) 
)

Creates a DRegularGridSetReaderBase instance that will read the data from the file specified by file_name.

Parameters
file_nameThe full path of the file to read from.
modeFlags specifying the file open-mode.
Returns
The created DRegularGridSetReaderBase instance.