File Writer Interface

class py4syn.writing.FileWriter.FileWriter(fileName)

Class to be inherited by all data output classes in order to be transparently used in scan functions.

By default some informations such as username, start and end timestamp, command and others are already filled by the scan routines using the getters and setters bellow.

Constructor

Parameters:

fileName : string

The output filename

close()

Abstract method called at the end of the process.

getCommand()

Returns the command.

Returns:

`string`

getComments()

Returns the comments list.

Returns:

`list`

getDataSize()

Returns the data size in number of lines.

Returns:

`int`

getDevices()

Returns the list of devices mnemonics.

Returns:

`list`

getDevicesData()

Returns the map containing all devices data in a map where the device mnemonic is the key and the values are an array.

Returns:

`map`

getEndDate()

Returns the process end timestamp.

Returns:

`string`

getFileName()

Returns the filename in use.

Returns:

`string`

getSignals()

Returns the list of signals mnemonics.

Returns:

`list`

getSignalsData()

Returns the map containing all signals data in a map where the device mnemonic is the key and the values are an array.

Returns:

`map`

getStartDate()

Returns the process start timestamp.

Returns:

`string`

getUsername()

Returns the username.

Returns:

`string`

insertComment(value)

Insert a new comment in the list

Parameters:

value : string

Comment information

insertDevice(value)

Insert a new device in the list

Parameters:

value : string

Device mnemonic

insertDeviceData(device, value)

Insert a new data value for the informed device in the map.

Parameters:

device : string

Device mnemonic

value : float, int, str, etc

Collected value

insertSignal(value)

Insert a new signal in the list

Parameters:

value : string

Signal mnemonic

insertSignalData(signal, value)

Insert a new data value for the informed signal in the map.

Parameters:

signal : string

Signal mnemonic

value : float, int, str, etc

Collected value

setCommand(value)

Set the command information

Parameters:

value : string

Command information

setComments(value)

Set the comments list

Parameters:

value : list

Comments list

setDataSize(value)

Set the data size in number of lines

Parameters:

value : int

Data size

setDevices(value)

Set the devices list

Parameters:

value : list

Devices Mnemonic list

setDevicesData(value)

Set the devices data map

Parameters:

value : map

Devices data map

setEndDate(value)

Set the end date

Parameters:

value : string

Date when the process finished

setSignals(value)

Set the signals list

Parameters:

value : list

Signals Mnemonic list

setSignalsData(value)

Set the signals data map

Parameters:

value : map

Signals data map

setStartDate(value)

Set the start date

Parameters:

value : string

Date when the process started

setUsername(value)

Set the username information

Parameters:

value : string

Username information

writeData(partial=False, idx=-1)

Abstract method to start the data write process.

Parameters:

channel : int

If partial is True it means that only data at position idx must be written. Otherwise this function must write all data.

idx : int

The data index to be saved

writeHeader()

Abstract method to start the header write process.