performance.idl

UCS (Ultra Corba Simulator) is one more powerful corba client/servant simulator tool than other simi

#ifndef         performance_idl
#define         performance_idl

// *************************************
// *                                   *
// * performance.idl                   *
// *                                   *
// *************************************

//Include list
#include "transmissionParameters.idl"
#include "common.idl"

#pragma prefix "mtnm.tmforum.org"

  /** 
   * <a href=supportingDocumentation/overview.html>Overview of NML-EML interface</a>
   *
   * <p>This module contains the definition of the performance management types and structures
   * of the NML-EML interface.
   * It also contains the definition of the performance management manager.</p>
   *
   * <p>PM functionality for ATM is not supported in this release of the interface.</p>
   *
   * <p>The NMS can enable and disable the collection of PM Data.
   * The NMS may specify a list of Termination Points and the set of PM parameters (e.g. nearEnd 
   * and/or farEnd) for which measurement of PM parameters may be turned on/off.
   * The NMS may specify a list of Termination Points, the set of PM parameters (e.g. nearEnd and/or 
   * farEnd) and the time window for the delivery of history PM data records.
   * The transfer of history PM data is by FTP.  The NMS may query 
   * the EMS for the time period within which PM data records may be retrieved once the 
   * corresponding collection bin is closed.
   * The NMS may query the EMS for the supported PM parameters of an ME.
   * The NMS may also query for current PM data records.</p>
   * <p>
   * The NMS may enable/disable notification of threshold crossing alerts by constructing the 
   * appropriate filter via the notification service. 
   * The NMS may set the threshold for the TCA for each of the supported TCA types per 
   * TP/layerRate measurement point.
   * The NMS may retrieve the current values of TCA thresholds for a Termination Point.
   * The NMS may enable/disable TCA generation.</p>
   *
   * <h5> Version 2.1. </h5>
   **/
module performance
{

  /**
   * <p>In the request for retrieval of history PM Data requests with PM data transfer
   * using FTP,  the 
   * NMS may specify the target destination for the PM Data file (operation getHistoryPMData()).
   * Within 
   * the destination field, the hostname of the destination machine and the full path name of the
   * target file (including the directory name and the file name) within the destination machine
   * are specified.
   * Hostname and full path name are separated by a colon ( : ). 
   * The '/' or '\' in path name are dependent on the destination and managed by the client.</p>
   **/
   typedef string  Destination_T;


  /** 
   * <p>Count period for which PM data may be collected 
   * (and subsequently retrieved).</p>
   *
   * <p>The format is one of:
   * <ul><li>"<i>n</i>min" (representing <i>n</i> minute granularity)
   * for values of n that are not multiples of 60</li>
   * <li>"<i>n</i>h" (representing <i>n</i> hour granularity)</li>
   * <li>"NA" (representing instantaneous measurements)</li>
   * </ul></p>
   * 
   * <p>Standard values are:<dir>
   * "15min"<br>
   * "24h"<br>
   * "NA" (for current instantaneous measurements)</dir></p>
   **/
   typedef string Granularity_T;


  /**
   * <p>Sequence of Granularity_T.</p>
   **/ 
   typedef sequence<Granularity_T> GranularityList_T;


  /** 
   * <p>PM parameters may relate to measurements taken on receive or transmit traffic either
   * at the named TP (PML_NEAR_END_Rx/Tx) or at the TP at the far end of the trail
   * (circuit/path) connected to the named TP (PML_FAR_END_Rx/Tx).  Alternatively, the
   * PM parameters may be bidirectional e.g. resulting from a second by second
   * summation and evaluation of both far and near TPs
   * (PML_BIDIRECTIONAL).</p>
   * Valid values are:<dir>
   * "PML_NEAR_END_Rx"<br>
   * "PML_FAR_END_Rx"<br>
   * "PML_NEAR_END_Tx"<br>
   * "PML_FAR_END_Tx"<br>
   * "PML_BIDIRECTIONAL"</dir>
   * <br>
   **/
   typedef string PMLocation_T;


  /**
   * <p> A set of PMLocation_T.
   * In PM related operations, PM parameters may be specified per nearEnd 
   * and/or farEnd category, or bidirectional category.</p>
   **/ 
   typedef sequence<PMLocation_T> PMLocationList_T;


