trafficdescriptor.idl

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

#ifndef         trafficDescriptor_idl
#define         trafficDescriptor_idl

// *************************************
// *                                   *
// * trafficDescriptor.idl             *
// *                                   *
// *************************************

//Include list
#include "terminationPoint.idl"
#include "globaldefs.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 traffic Descriptor structure
   * of the NML-EML interface.
   * It also contains the definition of the traffic descriptor manager.</p>
   *
   * <h5> Version 2.0. </h5>
   **/


module trafficDescriptor
{

  /**
   * <p>Represents Service Categories used by Traffic 
   * Descriptors. The current Service Categories are defined
   * as follows (note that Guaranteed Bit Rate (GBR) is not 
   * defined because it is generally not used):<p>
   * <ol>
   * <li> SC_CBR = Constant Bit Rate. For connections that require
   * a sstatic amount of bandwidth that is continuously available during
   * the lifetime of the connection.</li>
   * <li> SC_VBRRT = Variable Bit Rate - Real-Time. For connections that
   * require tightly constrained delay and delay variation.</li>
   * <li> SC_VBRNRT = Variable Bit Rate - NonReal-Time. For connections
   * that have bursty traffic.</li>
   * <li> SC_ABR = Available Bit Rate. For connections that do not require
   * bounding the delay or delay variation. Not intended for real-time
   * applications.</li> 
   * <li> SC_UBR = Unspecified Bit Rate. For connections that do not require
   * tightly constrained delay and delay variation.</li> 
   * <li> SC_GFR = Guaranteed Frame Rate. For non-real-time applications that may require 
   * a minimum rate guarantee and can benefit from accessing additional bandwidth 
   * dynamically available in the network.</li> 
   * <li> SC_NA = Not Applicable</li> 
   * </ol><br>
   **/
   enum ServiceCategory_T {
      SC_CBR,
      SC_VBRRT,
      SC_VBRNRT,
      SC_ABR,
      SC_UBR,
      SC_GFR,
      SC_NA
   };



  /**
   * <p>TrafficParametersList_T is used to specify the parameters 
   * used in Traffic Descriptors. The list is a sequence of 
   * name/value pairs (NVSList_T).  See
   * <a href=supportingDocumentation/trafficParameters.html>Traffic Parameters</a>
   * for a list of 
   * possible traffic parameters.</p>
   **/
   typedef globaldefs::NVSList_T TrafficParameterList_T;


  /**
   * <p>A Traffic Descriptor is a collection of attributes which 
   * are used to define bandwidth and Quality of Service 
   * characteristics on a TP.  Traffic Descriptors can be 
   * created by the NMS or the EMS.</p>
   *
   * globaldefs::NamingAttributes_T <b>name</b>:
   * <dir>The name represents the name of the
   * Traffic Descriptor which is assigned by the EMS upon creation.
   * The EMS is responsible for guaranteeing the uniqueness of the name
   * within the context of EMS.
   * It is a read-only attribute.</dir>
   *
   * string <b>userLabel</b>:
   * <dir>The userLabel is provisionable by the NMS. This attribute can be set
   * by NMS through the Common_I interface service
   * <a href=_common.Common_I.html#common::Common_I::setUserLabel>setUserLabel</a>. 
   * It is a read/write attribute.</dir>
   *
   * string <b>nativeEMSName</b>:
   * <dir>The name represents how the Traffic Descriptor is referred to on EMS displays. Its
   * aim is to provide a "nomenclature bridge" to aid relating information
   * presented on NMS displays to EMS displays (via GUI cut through).</dir>
   *
   * string <b>owner</b>
   * <dir>The owner is provisionable by the NMS. This attribute can be set
   * by NMS through the Common_I interface service
   * <a href=_common.Common_I.html#common::Common_I::setOwner>setOwner</a>. 
   * It is a read/write attribute.</dir>
   *
   * ServiceCategory_T <b>serviceCategory</b>
   * <dir>The Service Category contains quality of Service 
   * characteristics of the Traffic Descriptor.</dir>
   *
   * TrafficParameterList_T <b>trafficParameters</b>
   * <dir>The <a href=supportingDocumentation/trafficParameters.html>Traffic Parameter</a>
   * name/values associated with the Traffic Descriptor.</dir>
   *
   * string <b>conformanceDefinition</b>
   * <dir>The conformance definition for the Traffic Descriptor
   * from UNI 4.1, UNI 4.0 and UNI 3.1 standards.  For ATM, 
   * see <a href=supportingDocumentation/conformanceDefinitions.html>Conformance
   * Definitions</a>
   * for the valid values of this attribute.
   * This field is nullable if the conformance definition
   * does not apply.</dir>
   *
   * globaldefs::NVSList_T <b>additionalInfo</b>:
   * <dir>This attribute allows the communication from the EMS to the NMS of additional 
   * information which is not explicitly modelled.</dir>
   **/
   struct TrafficDescriptor_T {
    globaldefs::NamingAttributes_T name;
    string userLabel;
    string nativeEMSName;
    string owner;
    ServiceCategory_T serviceCategory;
    TrafficParameterList_T trafficParameters;
    string conformanceDefinition;
    globaldefs::NVSList_T additionalInfo;
   };


  /**
   * <p>TDCreateData_T is used when traffic descriptors are 
   * created by the NMS.</p>
   *
   * string <b>userLabel</b>:
   * <dir>The userLabel is provisionable by the NMS. This attribute can be set
   * by NMS through the Common_I interface service
   * <a href=_common.Common_I.html#common::Common_I::setUserLabel>setUserLabel</a>. 
   * It is a read/write attribute.</dir>
   *
   * boolean <b>forceUniqueness</b>:
   * <dir>Specifies whether uniqueness of the userLabel is required amongst TDs of 
   *  the EMS.  The operation will fail if userLabel is already in use.</dir>
   *
   * string <b>owner</b>
   * <dir>The owner is provisionable by the NMS. This attribute can be set
   * by NMS through the Common_I interface service
   * <a href=_common.Common_I.html#common::Common_I::setOwner>setOwner</a>. 
   * It is a read/write attribute.</dir>
   *
   * ServiceCategory_T <b>serviceCategory</b>
   * <dir>The Service Category contains quality of Service 
   * characteristics of the Traffic Descriptor.</dir>
   *
   * TrafficParameterList_T <b>trafficParameters</b>
   * <dir>The <a href=supportingDocumentation/trafficParameters.html>Traffic Parameter</a>
   * name/values associated with the Traffic Descriptor.</dir>
   *
   * string <b>conformanceDefinition</b>
   * <dir>The conformance definition for the Traffic Descriptor
   * from standards. See TrafficDescriptor_T.</dir>
   *
   * globaldefs::NVSList_T <b>additionalInfo</b>:
   * <dir>This attribute allows the communication from the EMS to the NMS of additional 
   * information which is not explicitly modelled.
   * It is a readonly attribute.</dir>
   **/
   struct TDCreateData_T {
    string userLabel;
    boolean forceUniqueness;
    string owner;
    ServiceCategory_T serviceCategory;
    TrafficParameterList_T trafficParameters;
    string conformanceDefinition;
    globaldefs::NVSList_T additionalInfo;
   };


  /**