Versions Compared

Key

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

...

Panel

Class Dgram

Python wrapper for pdsdata/xtc/Dgram class.


Construction

Usage: dg = xtc.Dgram(buffer)

One of the ways to create Dgram objects is from a Python buffer objects.

Arguments:

  • buffer – any object that implements buffer interface
Method

Property env

()

Usage: env = dg.env()

Returns the env field as an integer number.

Method

Property seq

()

Usage: seq = dg.seq()

Returns the seq field as an object of type xtc.Seq.

Method

Property xtc

()

Usage: x = dg.xtc()

Returns top-level Xtc as object of type xtc.Xtc.

...

Panel

Class ProcInfo

Python wrapper for pdsdata/xtc/ProcInfo class. Unlike C++ this class does not inherit from Src class (Src class does not exist in this module) but uses dynamic Python features to implement the same interface as in Src 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

Usage: proc = xtc.ProcInfo(level, processId, ipAddr)

Arguments:

  • level – instance of xtc.Level class
  • processId – integer number
  • ipAddr – IP address of the host as integer number

Method level()

Usage: lvl = proc.level()

Returns enum value of type xtc.Level which defines source level.


Method log()

Usage: log = proc.log()

Returns logical address of data source as integer number.


Method phy()

Usage: phy = proc.phy()

Returns physical address of data source as integer number.


Method processId()

Usage: processId = proc.processId()

Returns process ID as integer number.


Method ipAddr()

Usage: ipAddr = proc.ipAddr()

Returns host IP address as an integer number.

...

Panel

Class Sequence

Python wrapper for pdsdata/xtc/Sequence class.


Enum Type

This enum is an embedded type of Sequence class. Following enum members are defined currently:

  • Sequence.Type.Event
  • Sequence.Type.Occurrence
  • Sequence.Type.Marker

Construction

This class cannot be instantiated directly, it is instantiated by some other classes, e.g. by Dgram.seq property.


Method type()

Usage: type = seq.type()

Returns the type of this sequence, one of Sequence.Type.* values.


Method service()

Usage: svc = seq.service()

Returns the transition type as object of xtc.TransitionId type.


Method isExtended()

Usage: val = seq.isExtended()

Returns True for extended sequence.


Method isEvent()

Usage: val = seq.isEvent()

Returns True for event sequence.


Method clock()

Usage: clock = seq.clock()

Returns clock value for sequence as an object of xtc.ClockTime type.


Method stamp()

Usage: stamp = seq.stamp()

Returns timestamp value for sequence as an object of xtc.TimeStamp type.