  /**
   * <p>Holds the name of Performance Measurements.
   * It has been defined as a string to accomodate proprietary extension.</p>
   *
   * Valid values are:<dir>
   * 
   * "PMP_AISS": Alarm Indication Signal (AIS) Seconds (counter) <br>
   * "PMP_B1_CVS": B1 Coding Violation Seconds(counter) <br>
   * "PMP_BBE": (counter)<br>
   * "PMP_BBER": BBE Ratio (counter) <br>
   * "PMP_BER": Bit Error Rate, meter parameter = a measure of the signal quality measured at the
   *            facility port input, expressed as a bit error rate (measurement/estimation methods
   *             are NE-specific)<br>
   * "PMP_BER_AVG": Average Bit Error Rate during the interval<br>
   * "PMP_BER_MIN": Minimum Bit Error Rate during the interval<br>
   * "PMP_BER_MAX": Maximum Bit Error Rate during the interval<br>
   * "PMP_BES": Bursty Errored Seconds(counter) <br>
   * "PMP_CRC": Cyclical Redundancy Check(counter) <br>
   * "PMP_CV": (counter)<br>
   * "PMP_EB": (counter)<br>
   * "PMP_ES": (counter)<br>
   * "PMP_ES_TA": Errored Seconds Type A(counter) <br>
   * "PMP_ES_TB": Errored Seconds Type B(counter) <br>
   * "PMP_ESR": ES Ratio (counter) <br>
   * "PMP_FC": Failure Count (counter) <br>
   * "PMP_FEBE": Far End Bit Errors(counter) <br>
   * "PMP_FEC_EC": Forward Error Correction Error Count(counter) <br>
   * "PMP_FEC_UBC": Forward Error Correction Uncorrectable Block Count(counter) <br> 
   * "PMP_FREQUENCY": meter parameter = It specifies the measured optical channel frequency
   *                  of tunable lasers<br>
   * "PMP_FREQUENCY_AVG": Average optical channel frequency during the interval<br>
   * "PMP_FREQUENCY_MIN": Minimum optical channel frequency during the interval<br>
   * "PMP_FREQUENCY_MAX": Maximum optical channel frequency during the interval<br>
   * "PMP_LBC": Laser BackFire Current (gauge) <br>
   * "PMP_LBC_AVG": Laser BackFire Current Average (gauge) <br>
   * "PMP_LBC_MAX": Laser BackFire Current Maximum (gauge) <br>
   * "PMP_LBC_MIN": Laser BackFire Current Minimum (gauge) <br>
   * "PMP_LSS": Loss of Signal Seconds (counter) <br>
   * "PMP_NPJ": Negative Pointer Justification(counter) <br>
   * "PMP_OPT_LBIAS": Current Laser Bias Current (also known as Pump Current)<br>
   * "PMP_OPT_LBIAS_AVG": Average Laser Bias Current during the interval<br>
   * "PMP_OPT_LBIAS_MAX": Maximum Laser Bias Current during the interval<br>
   * "PMP_OPT_LBIAS_MIN": Minimum Laser Bias Current during the interval<br>
   * "PMP_OPT_LBIASN": Laser Bias Current Normalized, meter parameter = It specifies the current
   *                   Laser Bias Current as a normalized percentage (normalization algorithms are
   *                   NE-specific)<br>
   * "PMP_OPT_LBIASN_AVG": Average Laser Bias Current Normalized during the interval<br>
   * "PMP_OPT_LBIASN_MIN": Minimum Laser Bias Current Normalized during the interval<br>
   * "PMP_OPT_LBIASN_MAX": Maximum Laser Bias Current Normalized during the interval<br>
   * "PMP_OPT_LTEMP": Current Laser Temperature<br>
   * "PMP_OPT_LTEMP_AVG": Average Laser Temperature during the interval<br>
   * "PMP_OPT_LTEMP_MAX": Maximum Laser Temperature during the interval<br>
   * "PMP_OPT_LTEMP_MIN": Minimum Laser Temperature during the interval<br>
   * "PMP_PJE": (counter)<br>
   * "PMP_PPJ": Positive Pointer Justification(counter) <br>
   * "PMP_PSC": Protection Switch Count(counter) <br> 
   * "PMP_PSD": Protection Switch Duration (counter) <br>
   * "PMP_RPL": Current Receive Power Level (Input Signal Power)<br>
   * "PMP_RPL_AVG": Average Receive Power Level (Input Signal Power) during the interval<br>
   * "PMP_RPL_MAX": Maximum Receive Power Level (Input Signal Power) during the interval<br>
   * "PMP_RPL_MIN": Minimum Receive Power Level (Input Signal Power) during the interval<br>
   * "PMP_RPLN": Received Power Level Normalized, meter parameter = The received optical power
   *             expressed as a normalized percentage (normalization algorithms are NE-specific)<br>
   * "PMP_RPLN_AVG": Average Received Power Level Normalized during the interval<br>
   * "PMP_RPLN_MIN": Minimum Received Power Level Normalized during the interval<br>
   * "PMP_RPLN_MAX": Maximum Received Power Level Normalized during the interval<br>
   * "PMP_RSQ": Received Signal Quality Indicator, meter parameter = a measure of the signal quality
   *            measured at the facility port input, expressed as unit-less ratiometric value<br>
   * "PMP_RSQ_AVG": Average Received Signal Quality Indicator during the interval<br>
   * "PMP_RSQ_MIN": Minimum Received Signal Quality Indicator during the interval<br>
   * "PMP_RSQ_MAX": Maximum Received Signal Quality Indicator during the interval<br>
   * "PMP_SEF_AISS": Severly Errored Frame (SEF)/Alarm Indication Signal (AIS)Seconds<br>
   * "PMP_SEFS": (counter)<br>
   * "PMP_SEP": Severely Errored Period (counter) <br>
   * "PMP_SEPI": SEP Intensity (counter) <br>
   * "PMP_SES": (counter)<br>
   * "PMP_SESR": SES Ration (counter) <br>
   * "PMP_SNR": Signal Noise Ratio<br>
   * "PMP_SNR_AVG": Average Signal Noise Ratio during the interval<br>
   * "PMP_SNR_MAX": Maximum Signal Noise Ratio during the interval<br>
   * "PMP_SNR_MIN": Minimum Signal Noise Ratio during the interval<br>
   * "PMP_TCM_BBE": (counter) TCM BBE<br>
   * "PMP_TCM_ES": (counter) Tandem Connection Monitoring ES<br>
   * "PMP_TCM_SES": (counter) TCM SES<br>
   * "PMP_TCM_UAS": (counter) TCM UAS<br>
   * "PMP_TPL": Current Transmit Power Level (Output Signal Power)<br>
   * "PMP_TPL_AVG": Average Transmit Power Level (Output Signal Power) during the interval<br>
   * "PMP_TPL_MAX": Maximum Transmit Power Level (Output Signal Power) during the interval<br>
   * "PMP_TPL_MIN": Minimum Transmit Power Level (Output Signal Power) during the interval<br>
   * "PMP_UAS": Unavailable seconds (counter)<br>
   * </dir>
   **/   
   typedef string PMParameterName_T;  


