evedata.scan.entities.file module

Entities representing an SCML file on the entire file level.

Overview

A first overview of the classes implemented in this module and their hierarchy is given in the UML diagram below.

Fig. 46 Class hierarchy of the scan.entities.file module, closely resembling the schema of the SCML file. Currently, the location of the Plugin class and its dependencies is not decided, as it is not entirely clear whether this information is relevant enough to be mapped.

Important

Note that for the time being, only a subset of the classes shown in the above UML diagram are implemented, and only the most relevant attributes of these classes.

Module documentation

class evedata.scan.entities.file.File

Bases: object

Representation of all information available from a given SCML file.

An SCML file usually consists of a series of metadata, a scan block with the scan description, and a setup part with information of the detectors, motors, and devices used in a scan or available at a measurement station.

The schema of the SCML file is defined in an XML schema definition (XSD) file. Furthermore, there exist several versions of the SCML schema the entities of the entities subpackage are not concerned with.

location

Name of the measurement station the scan was executed at.

Type:

str

scan

Representation of all information available for the scan.

Type:

evedata.scan.entities.scan.Scan

Examples

The File class is not meant to be used directly, as any entities, but rather indirectly by means of the respective facades in the boundaries technical layer of the evedata.scan subpackage. Hence, for the time being, there are no dedicated examples how to use this class. Of course, you can instantiate an object as usual.