// copyright 2013-2020 BAE Systems, Thales Group, Object Management Group Inc; 2013 Selex ES, DSTO, Atlas Elektronik, EADS Deutschland GmbH

#ifndef ORGOMGC4ISERVICE_INTERFACESSUBSYSTEM_SERVICESEXTENDED_SUBSYSTEM_CONTROLPROVIDE_NETWORKING_STATISTICSDEFVAR
#define ORGOMGC4ISERVICE_INTERFACESSUBSYSTEM_SERVICESEXTENDED_SUBSYSTEM_CONTROLPROVIDE_NETWORKING_STATISTICSDEFVAR
#include "Common_Types.idl"
#include "Coordinates_and_Positions.idl"
#include "Subsystem_Control.idl"

module org
{

  module omg
  {

    module c4i
    {

      module Service_Interfaces
      {

        module Subsystem_Services
        {

          module Extended_Subsystem_Control
          {

            // Contains operations and sequence diagrams for the Provide Bandwidth Statistics
            // interface.
            module Provide_Networking_Statistics
            {

              // Informs the CMS of the most recent bandwidth utilization
              // This is used to inform the CMS of the bandwidth being used by and quality of
              // service achieved by the Subsystem (e.g. an off-platform communications and/or
              // networking device).
              struct write_bandwidth_statistics_type
              {
                // The greatest utlization of bandwidth since the last update
                org::omg::c4i::Domain_Model::Common_Types::percentage_type peak_utilization;
                // Indicates which subsystem published the data or is intended to read it as a
                // subscriber
#ifdef DDS_XTYPES
                @key org::omg::c4i::Domain_Model::Common_Types::subsystem_id_type subsystem_id;
#else
                org::omg::c4i::Domain_Model::Common_Types::subsystem_id_type subsystem_id;
#endif
                // The average utilization of bandwidth since the last update
                org::omg::c4i::Domain_Model::Common_Types::percentage_type mean_utilization;
                // The device specific to the connection to which the statistic pertain
                org::omg::c4i::Domain_Model::Subsystem_Domain::Subsystem_Control::device_name_type connection;
                // The period of time for which the statistic apply
                org::omg::c4i::Domain_Model::Common_Types::Coordinates_and_Positions::absolute_duration_type period_of_validity;
              };
#ifndef DDS_XTYPES
#pragma keylist write_bandwidth_statistics_type subsystem_id
#endif

              // Informs the CMS of the most recent latency associated with data transfer
              // This is used to inform the CMS of the bandwidth being used by and quality of
              // service achieved by the Subsystem (e.g. an off-platform communications and/or
              // networking device).
              struct write_latency_statistics_type
              {
                // The greatest latency experienced across the network scope since the last update
                org::omg::c4i::Domain_Model::Common_Types::time_type peak_latency;
                // Indicates which subsystem published the data or is intended to read it as a
                // subscriber
#ifdef DDS_XTYPES
                @key org::omg::c4i::Domain_Model::Common_Types::subsystem_id_type subsystem_id;
#else
                org::omg::c4i::Domain_Model::Common_Types::subsystem_id_type subsystem_id;
#endif
                // The average latency experienced across the network scope since the last update
                org::omg::c4i::Domain_Model::Common_Types::time_type mean_latency;
                // The device specific to the connection to which the statistic pertain
                org::omg::c4i::Domain_Model::Subsystem_Domain::Subsystem_Control::device_name_type connection;
                // The period of time for which the statistics apply
                org::omg::c4i::Domain_Model::Common_Types::Coordinates_and_Positions::absolute_duration_type period_of_validity;
              };
#ifndef DDS_XTYPES
#pragma keylist write_latency_statistics_type subsystem_id
#endif

            };
          };
        };
      };
    };
  };
};
#endif