IDBParameter

class stixcore.idb.idb.IDBParameter(*, PID_SPID, PID_DESCR, PID_TPSD, PCF_NAME, PCF_DESCR, PCF_WIDTH, PCF_PFC, PCF_PTC, PCF_CURTX, S2K_TYPE, bin_format='')

Bases: IDBPacketTypeInfo

A base class to represent a parameter of a SCOS-2000 Telemetry Packet.

PID_SPID

SCOS-2000 Telemetry Packet Number the parameter belongs to. Unsigned integer number in the range (1….2^32-1) (note that zero is not allowed).

Type:

int

PID_DESCR

Textual description of the SCOS-2000 telemetry packet the parameter belongs to max 64 characters.

Type:

str

PID_TPSD

SCOS-2000 Telemetry Packet Structure Definition. This field is only used by the Variable Packets Display application. It has to be set to ‘-1’ for packets which are not defined in the VPD table and thus are not required to be processed by the Variable PacketsDisplay. If not set to –1, unsigned integer number in the range (1….2^31-1) (note that zero is not allowed).

Type:

int

PCF_NAME

Name of the parameter. Alphanumeric string uniquely identifying the monitoring parameter (max 8 characters).

Type:

str

PCF_DESCR

Parameter Description - free textual description of the parameter.

Type:

str

PCF_WIDTH

‘Padded’ width of this parameter expressed in number of bits. This field is only used when extracting parameter samples using the VPD definition to identify the bitposition where the next telemetry parameter starts

Type:

int

PCF_PFC

Parameter Format Code. Along with the Parameter Type Code (PCF_PTC) this field controls the length of the parameter. Integer value in a range compatible with the specified PCF_PTC

Type:

int

PCF_PTC

Parameter Type Code. This controls the encoding format of the parameter. Integer value in the range (1..13).

Type:

int

PCF_CURTX

Parameter calibration identification name. Depending on parameter category, this field

stores the numerical calibration or the textual calibration identification name.

Type:

int

2K_TYPE

TBD.

Type:

str

bin_format

Read instruction format of the specific parameter for processing the bit stream e.g. “int:8”. See bitstream.ConstBitStream.read for more information.

Type:

str

Methods Summary

get_product_attribute_name()

Methods Documentation

get_product_attribute_name()