JAIN TCAP API
v1.1 - 5th Sept 2001

jain.protocol.ss7
Class SignalingPointCode

java.lang.Object
  |
  +--jain.protocol.ss7.SignalingPointCode
All Implemented Interfaces:
java.io.Serializable

public class SignalingPointCode
extends java.lang.Object
implements java.io.Serializable

The Signaling Point Code can be implemented in one of the following 2 ways

  • ITU_14bit - Split 3-8-3 across member/cluster/zone.
  • ANSI_24bit - Split 8-8-8 across member/cluster/zone. SSSAAAZZZ

    where:

    SSS == Member
    AAA == Cluster
    ZZZ == Zone

    The permitted ranges for each value are outlined in the table below.
     

    Member

    Cluster

    Zone

    ANSI

    000-255

    000-255

    000-255

    ITU

    000-007

    000-255

    000-007

    Version:
    1.1
    Author:
    Sun Microsystems Inc.
    See Also:
    Serialized Form

    Constructor Summary
    SignalingPointCode(int member, int cluster, int zone)
              Constructs a SignalingPointCode with the specified Member, Cluster, and Zone.
     
    Method Summary
    static int[] convertSPCToMemberClusterZone(int bitCode, int variant)
              Separates a Signaling Point Code out into the three fields member, cluster, and zone.
     int getCluster()
              Gets the Cluster field of the Signaling Point Code
     int getMember()
              Gets the Member field of the Signaling Point Code
     int[] getSignalingPointCode()
              Gets the SignalingPointCode, containing the member, cluster and zone fields of the SignalingPointCode.
     int getZone()
              Gets the Zone field of the Signaling Point Code
     void setCluster(int cluster)
              Sets the Cluster field of the Signaling Point Code
     void setMember(int member)
              Sets the Member field of the Signaling Point Code
     void setSignalingPointCode(int member, int cluster, int zone)
              Sets the member field, containing the member field of the signaling point code.
     void setZone(int zone)
              Sets the Zone field of the Signaling Point Code
     java.lang.String toString()
              String representation of class SignalingPointCode
     
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
     

    Constructor Detail

    SignalingPointCode

    public SignalingPointCode(int member,
                              int cluster,
                              int zone)
    Constructs a SignalingPointCode with the specified Member, Cluster, and Zone.
    Parameters:
    member - the new member field supplied to the constructor
    cluster - the new cluster field supplied to the constructor
    zone - the new zone field supplied to the constructor
    Since:
    JAIN TCAP v1.1
    Method Detail

    setMember

    public void setMember(int member)
    Sets the Member field of the Signaling Point Code
    Parameters:
    member - the member field of the Signaling Point Code

    getMember

    public int getMember()
                  throws MandatoryParameterNotSetException
    Gets the Member field of the Signaling Point Code
    Throws:
    MandatoryParameterNotSetException - thrown if this parameter has not been set

    setCluster

    public void setCluster(int cluster)
    Sets the Cluster field of the Signaling Point Code
    Parameters:
    cluster - the new cluster of the Signaling Point Code

    getCluster

    public int getCluster()
                   throws MandatoryParameterNotSetException
    Gets the Cluster field of the Signaling Point Code
    Throws:
    MandatoryParameterNotSetException - thrown if this parameter has not been set

    setZone

    public void setZone(int zone)
    Sets the Zone field of the Signaling Point Code
    Parameters:
    zone - the new zone of the Signaling Point Code

    getZone

    public int getZone()
                throws MandatoryParameterNotSetException
    Gets the Zone field of the Signaling Point Code
    Throws:
    MandatoryParameterNotSetException - thrown if this parameter has not been set

    setSignalingPointCode

    public void setSignalingPointCode(int member,
                                      int cluster,
                                      int zone)
    Sets the member field, containing the member field of the signaling point code.
    Parameters:
    member - the new member field
    cluster - the new cluster field
    zone - the new zone field

    getSignalingPointCode

    public int[] getSignalingPointCode()
                                throws MandatoryParameterNotSetException
    Gets the SignalingPointCode, containing the member, cluster and zone fields of the SignalingPointCode.
    Returns:
    the SignalingPointCode of this Sccp User Address
    Throws:
    MandatoryParameterNotSetException - thrown if this parameter has not been set
    Since:
    JAIN TCAP v1.1
    See Also:
    SignalingPointCode

    convertSPCToMemberClusterZone

    public static int[] convertSPCToMemberClusterZone(int bitCode,
                                                      int variant)
    Separates a Signaling Point Code out into the three fields member, cluster, and zone.
    Parameters:
    bitcode - the Signaling Point Code stored as a bitfield
    variant - the stack specification of the signaling point code to be decoded (ANSI/ITU)
    Returns:
    the member,cluster,zone stored in an array

    toString

    public java.lang.String toString()
    String representation of class SignalingPointCode
    Overrides:
    toString in class java.lang.Object
    Returns:
    String provides description of class SignalingPointCode

    JAIN TCAP API
    v1.1 - 5th Sept 2001

    Email comments to [email protected]