Paragon-neo/100G: Automation - Getting status of CAT masks

Python wrapper: Yes TCL wrapper: No

Functions to get the PASS or FAIL status of CAT masks along with other related information.

calnexCatGetAllMasksStatus(to_screen: bool = False)

calnexDoAllMeasurementsPass(pass_insuf_data: bool = False)

calnexCatGetAllMasksStatus()

    Queries all currently enabled measurements that have masks or thesholds set
    and returns their details, mask status, and the calnexRest.py command to
    get the individual mask value directly from a user script.

    For ease of use, the status of both "masks" and "thresholds" are both held
    as "MaskStatus" in the returned object.

    Note: The commands to SET masks and thresholds can be easily determined by
          using the "Script Recorder" function of the instrument.

    Arguments:
        to_screen: (Boolean) if set to TRUE, the object will be output to the
            screen in an easily readable format.  This is useful for seeing the
            calnexGetVal command for an individual mask status.

    Returns:
        A list of dictionaries, each dictionary holds:
            MeasurementName: The API name of the measurement (e.g. "2Way")
            MetricType: The API name of the metric (e.g. "TIMEERROR")
            MaskName: The mask or theshold name
            MaskState: Pass, Fail, Insufficient Data
            WrapperGetCmd:   The command to be used in a user script that will
                             return the pass/fail status of that mask
    Raises:
        None

Examples:

masks_status = calnexCatGetAllMasksStatus()

Returns a list of dictionaries of the masks/thresholds status into the variable.

calnexCatGetAllMasksStatus(to_screen=True)

Prints all masks and thresholds details to the screen as well as returning the dictionary. This is useful for determining the calnexGetVal() command for an individual mask status for use in a script.

calnexDoAllMeasurementsPass()

    Checks mask status of currently enabled measurements that have a mask or
    threshold set and returns TRUE if all masks are passed, and FALSE if any
    mask is not passed.

    Arguments:
        pass_insuf_data: (Boolean) sets whether a metric that does not
                          have enough data to be calculated is treated as a
                          pass (set to True) or a fail (set to False).

    Returns:
        TRUE if all masks pass the criteria
        FALSE if the masks do not pass the criteria

Examples:

all_meas_pass = calnexDoAllMeasurementsPass()

Returns TRUE or FALSE into the variable depending on the mask status of all measurements. Metrics that do not have enough data to be calculated are treated as a fail.

all_meas_pass = calnexDoAllMeasurementsPass(pass_insuf_data=True)

Returns TRUE or FALSE into the variable depending on the mask status of all measurements. Metrics that do not have enough data to be calculated are treated as a pass.