Chemical Data Processing Library Python API - Version 1.3.0
Public Member Functions | Properties | List of all members
CDPL.Vis.Object3DOutputHandler Class Reference
+ Inheritance diagram for CDPL.Vis.Object3DOutputHandler:

Public Member Functions

None __init__ ()
 Initializes the Object3DOutputHandler instance.
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
Base.DataFormat getDataFormat ()
 
Object3DWriterBase createWriter (Base.OStream os)
 
Object3DWriterBase createWriter (str file_name, OpenMode mode=Base.IOStream.OpenMode(60))
 

Properties

 objectID = property(getObjectID)
 

Member Function Documentation

◆ getObjectID()

int CDPL.Vis.Object3DOutputHandler.getObjectID ( )

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

Different Python Object3DOutputHandler 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 Object3DOutputHandler 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.Vis.Object3DOutputHandler.getDataFormat ( )
Returns

◆ createWriter() [1/2]

Object3DWriterBase CDPL.Vis.Object3DOutputHandler.createWriter ( Base.OStream  os)
Parameters
os
Returns

◆ createWriter() [2/2]

Object3DWriterBase CDPL.Vis.Object3DOutputHandler.createWriter ( str  file_name,
OpenMode   mode = Base.IOStream.OpenMode(60) 
)
Parameters
file_name
mode
Returns