SalRetCode¶

class lsst.ts.salobj.SalRetCode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)¶

Bases: IntEnum

SAL return codes.

Attributes Summary

`CMD_ABORTED`
`CMD_ACK`
`CMD_COMPLETE`
`CMD_FAILED`
`CMD_INPROGRESS`
`CMD_NOACK`
`CMD_NOPERM`
`CMD_STALLED`
`CMD_TIMEOUT`
`DATA_AVAIL`
`DEADLINE_MISS`
`ERR`
`EVENT_ABORT`
`EVENT_ERROR`
`EVENT_INFO`
`EVENT_WARN`
`GOT_UPDATE`
`ILLEGAL_REVCODE`
`INCOMPAT_QOS`
`LIVELINESS_CHG`
`NOT_DEFINED`
`NO_UPDATES`
`OK`
`SAMPLELOST`
`SAMPLE_REJ`
`SIGNAL_INTERRUPT`
`STATE_DISABLED`
`STATE_ENABLED`
`STATE_FAULT`
`STATE_OFFLINE`
`STATE_STANDBY`
`SUBSCR_MATCH`
`SYNC_CLEAR`
`SYNC_IN`
`SYNC_OUT`
`SYNC_READ`
`SYNC_SET`
`TIMEOUT`
`TOO_MANY_HANDLES`
`WAITING_FOR_NEXT`
`WAIT_FOR_CHANGE`
`WAIT_FOR_NEXT_UPDATE`
`denominator`	the denominator of a rational number in lowest terms
`imag`	the imaginary part of a complex number
`numerator`	the numerator of a rational number in lowest terms
`real`	the real part of a complex number

Methods Summary

`as_integer_ratio`(/)	Return integer ratio.
`bit_count`(/)	Number of ones in the binary representation of the absolute value of self.
`bit_length`(/)	Number of bits necessary to represent self in binary.
`conjugate`	Returns self, the complex conjugate of any int.
`from_bytes`(/, bytes[, byteorder, signed])	Return the integer represented by the given array of bytes.
`to_bytes`(/[, length, byteorder, signed])	Return an array of bytes representing an integer.

Attributes Documentation

CMD_ABORTED = -303¶

CMD_ACK = 300¶

CMD_COMPLETE = 303¶

CMD_FAILED = -302¶

CMD_INPROGRESS = 301¶

CMD_NOACK = -301¶

CMD_NOPERM = -300¶

CMD_STALLED = 302¶

CMD_TIMEOUT = -304¶

DATA_AVAIL = 400¶

DEADLINE_MISS = 401¶

ERR = -1¶

EVENT_ABORT = -202¶

EVENT_ERROR = -201¶

EVENT_INFO = 200¶

EVENT_WARN = -200¶

GOT_UPDATE = 101¶

ILLEGAL_REVCODE = -2¶

INCOMPAT_QOS = 402¶

LIVELINESS_CHG = 404¶

NOT_DEFINED = -4¶

NO_UPDATES = -100¶

OK = 0¶

SAMPLELOST = 405¶

SAMPLE_REJ = 403¶

SIGNAL_INTERRUPT = -6¶

STATE_DISABLED = 1¶

STATE_ENABLED = 2¶

STATE_FAULT = 3¶

STATE_OFFLINE = 4¶

STATE_STANDBY = 5¶

SUBSCR_MATCH = 406¶

SYNC_CLEAR = 105¶

SYNC_IN = 102¶

SYNC_OUT = 103¶

SYNC_READ = 106¶

SYNC_SET = 104¶

TIMEOUT = -5¶

TOO_MANY_HANDLES = -3¶

WAITING_FOR_NEXT = 100¶

WAIT_FOR_CHANGE = -10001¶

WAIT_FOR_NEXT_UPDATE = -10000¶

denominator¶: the denominator of a rational number in lowest terms

imag¶: the imaginary part of a complex number

numerator¶: the numerator of a rational number in lowest terms

real¶: the real part of a complex number

Methods Documentation

as_integer_ratio(/)¶

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count(/)¶

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length(/)¶

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()¶: Returns self, the complex conjugate of any int.

from_bytes(/, bytes, byteorder='big', *, signed=False)¶

Return the integer represented by the given array of bytes.

bytes: Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.
byteorder: The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value. Default is to use ‘big’.
signed: Indicates whether two’s complement is used to represent the integer.

to_bytes(/, length=1, byteorder='big', *, signed=False)¶

Return an array of bytes representing an integer.

length: Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. Default is length 1.
byteorder: The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value. Default is to use ‘big’.
signed: Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

Navigation

SalRetCode¶