  /**
   * <p>List of PMParameterName_T.</p>
   **/
   typedef sequence<PMParameterName_T> PMParameterNameList_T;


  /**
   * <p>This struct is used to represent the parameterName qualified by its location.</p>
   *
   * PMParameterName_T <b>pmParameterName</b>:
   * <dir>Represents the name of the PM Measure.</dir>
   *
   * PMLocation_T <b>pmLocation</b>:
   * <dir>Represents the location of the PM Measure.</dir>
   * <br>
   **/ 
   struct PMParameter_T {
      PMParameterName_T  pmParameterName;
      PMLocation_T pmLocation;
   };

 
  /**
   * <p>Sequence of PMParameter_T.</p>
   **/
   typedef sequence <PMParameter_T> PMParameterList_T ;


  /**
   * <p>Describes threshold types for TCA parameters.</p> 
   * 
   * <p>The TWM_HIGH and TWM_HIGHEST types are used for TCAs that are raised when the measured
   * value goes above the threshold.
   * The TWM_LOW and TWM_LOWEST types are used for TCAs that are raised when the measured
   * value goes below the threshold (only apply to gauges).</p>
   *
   * <p>When there is only one level of TCA trigger, only TWM_HIGH and/or TWM_LOW are used.
   * When there are two levels of TCA triggers, TWM_HIGHEST and/or TWM_LOWEST
   * are used in addition.
   * </p>
   **/
   enum PMThresholdType_T 
   {
      TWM_HIGHEST,
      TWM_HIGH,
      TWM_LOW,
      TWM_LOWEST
   };


  /**
   * <p>Holds a PM threshold value.</p>
   *
   * <p>See <a href=supportingDocumentation/TCAs.gif>TCAs</a> for information on how
   * threshold values are used.</p>
   *
   * PMParameterName_T <b>pmParameterName</b>:
   * <dir>Represents the name of the PM Measure.</dir>
   *
   * PMLocation_T <b>pmLocation</b>:
   * <dir>Represents the location of the PM Measure.</dir>
   *
   * PMThresholdType_T <b>thresholdType</b>:
   * <dir>Represents the type of threshold value.</dir>
   *
   * boolean <b>triggerFlag</b>:
   * <dir>Indicates if the threshold is for the trigger (true) or the clear (false).</dir>
   *
   * float <b>value</b>:
   * <dir>Threshold for parameter (float used to incorporate gauge PM parameters).</dir>
   *
   * string <b>unit</b>:
   * <dir>Free format string describing the units for the threshold value.</dir>
   * <br>
   **/
   struct PMThresholdValue_T 
   {
      PMParameterName_T  pmParameterName;
      PMLocation_T       pmLocation;
      PMThresholdType_T  thresholdType;
      boolean            triggerFlag;
      float              value;
      string             unit;
   };