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

Inheritance diagram for CDPL.Grid.DRegularGridInputHandler:

Public Member Functions
None	__init__ ()
	Initializes the DRegularGridInputHandler 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...

DRegularGridReaderBase	createReader (Base.IStream is)
	Creates a DRegularGridReaderBase instance that will read the data from the input stream is. More...

DRegularGridReaderBase	createReader (str file_name, OpenMode mode=Base.IOStream.OpenMode(12))
	Creates a DRegularGridReaderBase 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.DRegularGridReaderBase instances for reading data provided in a particular storage format.

Member Function Documentation

◆ getObjectID()

int CDPL.Grid.DRegularGridInputHandler.getObjectID ( )

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

Different Python DRegularGridInputHandler 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 DRegularGridInputHandler 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.DRegularGridInputHandler.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]

DRegularGridReaderBase CDPL.Grid.DRegularGridInputHandler.createReader ( Base.IStream is )

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

Parameters

is	The input stream to read from.

Returns: The created DRegularGridReaderBase instance.

◆ createReader() [2/2]

DRegularGridReaderBase CDPL.Grid.DRegularGridInputHandler.createReader	(	str	file_name,
		OpenMode	mode = `Base.IOStream.OpenMode(12)`
	)

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