ALBULA  4.0.1
 All Classes Namespaces Functions Variables Pages
dectris.albula.DEigerFileWriter Class Reference

class DEigerFileWriter provides access to the EIGER filewriter module. More...

Public Member Functions

def DEigerFileWriter
 Contruct DEigerFileWriter that connects to host and port. More...
 
def version
 Get the API version of the filewriter interface from the Eiger server. More...
 
def enabled
 Return True (False) if the filewriter interface on the Eiger server is enabled (disabled) More...
 
def setEnabled
 Enable (disable) the filewriter interface on the Eiger server by passing True (False) More...
 
def listFiles
 List all files that are available on the server. More...
 
def remove
 Remove file from server. More...
 
def download
 Download file. More...
 

Detailed Description

class DEigerFileWriter provides access to the EIGER filewriter module.

Constructor & Destructor Documentation

def dectris.albula.DEigerFileWriter.DEigerFileWriter (   host,
  port = 80 
)

Contruct DEigerFileWriter that connects to host and port.

Parameters
hostString containing the host name or IP address of the Eiger server.
portInteger containing the port number of the Eiger server.

Member Function Documentation

def dectris.albula.DEigerFileWriter.download (   fileName,
  targetDir 
)

Download file.

Parameters
fileNameString. File on server to be downloaded
targetDirString. Target director, the directory where the downloaded file is stored.
Returns
Number of bytes downloaded
def dectris.albula.DEigerFileWriter.enabled ( )

Return True (False) if the filewriter interface on the Eiger server is enabled (disabled)

Returns
True or False
def dectris.albula.DEigerFileWriter.listFiles ( )

List all files that are available on the server.

Returns
List of all available files
def dectris.albula.DEigerFileWriter.remove (   fileName)

Remove file from server.

Parameters
fileNameString
def dectris.albula.DEigerFileWriter.setEnabled (   enabled)

Enable (disable) the filewriter interface on the Eiger server by passing True (False)

Parameters
enabledTrue or False
def dectris.albula.DEigerFileWriter.version ( )

Get the API version of the filewriter interface from the Eiger server.

Returns
String