What is mctLimitState?

[marcelo-earth]

Hi OpenMCT community!

I can't find the definition of mctLimitState in the documentation, and I see that it is used in the code. I ask this because opening the object that brings back historical telemetry data, I see that there is a new property called mctLimitState.

What is it about? Is it okay for it to be undefined?

From openmct-tutorial:

function HistoricalTelemetryPlugin() {
    return function install (openmct) {
        var provider = {
            supportsRequest: function (domainObject) {
                return domainObject.type === 'example.telemetry';
            },
            request: function (domainObject, options) {
                var url = '/history/' +
                    domainObject.identifier.key +
                    '?start=' + options.start +
                    '&end=' + options.end;

                return http.get(url)
                    .then(function (resp) {
                        console.log(resp.data); // 👈
                        return resp.data;
                    });
            }
        };

        openmct.telemetry.addProvider(provider);
    }
}

[jvigliotta]

Hi @360macky ! What version of Open MCT is the tutorial using when you see this? Also, what branch/step of the tutorial are you on? You can find the Open MCT version by clicking the Open MCT login in the top right. Thanks!

[marcelo-earth]

Hi @jvigliotta ! I'm using Version: 2.0.5, and the branch is completed. I just write a console.log in the HistoricalTelemetryPlugin as I show in the first post. The result is the same:

[jvigliotta]

After further investigation and a little help from @khalidadil (thanks!) I see that this is added here: https://github.com/nasa/openmct/blob/master/src/plugins/plot/configuration/PlotSeries.js#L431 So, it's not coming back from the server, but when viewing the telemetry data in a plot, each datum get's this property. It shouldn't be any issue if it is undefined. It's used by plots to show limit information related to those data.

[marcelo-earth]

Thanks @jvigliotta and @khalidadil!
I understand. Yes, it works well even if it's undefined.

when viewing the telemetry data in a plot, each datum get's this property.
It's used by plots to show limit information related to those data.

I have a doubt. What does mctLimitState indicate about each datum? What does mctLimitState contains when it's not undefined.

Again, so much thanks 🙏 .