performance.idl

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

  /**
   * <p>Sequence of PMThresholdValue_T.</p>
   **/ 
   typedef sequence<PMThresholdValue_T> PMThresholdValueList_T ;


  /**
   * <p>Holds a PM measurement and description of validity.</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>
   *
   * float <b>value</b>:
   * <dir>Value of parameter (float used to incorporate gauge PM parameters).</dir>
   *
   * string <b>unit</b>:
   * <dir>Free format string describing the units for the PM measurement value.</dir>
   * string <b>intervalStatus</b>:

   * <dir>The following string values for  name attributes are allowed:<dir>
   * "Valid" - valid data,<br>
   * "Incomplete" - data not available for the complete interval,<br>
   * "Invalid" - data available but marked as invalid for the interval (when the EMS can not
   *  distinguish incomplete measurements from invalid measurements, "Invalid" will be used)<br>
   * "Unavailable" - no data available at all for this interval,<br>
   * "Zero-suppressed" - zero-suppressed intervals.<br>
   * </dir></dir>
   * <br>
   **/
   struct PMMeasurement_T 
   {
     PMParameterName_T  pmParameterName;
     PMLocation_T       pmLocation;
     float              value;
     string             unit;
     string             intervalStatus;
   };


  /**
   * <p>Sequence of PMMeasurement_T.</p>
   **/ 
   typedef sequence<PMMeasurement_T> PMMeasurementList_T ;


  /**
   * <p>This struct is used to pass current PM data for one 
   * collection bin from the EMS to the NMS.</p>
   *
   * globaldefs::NamingAttributes_T <b>tpName</b>:
   * <dir>The name of the termination point.</dir>
   *
   * transmissionParameters::LayerRate_T <b>layerRate</b>:
   * <dir>Layer of the collected PM data.</dir>
   *
   * Granularity_T <b>granularity</b>:
   * <dir>Identifies whether the granularity of the data.</dir>
   *
   * globaldefs::Time_T <b>retrievalTime</b>:
   * <dir>ME time at which PM measurement was obtained from the ME.</dir>
   *
   * PMMeasurementList_T <b>pmMeasurementList</b>:
   * <dir>PM values.</dir>
   * <br>
   **/ 
   struct PMData_T {
     globaldefs::NamingAttributes_T      tpName;
     transmissionParameters::LayerRate_T layerRate;
     Granularity_T                       granularity;
     globaldefs::Time_T                  retrievalTime;
     PMMeasurementList_T                 pmMeasurementList;
   };

 
  /**
   * <p>Sequence of PMData.</p>
   **/
   typedef sequence<PMData_T> PMDataList_T;


  

  /** 
   * <p>Used to specify the scope for a PM operation.</p>
   *
   * globaldefs::NamingAttributes_T <b>name</b>:
   * <dir>The name of the object to which this selection applies. This may be:
   * <dir> ManagedElement: The selection applies to all termination points
   * contained within the ManagedElement.</dir>
   * <dir> TerminationPoint: The selection applies only to the named termination point
   * which will be a PTP or a CTP. Unlike the case for managedElement, the operation 
   * will not apply to any "contained" TPs when a PTP or CTP is specified.</dir>
   * <dir> Note: as noted in the requirements, the possible scopes do not include "SNC".</dir></dir>
   *
   * transmissionParameters::LayerRateList_T <b>layerRate</b>:
   * <dir>Set of layers to which the selection applies. An empty list
   * means all layers supported by the equipment.</dir>
   *
   * PMLocationList_T <b>pMLocationList</b>:
   * <dir>Identifies set of locations (i.e. farEnd and/or nearEnd and/or bidirectional).
   * An empty list means all locations supported by the equipment.</dir>
   *
   * GranularityList_T <b>granularityList</b>:
   * <dir>Identifies set of granularities. An empty list
   * means all granularities supported by the equipment.</dir>
   * <br>
   **/
   struct PMTPSelect_T {
     globaldefs::NamingAttributes_T          name;
     transmissionParameters::LayerRateList_T layerRateList;
     PMLocationList_T                        pMLocationList;
     GranularityList_T                       granularityList;
   };
 
 
  /**
   * <p>Sequence of PMTPSelect. Used by several methods to identify sets
   * of PM parameters to which to apply the operation.</p> 
   **/
   typedef sequence<PMTPSelect_T> PMTPSelectList_T;
 
  /**
   * <p>By means of this struct, the EMS informs the NMS about the minimum time it holds
   * 24h PM data records and 15min PM data records.
   * This minimum time refers to the time after the particular collection bins are closed.</p>
   *
   * short <b>storeTime24hr</b>:
   * <dir>minimum store time in hours for 24h data</dir>
   *
   * short <b>storeTime15min</b>:
   * <dir>minimum store time in hours for 15min data</dir>
   * <br>
   **/
   struct HoldingTime_T {
     short storeTime24hr; 
     short storeTime15min;
   }; 


  /**
   * <p>TCAParameters is used to get or set one or more PM Thresholds
   * for a given TP/layer/granularity measurement point.</p>
   *
   * transmissionParameters::LayerRate_T <b>layerRate</b>:
   * <dir>Identifies layer to which tcaTypeValues applies.</dir>
   *
   * Granularity_T <b>granularity</b>:
   * <dir>Identifies the granularity of the data.  For gauges, this should be "NA".</dir>
   *
   * PMThresholdValueList_T <b>tcaTypeValues</b>:
   * <dir>Identifies threshold values.</dir>
   **/
   struct TCAParameters_T  {
     transmissionParameters::LayerRate_T layerRate;
     Granularity_T                       granularity;
     PMThresholdValueList_T              tcaTypeValues;
   }; 


  /**
   * <p>In order to allow the NMS to deal with a large number of objects,
   * iterators are used.</p>
   * <p>See <a href=supportingDocumentation/iterators.html>iterator overview</a>
   * for information on how iterators are used in this interface.</p>
   **/

   interface PMDataIterator_I 
   {
	boolean  next_n(in  unsigned long    how_many,
			out PMDataList_T       pmDataList)
		 raises (globaldefs::ProcessingFailureException);

	unsigned long getLength()
		 raises (globaldefs::ProcessingFailureException);

	void     destroy()
		 raises (globaldefs::ProcessingFailureException);
   };


  /**
   * <p>The PerformanceManagementMgr_I is used to gain access to operations
   * which deal with performance Monitoring</p>
   *
   * <p>A handle to an instance of this interface is gained via the
   * <a href=_emsSession.EmsSession_I.html#emsSession::EmsSession_I::getManager>
   * getManager</a> operation in Manager.</p>
   **/

   interface PerformanceManagementMgr_I: common::Common_I
   {


  /**
   * <p>This operation allows the NMS to request, from the EMS, the set
   * of PM parameters supported by a particular ME at a specific layer.<p>
   *
   * @parm globaldefs::NamingAttributes meName gives the name of the managed element
   * @parm transmissionParameters::LayerRate layerRate gives the layerRate considered.
   * @parm PMParameterList pmParameterList This out parameter contains the set of 
   * PM parameters that are supported by the ME referred to.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised when meName does not reference an managedElement object
   * or layerRate contains undefined rates<br>
   * EXCPT_ENTITY_NOT_FOUND - Raised when meName references object which does not exist<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost<br>
   * </dir>
   **/
   void getMEPMcapabilities(
         in globaldefs::NamingAttributes_T meName,
         in transmissionParameters::LayerRate_T layerRate,
         out PMParameterList_T pmParameterList)
        raises(globaldefs::ProcessingFailureException);


  /**
   * <p>This operation instructs the EMS to turn off PM data collection for a list of
   * measurement points. Within the request for each measurement point, 
   * one may specify the granularity (15min, 24h, NA, etc.) and location (nearEnd 
   * and/or farEnd and/or bidirectional) for the PM parameters that are to be deactivated.<p>
   * <p>Disabling is done on a best-effort basis. If PM could not be disabled
   * for a subset of cases in
   * the PMTPSelectList a  list identifying this subset is returned.</p>
   * <p>PM collection stops immediately, i.e., before the completion of the current
   * 15 minute or 24 hour monitoring period. This may lead to incomplete collection periods.
   * If PM collection was never started for this TP, the operation is considered successful.</p>
   *
   * @parm PMTPSelectList_T pmTPSelectList: This struct contains the relevant 
   *  data for the disablePMData request. This must not be empty.
   * @parm PMTPSelectList_T failedTPSelectList: List of points which were not completely disabled.
   * An empty list indicates that the total request was successful.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised if pmTPSelectList is empty.<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost<br>
   * </dir>
   **/ 
   void disablePMData(
         in PMTPSelectList_T pmTPSelectList,
         out PMTPSelectList_T failedTPSelectList)
        raises(globaldefs::ProcessingFailureException);


  /**
   * <p>This operation instructs the EMS to enable (turn on) PM data collection
   * for a list of
   * measurement points. Within the request for each measurement point, one may specify the
   * granularity (15min, 24h, NA, etc.) and location (nearEnd 
   * and/or farEnd and/or bidirectional) for the PM parameters that are to be activated.</p>
   *
   * <p>Enabling is done on best-effort basis. If PM could not be
   * enabled for a subset of cases in
   * the pmTPSelectList, a list identifying this subset is returned.</p>
   *
   * <p>PM collection starts immediately, i.e., before the completion of the current
   * 15 minute or 24 hour monitoring period. This may lead to incomplete collection periods.
   * If PM collection was already on for a TP,
   * the operation is considered successful.</p>
   *
   * @parm PMTPSelectList_T pmTPSelectList: This struct contains the relevant 
   *  data for the enablePMData request. This must not be empty.
   * @parm PMTPSelectList_T failedTPSelectList: List of points which were not completely enabled.
   *  An empty list indicates that the total request was successful.
   * @raises globaldefs::ProcessingFailureException<dir>
   * EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure<br>
   * EXCPT_INVALID_INPUT - Raised if pmTPSelectList is empty or contains invalid data<br>
   * EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost<br>
   * EXCPT_CAPACITY_EXCEEDED - Raised when the maximum number of simultaneously enablable 
   *  monitoring points is exceeded<br>
   * </dir>
   **/ 
   void enablePMData(
         in PMTPSelectList_T pmTPSelectList,
         out PMTPSelectList_T failedTPSelectList)
        raises(globaldefs::ProcessingFailureException);


  /**
   * <p>This operation instructs the EMS to clear (reset) the PM registers
   * for a list of
   * measurement points. Within the request for each measurement point, one may specify the
   * granularity (15min, 24h, NA, etc.) and location (nearEnd 
   * and/or farEnd and/or bidirectional) for the PM registers that are to be reset.</p>
   *
   * <p>Clearing PM gauge minimum, maximum, and average registers means to reset them