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

A factory interface providing methods for the creation of Grid.DRegularGridSetWriterBase instances for data output in a particular storage format. More...

+ Inheritance diagram for CDPL.Grid.DRegularGridSetOutputHandler:

Public Member Functions

None __init__ ()
 Initializes the DRegularGridSetOutputHandler 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 output data format. More...
 
DRegularGridSetWriterBase createWriter (Base.IOStream ios)
 Creates a DRegularGridSetWriterBase instance that will write the data to the I/O stream ios. More...
 
DRegularGridSetWriterBase createWriter (str file_name, OpenMode mode=Base.IOStream.OpenMode(60))
 Creates a DRegularGridSetWriterBase instance that will write the data to the file specified by file_name. More...
 

Properties

 objectID = property(getObjectID)
 

Detailed Description

A factory interface providing methods for the creation of Grid.DRegularGridSetWriterBase instances for data output in a particular storage format.

Member Function Documentation

◆ getObjectID()

int CDPL.Grid.DRegularGridSetOutputHandler.getObjectID ( )

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

Different Python DRegularGridSetOutputHandler 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 DRegularGridSetOutputHandler 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.DRegularGridSetOutputHandler.getDataFormat ( )

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

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

◆ createWriter() [1/2]

DRegularGridSetWriterBase CDPL.Grid.DRegularGridSetOutputHandler.createWriter ( Base.IOStream  ios)

Creates a DRegularGridSetWriterBase instance that will write the data to the I/O stream ios.

Parameters
iosThe I/O stream to write to.
Returns
The created DRegularGridSetWriterBase instance.

◆ createWriter() [2/2]

DRegularGridSetWriterBase CDPL.Grid.DRegularGridSetOutputHandler.createWriter ( str  file_name,
OpenMode   mode = Base.IOStream.OpenMode(60) 
)

Creates a DRegularGridSetWriterBase instance that will write the data to the file specified by file_name.

Parameters
file_nameThe full path of the file to write to.
modeFlags specifying the file open-mode.
Returns
The created DRegularGridSetWriterBase instance.