fioblisswriter package

Submodules

fioblisswriter.FIOFile module

Provides the access to a database with NDTS configuration files

class fioblisswriter.FIOFile.FIOFile(scan, fpath, streams, skip_final_parameters=False, max_string_parameter_size=300, snapshot_blacklist=None, max_write_interval=1)[source]

Bases: object

constructor

Parameters:

  • scan (blissdata.redis_engine.scan.Scan) – blissdata scan

  • fpath (pathlib.Path) – nexus file path

  • streams (StreamSet or tango.LatestDeviceImpl) – tango-like steamset class

  • max_write_interval (int) – max write interval

property channels
close()[source]

close file

create_file_structure()[source]

create nexus structure

property labels
prepareChannels()[source]

prepare cursors

snapshot_keys()[source]
write_final_snapshot()[source]

write final data

write_init_snapshot()[source]

write inits data

write_mca_file(mca_values, ct_values, npoints)[source]
write_scan_points()[source]

write step data

fioblisswriter.FIOFile.create_fio_file(scan, streams, skip_final_parameters=False, max_string_parameter_size=300, snapshot_blacklist=None)[source]

open fio file

Parameters:

  • scan (blissdata.redis_engine.scan.Scan) – blissdata scan

  • streams (StreamSet or tango.LatestDeviceImpl) – tango-like steamset class

Returns:

nexus file object

Return type:

FIOFile

fioblisswriter.Release module

release version module

fioblisswriter.FIOBlissWriter module

FIO Bliss Writer

FIO Bliss Writer stores (meta)data from blissdata provided by FIODataWriter

class fioblisswriter.FIOBlissWriter.FIOBlissWriter(cl, name)[source]

Bases: Device

FIO Bliss Writer stores (meta)data from blissdata provided by FIODataWriter

Properties:

  • Device Property
    RedisUrl

    • Dlissdata redis url

    • Type:’str’

    Session

    • session to be recorder

    • Type:’str’

    NextScanTimeout

    • timeout for next scan writing

    • Type:’int’

    SkipFinalParameters

    • do not store parameters with the FINAL strategy

    • Type:’bool’

    MaxStringParameterSize

    • maximal value size of string parameters

    • Type:’int’

    SnapshotBlacklist

    • a list of snapshot keys to skip

    • Type:’DevVarStringArray’

    PointSleepTime

    • sleep time between write_point command calls

    • Type:’float’

Errors

list of errors

MaxStringParameterSize

maximal value size of string parameters

NextScanTimeout

timeout for next scan writing

PointSleepTime

sleep time between write_point command calls

RedisUrl

Blissdata redis url

Session

session to be recorder

SkipFinalParameters

do not store parameters with the FINAL strategy

SnapshotBlacklist

a list of snapshot keys to skip

Start()[source]

‘Start’ TANGO command

Parameters:

arg (DevVoid) – (not documented)

Returns:

(not documented)

Return type:

DevVoid

Stop()[source]

‘Stop’ TANGO command

Parameters:

arg (DevVoid) – (not documented)

Returns:

(not documented)

Return type:

DevVoid

TangoClassClass

alias of FIOBlissWriterClass

TangoClassName = 'FIOBlissWriter'
delete_device()[source]

Destructs the attributes and properties of the FIOBlissWriter.

dev_status(self) → str[source]

Get device status.

Default method to get device status. It returns the contents of the device dev_status field. If the device state is ALARM, alarm messages are added to the device status. This method can be redefined in sub-classes in case of the default behaviour does not fullfill the needs.

Returns:

the device status

Return type:

str

Raises:

DevFailed – If it is necessary to read attribute(s) and a problem occurs during the reading

init_device()[source]

Initializes the attributes and properties of the FIOBlissWriter.

read_Errors()[source]

fioblisswriter.FIOWriterService module

Provides the access to a database with NDTS configuration files

class fioblisswriter.FIOWriterService.FIOWriterService(redis_url, session, next_scan_timeout, skip_final_parameters=False, max_string_parameter_size=300, snapshot_blacklist=None, point_sleep_time=0.01, server=None)[source]

Bases: object

constructor

Parameters:

  • redis_url (str) – blissdata redis url

  • session (str) – blissdata session name

  • next_scan_timeout (int) – timeout between the scans in seconds

  • skip_final_parameters (bool) – skip final parameters

  • max_string_parameter_size (int) – maximal string parameter size

  • snapshotblacklist (list <str>) – snapshot blacklist

  • point_sleep_time (float) – sleep time between write point calls

  • server (tango.LatestDeviceImpl) – NXSConfigServer instance

errors()[source]

list of errors

get_status()[source]

get writer service status

join_scans(stop=False)[source]

join scans which are stopped

Parameters:

stop (bool) – stop all scans flag

start()[source]

start writer service

stop()[source]

stop writer service

class fioblisswriter.FIOWriterService.ScanWriter(scan, streams, next_scan_timeout, skip_final_parameters=False, max_string_parameter_size=300, snapshot_blacklist=None, point_sleep_time=0.01)[source]

Bases: Thread

constructor

Parameters:

  • scan (Scan) – blissdata redis url

  • streams (StreamSet or tango.LatestDeviceImpl) – tango streams

  • next_scan_timeout (int) – timeout between the scans in seconds

  • skip_final_parameters (bool) – skip final parameters

  • max_string_parameter_size (int) – maximal string parameter size

  • snapshotblacklist (list <str>) – snapshot blacklist

  • point_sleep_time (float) – sleep time between write point calls

  • server (tango.LatestDeviceImpl) – NXSConfigServer instance

error

(bool) service error flag

error_lock

(threading.Lock) threading lock

run()[source]

write scan data

running

(bool) service running flag

fioblisswriter.FIOWriterService.main()[source]

main function

Module contents

Implementation of FIO Blissdata writer Server