mxcubecore.HardwareObjects.XSDataCommon

Functions

checkType(_strClassName, _strMethodName, ...)
showIndent(outfile, level)
warnEmptyAttribute(_strName, _strTypeName)

Classes

MixedContainer(category, content_type, name, ...)
XSConfiguration([XSPluginList])
XSData()
XSDataAbsorbedDoseRate([value, unit, error])	These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.
XSDataAngle([value, unit, error])
XSDataAngularSpeed([value, unit, error])	These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.
XSDataArray([size, shape, md5sum, dtype, ...])	md5 checksum has to be calculated on the decoded data, not the encoded one.
XSDataBoolean([value])	These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.
XSDataDate([value])	These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.
XSDataDictionary([keyValuePair])
XSDataDisplacement([value, unit, error])	These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.
XSDataDouble([value])	These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.
XSDataDoubleWithUnit([value, unit, error])
XSDataExecutionInfo([workingDirectory, ...])	This class contains details of the execution of a particular plugin.
XSDataFile([path])	These objects use the simple objects described above to create useful structures for the rest for the data model.
XSDataFloat([value])	These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.
XSDataFlux([value, unit, error])	These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.
XSDataImage([path, number, date])	These objects use the simple objects described above to create useful structures for the rest for the data model.
XSDataInput([configuration])	All plugin input and result classes should be derived from these two classes.
XSDataInteger([value])	These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.
XSDataKeyValuePair([value, key])
XSDataLength([value, unit, error])	These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.
XSDataLinearDisplacement([value, unit, error])
XSDataMatrix([m33, m32, m31, m23, m22, m21, ...])	XSDataMatrix is deprecated and should be replaced with XSDataMatrixDouble.
XSDataMatrixDouble([m33, m32, m31, m23, ...])	These are compound object used for linear algebra operations.
XSDataMatrixInteger([m33, m32, m31, m23, ...])	These are compound object used for linear algebra operations.
XSDataMessage([type, text, level, debuginfo])	This message class is used (amongst other messages) for warning and error messages.
XSDataResult([status])	All plugin input and result classes should be derived from these two classes.
XSDataRotation([q3, q2, q1, q0])	These are compound object used for linear algebra operations.
XSDataSize([z, y, x])	These objects use the simple objects described above to create useful structures for the rest for the data model.
XSDataSpeed([value, unit, error])	These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.
XSDataStatus([message, isSuccess, ...])	This class contains all data related to the execution of a plugin.
XSDataString([value])	These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.
XSDataSysteminfo([virtualMachine, userName, ...])	This class contains information about the system executing the plugin.
XSDataTime([value, unit, error])	These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.
XSDataUnitVector([v3, v2, v1])	<<Invariant>> {abs(v1**2.0 + v3**2.0-1.0) < epsilon}
XSDataVectorDouble([v3, v2, v1])	These are compound object used for linear algebra operations.
XSDataVectorInteger([v3, v2, v1])	These are compound object used for linear algebra operations.
XSDataWavelength([value, unit, error])	These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.
XSOptionItem([name, enabled])
XSOptionList([XSOptionItem])
XSParamItem([value, name])
XSParamList([XSParamItem])
XSPluginItem([name, XSParamList, XSOptionList])
XSPluginList([XSPluginItem])

class mxcubecore.HardwareObjects.XSDataCommon.XSDataAbsorbedDoseRate(value=None, unit=None, error=None)

Bases: XSDataDoubleWithUnit

These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.

class mxcubecore.HardwareObjects.XSDataCommon.XSDataAngle(value=None, unit=None, error=None)

Bases: XSDataDisplacement

class mxcubecore.HardwareObjects.XSDataCommon.XSDataAngularSpeed(value=None, unit=None, error=None)

Bases: XSDataDoubleWithUnit

These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.

class mxcubecore.HardwareObjects.XSDataCommon.XSDataArray(size=None, shape=None, md5sum=None, dtype=None, data=None, coding=None)

Bases: XSData

