Parameter

class stixcore.tmtc.parameter.Parameter(name, value, idb_info, *, children=None, order=-1)

Bases: object

Generic Parameter Class

name

Parameter name

Type:

str

value

The value of the parameter

children

Children of this parameter

Type:

list optional

Methods Summary

export(packetdata, exportstate, *[, descr])
flatten(root)	Flatten repeated substructures into root object
merge_children()	Merge children into single parameter if same NIX
unpack_NIX00065()	Unpack the NIX00065 values.

Methods Documentation

export(packetdata, exportstate, *, descr=False)

flatten(root)

Flatten repeated substructures into root object

Parameters:

root (object)

merge_children()

Merge children into single parameter if same NIX

Returns:

Parameter – A new parameter with where are children are merged.

unpack_NIX00065()

Unpack the NIX00065 values.

Continuation bits (NIXD0159) define number of subsequent bytes used to define counts for given Detector / Pixel / Energy combination, i.e. value 0 denotes no following bytes and count equal to 1, value 1 denotes 1 byte for “Counts” parameter with value between 2-255 and continuation bits equal to 2 are used for 2 successive bytes for “Counts” parameter with value between 256 and 65535.

Parameters:

param (´Parameter´) – The NIXD00159 parameter

Returns:

Parameter – The unpacked value

Raises:

ValueError – if unpacking schema is not supported