terminationpoint.idl

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

#ifndef terminationPoint_idl
#define terminationPoint_idl

// ********************************
// *                              *
// * terminationPoint.idl         *
// *                              *
// ********************************

//Include list
#include "globaldefs.idl"
#include "transmissionParameters.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 terminationPoint structure
   * of the NML-EML interface.</p>
   *
   * <h5> Version 2.0. </h5>
   **/


module terminationPoint
{
  /**
   * <p>Direction for a TerminationPoint:</p>
   * <dir>D_NA = used when the directionality specification is not necessary.<br>
   * D_BIDIRECTIONAL = source and sink (transmit and receive).<br>
   * D_SOURCE = source (transmit).<br>
   * D_SINK = sink (receive).<br> 
   * </dir>
   *
   * <p>The directionality of PTPs is defined from an external point of view,
   * while the directionality of CTPs is defined from an internal point of view.
   * Consequently, sink PTPs generate source CTPs, and sink CTPs form source PTPs.
   * Refer to <a href=supportingDocumentation/snctypes.pdf>SNC Types</a>.</p>
   *
   * <p>Note that ATM termination points (LR_ATM_NI, LR_ATM_VP and LR_ATM_VC) are 
   * always bi-directional even though the traffic may be asymmetric (and eventually
   * null in one of the two directions).</p>
   **/
   enum Directionality_T
   {
     D_NA,
     D_BIDIRECTIONAL,
     D_SOURCE,
     D_SINK
   };


 /**
   * <p>A CTP may be involved in zero, one, or many connections. The value
   * TPConnectionState indicates the degree to which a CTP is used.
   * The values TPCS_SOURCE_CONNECTED and TPCS_SINK_CONNECTED reflect the 
   * presence of a one way connection. The value TPCS_BI_CONNECTED means
   * that the TP is both sink and source connected.</p>
   *
   * <p>If an EMS cannot report whether the source of the TP is connected
   * or the sink is connected, TPCS_BI_CONNECTED may be reported by that
   * EMS.</p>
   *
   * <p>The value TPCS_NA is used for PTPs and TPPools.</p>
   **/
   enum TPConnectionState_T
   {
     TPCS_NA,
     TPCS_SOURCE_CONNECTED,
     TPCS_SINK_CONNECTED,
     TPCS_BI_CONNECTED,
     TPCS_NOT_CONNECTED
   };


  /**
   * <p>As the interface is coarse grained, TPs are modeled as pure data objects
   * and do not appear as first class CORBA objects at the 
   * interface between the NMS and EMS.</p>
   *
   * <p>The PTP or Physical Termination Point represents a single port of an
   * NE. The PTP is an aggregate of G.805 TTPs and G.805 CTPs.
   * The PTP has been added for performance and interface simplification.</p>
   *
   * <p>A CTP in this model may correspond directly to a single G.805 CTP or may
   * represent an aggregate of a G.805 TTPs and G.805 CTPs.</p>
   *
   * <p>A TPPool is a set of Termination Points (either CTPs and/or PTPs). This type has 
   * been initially introduced to support the concept of administrative partitioning
   * of an ATM Network Interface (a VP TPPool is defined as a set of VP CTPs).</p>
   **/
   enum TPType_T
   {
     TPT_PTP,
     TPT_CTP,
     TPT_TPPool
   };