md5 checksum has to be calculated on the decoded data, not the encoded one. Default encoding is “base64” default byte order is “little-endian” (intel) not “big-endian” (java)

property coding

Property for coding

property data

Property for data

property dtype

Property for dtype

property md5sum

Property for md5sum

property shape

Property for shape

property size

Property for size

class mxcubecore.HardwareObjects.XSDataCommon.XSDataBoolean(value=None)

Bases: XSData

These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.

property value

Property for value

class mxcubecore.HardwareObjects.XSDataCommon.XSDataDate(value=None)

Bases: XSDataString

These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.

class mxcubecore.HardwareObjects.XSDataCommon.XSDataDisplacement(value=None, unit=None, error=None)

Bases: object

These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.

property error

Property for error

property unit

Property for unit

property value

Property for value

class mxcubecore.HardwareObjects.XSDataCommon.XSDataDouble(value=None)

Bases: XSData

These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.

property value

Property for value

class mxcubecore.HardwareObjects.XSDataCommon.XSDataDoubleWithUnit(value=None, unit=None, error=None)

Bases: XSDataDouble

property error

Property for error

property unit

Property for unit

class mxcubecore.HardwareObjects.XSDataCommon.XSDataExecutionInfo(workingDirectory=None, systeminfo=None, startOfExecution=None, pluginName=None, executionTime=None, configuration=None, baseDirectory=None)

Bases: object

This class contains details of the execution of a particular plugin.

property baseDirectory

Property for baseDirectory

property configuration

Property for configuration

property executionTime

Property for executionTime

property pluginName

Property for pluginName

property startOfExecution

Property for startOfExecution

property systeminfo

Property for systeminfo

property workingDirectory

Property for workingDirectory

class mxcubecore.HardwareObjects.XSDataCommon.XSDataFile(path=None)

Bases: XSData

These objects use the simple objects described above to create useful structures for the rest for the data model.

property path

Property for path

class mxcubecore.HardwareObjects.XSDataCommon.XSDataFloat(value=None)

Bases: XSData

These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.

property value

Property for value

class mxcubecore.HardwareObjects.XSDataCommon.XSDataFlux(value=None, unit=None, error=None)

Bases: XSDataDoubleWithUnit

These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.

class mxcubecore.HardwareObjects.XSDataCommon.XSDataImage(path=None, number=None, date=None)

Bases: XSDataFile

These objects use the simple objects described above to create useful structures for the rest for the data model.

property date

Property for date

property number

Property for number

class mxcubecore.HardwareObjects.XSDataCommon.XSDataInput(configuration=None)

Bases: XSData

All plugin input and result classes should be derived from these two classes.

property configuration

Property for configuration

class mxcubecore.HardwareObjects.XSDataCommon.XSDataInteger(value=None)

Bases: XSData

These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.

property value

Property for value

class mxcubecore.HardwareObjects.XSDataCommon.XSDataLength(value=None, unit=None, error=None)

Bases: XSDataDoubleWithUnit

These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.

class mxcubecore.HardwareObjects.XSDataCommon.XSDataLinearDisplacement(value=None, unit=None, error=None)

Bases: XSDataDisplacement

class mxcubecore.HardwareObjects.XSDataCommon.XSDataMatrix(m33=None, m32=None, m31=None, m23=None, m22=None, m21=None, m13=None, m12=None, m11=None)

Bases: XSDataMatrixDouble

XSDataMatrix is deprecated and should be replaced with XSDataMatrixDouble.

class mxcubecore.HardwareObjects.XSDataCommon.XSDataMatrixDouble(m33=None, m32=None, m31=None, m23=None, m22=None, m21=None, m13=None, m12=None, m11=None)

Bases: XSData

These are compound object used for linear algebra operations.

property m11

Property for m11

property m12

Property for m12

property m13

Property for m13

property m21

Property for m21

property m22

Property for m22

property m23

Property for m23

property m31

Property for m31

property m32

Property for m32

property m33

Property for m33

