sn_polling_extension.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2026, QORE Lab, Imperial College London
 * All rights reserved.
 */
#ifndef LINE_API_SN_SN_POLLING_EXTENSION_H
#define LINE_API_SN_SN_POLLING_EXTENSION_H
 
/**
 * @file
 * @ingroup api_sn
 * Port of matlab/src/api/sn/sn_polling_extension.m.
 *
 * The first polling extension a POLLING station of the network carries, as
 * its feature-registry name ("PollingTable", "PollingOrder" or
 * "PollingTimer"), or "" when every polling station is a plain cyclic one.
 * The three settings come from set_polling_table, set_polling_order and
 * set_polling_timer and live on the Station. Engines that read the polling
 * type alone (the SSA NRM, the JMT writer) ask this predicate so they refuse
 * instead of answering the cyclic system.
 *
 * ARITHMETIC: none; reads structure only.
 */
 
#include <cstddef>
#include <string>
 
#include "line/lang/lang_types.h"
#include "line/lang/qn/network_struct.h"
 
namespace line {
namespace api {
 
template <class T>
std::string sn_polling_extension(const qn::NetworkStruct<T>& sn) {
    for (std::size_t i = 0; i < sn.stations.size(); ++i) {
        const qn::Station<T>& st = sn.stations[i];
        if (st.sched != qn::SchedStrategy::POLLING) continue;
        if (!st.polling_table.empty()) return "PollingTable";
        if (st.polling_order != lang::PollingOrder::CYCLIC) return "PollingOrder";
        if (st.polling_timer_scope != lang::PollingTimer::NONE) return "PollingTimer";
    }
    return "";
}
 
/**
 * The citation token of the MVA polling analyzer's formula on SN, the hook of
 * MATLAB `NetworkSolver.citations`: when `family` is "mva" and `method`
 * contains "stationtime", "polling.table" if the first POLLING station has a
 * table, else "polling.klimited" if it is K-limited with K > 1, else "".
 * Append the result to the method tokens passed to io::line_citations.
 */
template <class T>
std::string sn_polling_citation_token(const qn::NetworkStruct<T>& sn, const std::string& family,
                                      const std::string& method) {
    if (family != "mva" || method.find("stationtime") == std::string::npos) return "";
    for (std::size_t i = 0; i < sn.stations.size(); ++i) {
        const qn::Station<T>& st = sn.stations[i];
        if (st.sched != qn::SchedStrategy::POLLING || st.polling_type.empty()) continue;
        if (!st.polling_table.empty()) return "polling.table";
        if (st.polling_type[0] == lang::PollingType::KLIMITED && st.polling_par > 1)
            return "polling.klimited";
        return "";
    }
    return "";
}
 
}  // namespace api
}  // namespace line
 
#endif  // LINE_API_SN_SN_POLLING_EXTENSION_H