struct.cable.state.compression

Syntax

i = struct.cable.state.compression(p)

Get the compression yield state of the cable element. The return value {0, 1, 2} denotes never yielded, now yielding, or yielded in the past, respectively.

Returns:f - an integer in the set of {0, 1, 2} denotes never yielded, now yielding, or yielded in the past, respectively
Arguments:p - a pointer to a cable element