class mxcubecore.HardwareObjects.XSDataCommon.XSDataMatrixInteger(m33=None, m32=None, m31=None, m23=None, m22=None, m21=None, m13=None, m12=None, m11=None)

Bases: XSData

These are compound object used for linear algebra operations.

property m11

Property for m11

property m12

Property for m12

property m13

Property for m13

property m21

Property for m21

property m22

Property for m22

property m23

Property for m23

property m31

Property for m31

property m32

Property for m32

property m33

Property for m33

class mxcubecore.HardwareObjects.XSDataCommon.XSDataMessage(type=None, text=None, level=None, debuginfo=None)

Bases: XSData

This message class is used (amongst other messages) for warning and error messages.

property debuginfo

Property for debuginfo

property level

Property for level

property text

Property for text

property type

Property for type

class mxcubecore.HardwareObjects.XSDataCommon.XSDataResult(status=None)

Bases: XSData

All plugin input and result classes should be derived from these two classes.

property status

Property for status

class mxcubecore.HardwareObjects.XSDataCommon.XSDataRotation(q3=None, q2=None, q1=None, q0=None)

Bases: XSData

These are compound object used for linear algebra operations.

property q0

Property for q0

property q1

Property for q1

property q2

Property for q2

property q3

Property for q3

class mxcubecore.HardwareObjects.XSDataCommon.XSDataSize(z=None, y=None, x=None)

Bases: XSData

These objects use the simple objects described above to create useful structures for the rest for the data model.

property x

Property for x

property y

Property for y

property z

Property for z

class mxcubecore.HardwareObjects.XSDataCommon.XSDataSpeed(value=None, unit=None, error=None)

Bases: XSDataDoubleWithUnit

These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.

class mxcubecore.HardwareObjects.XSDataCommon.XSDataStatus(message=None, isSuccess=None, executiveSummary=None, executionInfo=None)

Bases: XSData

This class contains all data related to the execution of a plugin.

property executionInfo

Property for executionInfo

property executiveSummary

Property for executiveSummary

property isSuccess

Property for isSuccess

property message

Property for message

class mxcubecore.HardwareObjects.XSDataCommon.XSDataString(value=None)

Bases: XSData

These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.

property value

Property for value

class mxcubecore.HardwareObjects.XSDataCommon.XSDataSysteminfo(virtualMachine=None, userName=None, operatingSystemType=None, operatingSystem=None, hostName=None, hostIP=None, compiler=None)

Bases: XSData

This class contains information about the system executing the plugin.

property compiler

Property for compiler

property hostIP

Property for hostIP

property hostName

Property for hostName

property operatingSystem

Property for operatingSystem

property operatingSystemType

Property for operatingSystemType

property userName

Property for userName

property virtualMachine

Property for virtualMachine

class mxcubecore.HardwareObjects.XSDataCommon.XSDataTime(value=None, unit=None, error=None)

Bases: XSDataDoubleWithUnit

These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.

class mxcubecore.HardwareObjects.XSDataCommon.XSDataUnitVector(v3=None, v2=None, v1=None)

Bases: XSDataVectorDouble

<<Invariant>> {abs(v1**2.0 + v3**2.0-1.0) < epsilon}

class mxcubecore.HardwareObjects.XSDataCommon.XSDataVectorDouble(v3=None, v2=None, v1=None)

Bases: XSData

These are compound object used for linear algebra operations.

property v1

Property for v1

property v2

Property for v2

property v3

Property for v3

class mxcubecore.HardwareObjects.XSDataCommon.XSDataVectorInteger(v3=None, v2=None, v1=None)

Bases: XSData

These are compound object used for linear algebra operations.

property v1

Property for v1

property v2

Property for v2

property v3

Property for v3

class mxcubecore.HardwareObjects.XSDataCommon.XSDataWavelength(value=None, unit=None, error=None)

Bases: XSDataDoubleWithUnit

These simple objects that use built-in types are basically aimed to be used by the rest of the data model objects.