  /**
   * <p>TerminationMode has the following values: </p>
   * <dir>TM_TERMINATED_AND_AVAILABLE_FOR_MAPPING indicates that the G.805 CTP 
   * is attached to the
   * corresponding G.805 TTP within the CTP aggregate 
   * and is providing client layer capacity (e.g. STS1
   * terminated and mapped to VT1.5 i.e. channelized).<br> 
   * TM_NEITHER_TERMINATED_NOR_AVAILABLE_FOR_MAPPING indicates that the CTP is available for
   * connectivity (e.g. STS1 not terminated and not mapped to VT1.5 
   * i.e. not channelized).<br>
   * TM_NA is used for PTPs and also used for CTPs where an SNC (or crossconnect) can be used
   * to connect the G.805 TTP of the CTP to the connection point of another CTP.<br>
   * </dir>
   *
   * <p>For more discussion on terminationMode see
   * <a href=supportingDocumentation/layers.pdf>layering</a>.</p>
   *
   * <p>For ATM SNCs, the Terminated and Mapped parameter of a VP or VC CTP is used to
   * model a VPC or a VCC terminating within the Managed Element (i.e.
   * internal VP or VC Trails). Such a terminated ATM connection is used as a
   * trail acting as a server for upper layer protocols (e.g., VCCs in case of a VPC TP,
   * Frame Relay in case of a VCC TP). In the two switching layer ATM model,
   * the VP layer acts as the infrastructure on which VC Connections 
   * (either PVC, SPVC or SVC) are routed and switched. This capability allows the 
   * operator to build a logical partitioning (VP overlay) of the physical ATM 
   * network by configuring VPCs (or VP "tunnels") which are terminated inside the 
   * subnetwork. Such overlay VP network allows operators to aggregate and segregate 
   * VCs according to their traffic management policy. In addition, the use of an 
   * intra-subnetwork VPC may provide for enhanced protection of the VC traffic by 
   * using 1+1 VP protection (VP protection is not supported in this release
   * of the EMS-NMS interface). In order to be able to make routing decisions at 
   * VC level (e.g., explicit route constraint), the NMS needs to know the VP topology
   * available from the ATM network.</p>
   *
   * <p>Note that requesting the operator to explicitly set up an overlay VP network
   * as a pre-requisite for passing any VC traffic may be cumbersome and in some case
   * results in a sub-optimal use of the ATM links. For that reason, most ATM NEs provide
   * for an alternative which allows for each ATM NE to act as a VC switch without having
   * to explicitly configure VPs (i.e., each ATM link acts as an internal VP link between
   * two adjacent nodes).</p>
   **/
   enum TerminationMode_T
   {
     TM_NA,
     TM_NEITHER_TERMINATED_NOR_AVAILABLE_FOR_MAPPING,
     TM_TERMINATED_AND_AVAILABLE_FOR_MAPPING
   };


  /**
   * <p>tpProtectionAssociation expresses constraints on PTPs and CTPs for PSR connection
   * management.</p>
   *
   * <p>In a multi-layer subnetwork, say 'a', 'b', 'c' are edge points.
   * Suppose, for example, a three-ended connection is sought from 'a' to 'b', 
   * where 'b' is one of the endpoints.
   * If 'c' is the constrained choice for 'b' as the other end of the three-ended connection,
   * then 'b' and 'c' are said to be
   * associated by a protectionAssociation. 
   * The tpProtectionAssociation is set to TPPA_PSR_RELATED in 'b' and 'c', and 
   * getAssociatedTP(b) returns c and getAssociatedTP(c) returns b.</p>
   *
   * <p>In all other cases, tpProtectionAssociation is set to TPPA_NA.</p>
   *
   * <p>The <a href=_multiLayerSubnetwork.MultiLayerSubnetworkMgr_I.html#multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAssociatedTP>getAssociatedTPs</a>
   * service must be used to obtain the related TP.</p>  
   **/
   enum TPProtectionAssociation_T
   {
     TPPA_NA,
     TPPA_PSR_RELATED
   };


  /**
   * <p>A TP is modeled as a data structure to avoid a great number of
   * CORBA objects across the EMS/NMS interface. Internally in the EMS,
   * these data structures can map to any desired architecture.   </p>
   *
   * <p>This is an
   * abstract class that encapsulates the data and behavior that is common
   * to the different types of end points. For instance, a TP may be
   * Sink (Receive), Source (Transmit) or Bi-directional (Transmit and
   * Receive), has a LayerRate, a name and a userLabel. Each TP has an
   * associated set of attributes that represent transmission parameters.
   * For a PTP the transmission parameters are at various LayerRates (that
   * are aggregated to form the PTP); for a CTP the parameters may
   * only be for a single LayerRate. </p>
   *
   * <p>Termination points in this model are either bidirectional or unidirectional. Whereas