transmissiondescriptor.idl

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

#ifndef         transmissionDescriptor_idl
#define         transmissionDescriptor_idl

// *************************************
// *                                   *
// * transmissionDescriptor.idl        *
// *                                   *
// *************************************

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

#pragma prefix "mtnm.tmforum.org"

  /** 
   * <a href=supportingDocumentation/overview_NML-EML_Interface.pdf>Overview of 
   * NML-EML interface</a>
   *
   * <p>This module contains the definition of the Transmission Descriptors 
   * structure of the NML-EML interface.
   * It also contains the definition of the Transmission Descriptors 
   * manager.</p>
   *
   * <h5> Version 3.0. </h5>
   **/


module transmissionDescriptor
{

  /**
   * <p>Represents Service Categories used by Transmission 
   * 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 Transmission Descriptors. The list is a sequence of 
   * name/value pairs (NVSList_T).  See
   * <a href=supportingDocumentation/trafficParameters.pdf>Traffic 
   * Parameters</a> for a list of 
   * possible traffic parameters.</p>
   **/
   typedef globaldefs::NVSList_T TrafficParameterList_T;


  /**
   * <p>A Transmission Descriptor (TMD) is a collection of attributes
   * which are used to multi-layered transmission parameters are contained by 
   * the EMS and additional info parameters on a TP. Transmission 
   * Descriptors can be created by the NMS or the EMS.</p>
   *
   * globaldefs::NamingAttributes_T <b>name</b>:
   * <br>The name represents the name of the Transmission Descriptor
   * which is assigned by the EMS upon creation.  The EMS is responsible
   * for guaranteeing the uniqueness of the name within the EMS context.
   * It is a read-only attribute.<br>
   *
   * string <b>userLabel</b>:
   * <br>The userLabel is provisionable by the NMS.  This attribute
   * can be set by the NMS through the Common_I interface service
   * common::Common_I::setUserLabel(). It is a read-write attribute.<br>
   *
   * string <b>nativeEMSName</b>:
   * <br>The nativeEMSName represents how the Transmission 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). If supported by the EMS, this 
   * attribute can be set by the NMS through the Common_I interface service
   * common::Common_I::setNativeEMSName() . It is a read-write attribute.<br>
   *
   * string <b>owner</b>
   * <br>The owner is provisionable by the NMS.  This attribute
   * can be set by the NMS through the Common_I interface service
   * common::Common_I::setOwner() . It is a read-write attribute.<br>
   *
   * transmissionParameters::LayeredParameterList_T <b>transmissionParams</b>:
   * <br>A list of transmission parameters which can be set and retrieved at
   * a specified layer on a TP having this TMD assigned as egress or ingress 
   * TMD. It is a read-only attribute.<br>
   *
   * globaldefs::NVSList_T <b>additionalTPInfo</b>:
   * <br>Additional info parameters which can be set and/or retrieved
   * on a TP having this TMD assigned as egress or ingress TMD.
   * It is a read-only attribute.<br>
   *
   * globaldefs::NamingAttributes_T <b>containingTMDName</b>:
   * <br>The name of another TMD which is considered to contain this TMD.  The
   * containment semantics is that this TMD inherits the layered transmission
   * parameters and additional TP information from the containing TMD.
   * It is a read-only attribute.<br>
   *
   * string <b>externalRepresentationReference</b>:
   * A means to store at the EMS a reference to the external representation
   * of the TMD (e.g., an XML file name).  The contents of this
   * attribute is opaque at the NML-EML interface and not utilized.
   * It is a read-only attribute.
   *
   * globaldefs::NVSList_T <b>additionalInfo</b>:
   * <br>This allows the communication from the EMS to the NMS, and vice versa,
   * of additional information that isn't explicitly modelled, except that some
   * parameter names and values may be pre-defined.  This attribute can be set
   * by the NMS through the Common_I interface service
   * common::Common_I::setAdditionalInfo() . It is a read-write attribute but 
   * some parameters may be read-only.<br>
   *
   **/
   struct TransmissionDescriptor_T {
     globaldefs::NamingAttributes_T name;
     string userLabel;
     string nativeEMSName;
     string owner;
     transmissionParameters::LayeredParameterList_T transmissionParams;
     globaldefs::NVSList_T additionalTPInfo;
     globaldefs::NamingAttributes_T containingTMDName;
     string externalRepresentationReference;
     globaldefs::NVSList_T additionalInfo;
   };


  /**
   * <p>The attributes required for the creation of a transmission descriptor
   * on the EMS are packaged together in a TMDCreateData structure which the NMS
   * will pass to the EMS at TMD creation time. These are the read-create
   * attributes of the TMD.</p>
   *
   * string <b>userLabel</b>:
   * <br>The userLabel is provisionable by the NMS. This attribute can be set
   * by NMS through the Common_I interface service
   * common::Common_I::setUserLabel() . It is a read/write attribute and may be 
   * empty.<br>
   *
   * boolean <b>forceUniqueness</b>:
   * <br>Specifies whether uniqueness of the userLabel is required amongst TMDs 
   * of the EMS.  The operation will fail if userLabel is already in use.<br>
   *
   * string <b>owner</b>
   * <br>The owner is provisionable by the NMS. This attribute can be set
   * by NMS through the Common_I interface service
   * common::Common_I::setOwner() . It is a read/write attribute and may be 
   * empty.<br>
   *
   * transmissionParameters::LayeredParameterList_T <b>transmissionParams</b>:
   * <br>A list of transmission parameters which can be set and retrieved
   * at a specified layer on a TP having this TMD assigned as egress TMD
   * or ingress TMD.<br>
   * 
   * globaldefs::NVSList_T <b>additionalTPInfo</b>:
   * <br>Additional info parameters which can be set and retrieved
   * on a TP having this TMD assigned as egress TMD or ingress TMD.<br>
   *
   * globaldefs::NamingAttributes_T <b>containingTMDName</b>:
   * <br>The name of another TMD which is considered to contain this TMD.
   * The semantics of the containment is that the TMD to be created shall
   * inherit the layered transmission parameters and additional TP
   * information from the containing TMD.<br>
   *
   * string <b>externalRepresentationReference</b>:
   * A means to store at the EMS a reference to the external representation
   * of the TMD (e.g., an XML file name).  The contents of this
   * attribute is opaque at the NML-EML interface and not utilized.<br>
   *
   * globaldefs::NVSList_T <b>additionalCreationInfo</b>:
   * <br>Some additional creation information may be specified by the NMS.
   * This information may or may not become a part of the TMD's additionalInfo
   * attribute.  The list may be empty.<br>
   **/
   struct TMDCreateData_T {
    string userLabel;
    boolean forceUniqueness;
    string owner;
    transmissionParameters::LayeredParameterList_T transmissionParams;
    globaldefs::NVSList_T additionalTPInfo;
    globaldefs::NamingAttributes_T containingTMDName;
    string externalRepresentationReference;
    globaldefs::NVSList_T additionalCreationInfo;
   };


  /**
   * <p>A list of Transmission Descriptors.</p>
   **/