terminationpoint.idl

来自「UCS (Ultra Corba Simulator) is one more 」· IDL 代码 · 共 380 行 · 第 1/2 页

   * bidirectional SNCs can be supported by bidirectional endpoint
   * TPs only, unidirectional SNCs can be supported by both, bidirectional and unidirectional
   * endpoint TPs where the TPConnectionState indicates the 
   * TP is either source connected (a_end of an SNC) or a sink connected (z_end of an SNC).
   * In either case, the intermediate CTPs used by the SNC may be unidirectional or
   * bidirectional.
   * The location of free unidirectional resources may 
   * be determined by testing for source or sink connected termination points. Termination points
   * that are bidirectional cannot be assumed to be 
   * associated with bidirectional SNCs except by checking the connection direction on the SNC(s)
   * using the Termination point.</p> 
   * 
   * <p>For details on how TPs should be modelled see
   * <a href=supportingDocumentation/layers.pdf>layering</a>.</p>
   *
   * <p>The naming for TPs is deterministic, see
   * <a href=supportingDocumentation/objectNaming.html>Object Naming</a>.
   *
   * <p>A CTP is a (Subnetwork) Connection Termination Point. A CTP is a 
   * potential end point of a subnetwork connection.
   * If a CTP is part of an active subnetwork connection, then 
   * the CTP entity must exist on an NE (in terms of TL1 the termination is 
   * entered), otherwise the model does not specify if the CTP exists on the NE 
   * or not. </p>
   *
   * <p>A PTP (Physical) Topological Link Termination Point) is an end-point of a 
   * Physical Link. Examples of PTPs are T1 ports, T3 ports, OC-N optical 
   * ports, etc. PTPs have a containment relation with CTPs. </p>
   *
   * <p>A TPPool is a TP Pool Termination Point. It is used to logically group CTPs for 
   * administrative purposes. An example is the partitioning of VP CTPs for
   * bandwidth management. </p>
   *
   * <p>PTPs forming an APS pair are related. </p>
   *
   * globaldefs::NamingAttributes_T <b>name</b>:
   * <dir>The name represents the name of the
   * Termination Point which is assigned by the EMS upon creation.
   * The EMS is responsible for guaranteeing the uniqueness of the name
   * within the context of the ManagedElement
   * The naming for CTPs and PTPs is deterministic, see
   * <a href=supportingDocumentation/objectNaming.html>Object Naming</a>
   * for further detail.
   * It is a readonly attribute.</dir>
   *
   * string <b>userLabel</b>:
   * <dir>The user label of the TP is set with NMS data (typically the 
   * end to end trail data). This can be set via the setUserLabel operation.  The user label may
   * be cleared when the TP is deleted or when the model does not specify
   * if the CTP exists (see above). The EMS
   * is expected to place this data in the PM Data file 
   * transfers if the EMS supports the Performance Manager services.
   * It is a read-write attribute.</dir>
   *
   * string <b>nativeEMSName</b>:
   * <dir>The name represents how the TP is refered to on EMS displays. Its
   * aim is to provide a "nomenclature bridge" the aid relating information
   * presented on NMS displays to EMS displays (via GUI cut through).
   * It is never set to NULL string.</dir>
   *
   * string <b>owner</b>:
   * <dir>The owner attribute of the TerminationPoint indicates the ownership 
   * of the TP so that adminstrativeState can be managed. Since the
   * administrative state is not used, there is no use for this now.
   * 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>.  The
   * owner may be cleared when the TP is deleted or when the model does not specify
   * if the CTP exists (see above). 
   * It is a read/write attribute.</dir>
   *
   * globaldefs::NamingAttributes_T <b>ingressTrafficDescriptorName</b>:
   * <dir>A connection termination point may have an optional reference to an ingress (incoming)
   * Traffic Descriptor. The Traffic Descriptor name will be empty
   * if there is no associated Traffic Descriptor.</dir>
   *
   * globaldefs::NamingAttributes_T <b>egressTrafficDescriptorName</b>:
   * <dir>A connection termination point may have an optional reference to an egress (outgoing)
   * Traffic Descriptor. The Traffic Descriptor name will be empty
   * if there is no associated Traffic Descriptor.</dir>
   *
   * TPType_T <b>type</b>:
   * <dir>Because the TerminationPoint can either be a PTP, CTP or TPPool
   * it is necessary to identify its type.
   * It is a readonly attribute.</dir>
   *
   * TPConnectionState_T <b>connectionState</b>:
   * <dir>This attribute is only applicable to CTPs.
   * If the source is connected to one entity and the sink is
   * connected to another entity then the value of this attribute
   * is TPCS_BI_CONNECTED.
   * This is a readonly attribute.</dir>
   *
   * TerminationMode_T <b>tpMappingMode</b>:
   * <dir>Within the fa鏰de definition, the CTP can act as an 
   * aggregate of a CTP and
   * an associated TTP at the same LayerRate within the 
   * aggregate of the same PTP.
   *
   * The TerminationMode attribute indicates and controls the connection of
   * the named CTP at a specified LayerRate to the dedicated TTP at the same 
   * LayerRate within the same PTP.
   *
   * The TerminationMode is used, for example, to control the Termination and
   * mapping to VT1.5 of an STS1 Trail within an OC3 port. This capability
   * could potentially be used to terminate an STS1 backbone Trail within 
   * a lower order mux that has the capability to alternatively 
   * cross-connect the STS1 unterminated. The same capability is used in SDH
   * and is potentially applicable to any LayerRate.</dir>
   *
   * Directionality_T <b>direction</b>:
   * <dir>The direction of the termination point. 
   * It is a readonly attribute.</dir>
   *
   * transmissionParameters::LayeredParameterList_T	<b>transmissionParams</b>:
   * <dir>A list of transmission parameters which can be set and/or
   * retrieved on the TP at a specified layer.
   * This attribute must contain the complete set of layer rates represented by
   * a PTP or CTP - even if they have no parameters associated with them.
   * This attribute can be set by an NMS through the 
   * <a href=_managedElementManager.ManagedElementMgr_I.html#managedElementManager::ManagedElementMgr_I::setTPData>setTPData</a>
   * operation and also during SNC creation.
   * The values for the name field and the value fields of the NVSList_T
   * are defined in <a href=supportingDocumentation/layeredParameters.html>Layered
   * Parameters</a>.</dir>
   *
   * TPProtectionAssociation_T <b>tpProtectionAssociation</b>:
   * <dir>The associated TP indication. The NMS is responsible to invoke
   * the <a name=multiLayerSubnetwork.html#multiLayerSubnetworkMgr_I::MultiLayerSubnetworkMgr_I::getAssociatedTP>getAssociatedTP</a>
   * service to obtain the related TP if any.</dir>
   *
   * boolean <b>edgePoint</b>:
   * <dir>Indicates if the TP is an edge point of at least one subnetwork,
   * i.e. if it is an end
   * point of a potential inter-subnetwork topological link.</dir>
   *
   * globaldefs::NVSList_T <b>additionalInfo</b>:
   * <dir>This attribute allows the communication from the EMS to the NMS of additional 
   * information which isn't explicitly modelled.  For example, a parameter "TPPoolUse"
   * could be included for TP pools to indicate their uses.
   * This may be an empty list.
   * It is a readonly attribute.</dir>
   * <br>
   **/
   struct TerminationPoint_T
   {
   globaldefs::NamingAttributes_T name;
   string userLabel;
   string nativeEMSName;
   string owner;
   globaldefs::NamingAttributes_T ingressTrafficDescriptorName;
   globaldefs::NamingAttributes_T egressTrafficDescriptorName;
   TPType_T type;
   TPConnectionState_T connectionState;
   TerminationMode_T tpMappingMode;
   Directionality_T direction;
   transmissionParameters::LayeredParameterList_T transmissionParams;
   TPProtectionAssociation_T tpProtectionAssociation;
   boolean edgePoint;
   globaldefs::NVSList_T additionalInfo;
  };

  /**
   * <p>Sequence of TerminationPoint_T.</p>
   **/
  typedef sequence<TerminationPoint_T> TerminationPointList_T;


  /**
   * <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 TerminationPointIterator_I
    {
	boolean  next_n(in unsigned long 		how_many,
		        out TerminationPointList_T 	tpList)
	         raises (globaldefs::ProcessingFailureException);

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

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