CASP Python Libraries
This documentation primarily focuses on the usage of functions from 'casp', 'casp_be', 'casp_gpio' and 'casp_udio' namespaces.
Loading...
Searching...
No Matches
_casp_process.CaspBlockViewerProcess Class Reference

CaspBlockViewerProcess class provides interfaces to start and terminate 'BlockViewer' executable as a subprocess. More...

Public Member Functions

 init (self, str casp_file="BlockViewer")
 Starts a subprocess for 'BlockViewer' executable with command line interface (CLI) enabled.
 close (self)
 Closes or terminates the subprocess and waits till subprocess is terminated before returning.

Detailed Description

CaspBlockViewerProcess class provides interfaces to start and terminate 'BlockViewer' executable as a subprocess.

The 'BlockViewer' executable is used to browse CASP blocks. A global object of this class casp_bv_proc is also created in this module. It is used by upper level interfaces from casp.py module to invoke the block viewer executable.

Definition at line 159 of file _casp_process.py.

Member Function Documentation

◆ init()

_casp_process.CaspBlockViewerProcess.init ( self,
str casp_file = "BlockViewer" )

Starts a subprocess for 'BlockViewer' executable with command line interface (CLI) enabled.

Arguments:

casp_file: allows user to specify different version of 'BlockViewer' executable when required. In most cases this argument is not required to be specified by the user.

Definition at line 164 of file _casp_process.py.

◆ close()

_casp_process.CaspBlockViewerProcess.close ( self)

Closes or terminates the subprocess and waits till subprocess is terminated before returning.

Definition at line 182 of file _casp_process.py.


The documentation for this class was generated from the following file: