dectris.albula.DEigerFileWriter Class Reference

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

Public Member Functions
def	DEigerFileWriter (host, port=80)
	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 (enabled)
	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 (fileName)
	Remove file from server. More...
def	download (fileName, targetDir)
	Download file More...

Detailed Description

class DEigerFileWriter provides access to the EIGER filewriter module.

Constructor & Destructor Documentation

DEigerFileWriter()

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

Contruct DEigerFileWriter that connects to host and port.

Parameters

host	String containing the host name or IP address of the Eiger server.
port	Integer containing the port number of the Eiger server.

Member Function Documentation

download()

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

Download file

Parameters

fileName	String. File on server to be downloaded
targetDir	String. Target director, the directory where the downloaded file is stored.

Returns

Number of bytes downloaded

enabled()

def dectris.albula.DEigerFileWriter.enabled

(

)

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

Returns

True or False

listFiles()

def dectris.albula.DEigerFileWriter.listFiles

(

)

List all files that are available on the server

Returns

List of all available files

remove()

def dectris.albula.DEigerFileWriter.remove

(

fileName

)

Remove file from server.

Parameters

fileName

String

setEnabled()

def dectris.albula.DEigerFileWriter.setEnabled

(

enabled

)

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

Parameters

enabled

True or False

version()

def dectris.albula.DEigerFileWriter.version

(

)

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

Returns

String