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

Inheritance diagram for CDPL.Chem.ReactionOutputHandler:

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

ReactionWriterBase	createWriter (Base.IOStream ios)
	Creates a ReactionWriterBase instance that will write the data to the I/O stream ios. More...

ReactionWriterBase	createWriter (str file_name, OpenMode mode=Base.IOStream.OpenMode(60))
	Creates a ReactionWriterBase 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 Chem.ReactionWriterBase instances for data output in a particular storage format.

Member Function Documentation

◆ getObjectID()

int CDPL.Chem.ReactionOutputHandler.getObjectID ( )

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

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

ReactionWriterBase CDPL.Chem.ReactionOutputHandler.createWriter ( Base.IOStream ios )

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

Parameters

ios	The I/O stream to write to.

Returns: The created ReactionWriterBase instance.

◆ createWriter() [2/2]

ReactionWriterBase CDPL.Chem.ReactionOutputHandler.createWriter	(	str	file_name,
		OpenMode	mode = `Base.IOStream.OpenMode(60)`
	)

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