Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel

Class TimeStamp

Python wrapper for pdsdata/xtc/TimeStamp class. In addition to methods described here the class also defines __hash__ and __cmp__ methods based on the content of the object and can be used as a key in the dictionaries.


Construction

Wiki Markup
Usage: {{ts = xtc.TimeStamp(_ticks_, _fiducials_, _vector_, \[_control_\])}}

Creates new instance of this type. All arguments are of integer type and have the same meaning as in corresponding C++ constructor.


Method ticks()

Usage: ticks = ts.ticks()

Returns the ticks value as integer number.


Method fiducials()

Usage: fiducials = ts.fiducials()

Returns the fiducials value as integer number.


Method control()

Usage: control = ts.control()

Returns the control value as integer number.


Method vector()

Usage: vector = ts.vector()

Returns the vector value as integer number.

...

Panel

Class TransitionId

Python wrapper for pdsdata/xtc/TransitionId class. C++ class does not define any data members or methods, it only defines single enum type. C++ cannot be instantiated in any meaningful way. Python class in addition to defining corresponding enum constants can also be instantiated, the instances are regular integer numbers with additional printing enhancements.


Enum Value

Unlike other enum types which create separate new type inside original Python type, the enums in TransitionId class are defined directly in the class. Known enums:

  • TransitionId.
  • TransitionId.Unknown
  • TransitionId.Reset
  • TransitionId.Map
  • TransitionId.Unmap
  • TransitionId.Configure
  • TransitionId.Unconfigure
  • TransitionId.BeginRun
  • TransitionId.EndRun
  • TransitionId.BeginCalibCycle
  • TransitionId.EndCalibCycle
  • TransitionId.Enable
  • TransitionId.Disable
  • TransitionId.L1Accept
  • TransitionId.NumberOf

Construction

Usage: transId = xtc.TransitionId(number)

Arguments:

  • number – any of the above enums can be used

Method __str__

Usage: s = str(transId)

Returns a name of the corresponding enum.


Method __repr__

Usage: s = repr(transId)

Returns a string in the form "<TransitionId(num):name>" where num and name are the value and the name of the corresponding enum.