You are here: SwitchKit® Development Environment - TCAP Interface User’s Guide > 3 SKIM Parameter Classes > SKIM_CallingPartyAddress/SKIM_CalledParty Address Class Methods
SKIM_CallingPartyAddress/SKIM_CalledParty Address Class Methods
This section provides details about the methods available for the SKIM_ CallingPartyAddress / SKIM_CalledPartyAddress class.
Description
Determines whether an SCCP_Address object has a point code.
Syntax
Bool HasPointCode() const
Input Parameters, Input/Output Parameters, & Output Parameters
None
Return Value
A Boolean value, true if the point code was set, false otherwise.
Description
Retrieves the point code value from an SCCP_Address object.
Syntax
SKIM_UINT GetPointCode() const
Input Parameters, Input/Output Parameters, & Output Parameters
None
Return Value
Returns the point code value as an unsigned integer.
Description
Sets the point code value for an SCCP_Address object.
Syntax
void
SetPointCode(const SKIM_UINT pc)
{
hasPC = true;
pointCode = pc;
Input Parameters
pc: The value to store for the point code.
Input/Output Parameters and Output Parameters
None
Return Value
None
Description
Determines whether an SCCP_Address object has a subsystem number (SSN).
Syntax
Bool HasSSN() const
Input Parameters, Input/Output Parameters, & Output Parameters
None
Return Value
A boolean value, true if the SSN was set, false otherwise.
Description
Retrieves the subsystem number value from an SCCP_Address object.
Syntax
void
Input Parameters, Input/Output Parameters, & Output Parameters
None
SKIM _OCTET GetSSN() const
Input Parameters, Input/Output Parameters, & Output Parameters
None
Return Value
Returns the subsystem number value as an unsigned char.
Description
Sets the subsystem number value for an SCCP_Address object.
Syntax
Void SetSSN(const SKIM_OCTET sn)
Input Parameters:
ssn: The value to store for subsystem number (SSN).
Input/Output Parameters and Output Parameters
Return Value
None
Description
Determines whether the "routed by" flag value for an SCCP_Address object has been set. Setting this to false implies routing by global title translation (GTT). To send this message properly with the false setting, you must use the SetGlobalTitle() method.
Syntax
Bool IsRoutedByPCSSN() const
Input Parameters, Input/Output Parameters, & Output Parameters
None
Return Value
True if the value has been set, otherwise False.
Description
Sets the "routed by" flag value for an SCCP_Address object. Setting this to false implies routing by global title translation (GTT).
Syntax
Void SetRouteByPCSSN(const bool which)
Input Parameters
which: the value to store for the "routed by" flag.
Input/Output Parameters and Output Parameters
None
Return Value
None
Description
Determines whether an SCCP_Address object had the international routing flag set.
Syntax
Bool IsInternationalRouting() const
Input Parameters, Input/Output Parameters, & Output Parameters
None
Return Value
A boolean value, true if the flag was set, false otherwise.
Description
Sets the international routing flag value for an SCCP_Address object.
Syntax
void SetInternationalRouting(const bool which)
// Global title
Input Parameters
which: The value to store for the international routing flag.
Input/Output Parameters and Output Parameters
None
Description
Determines whether an SCCP_Address object has global title information.
Syntax
bool
HasGlobalTitle() const
Input Parameters, Input/Output Parameters, & Output Parameters
None
Return Value
A boolean value, true if the global title was set, false otherwise.
Description
Sets global title information for this address.
Syntax
int
SetGlobalTitle(const SKIM_OCTET type,
const SKIM_OCTET* gttInfo, const SKIM_USHORT gttLength)
Input Parameters
which: The value to store for the international routing flag
Input/Output Parameters and Output Parameters
None
type: The address indicator flag for this global title translation (GTT) type.
Possible values for ITU SCCP are:
|
Value |
Description |
|
SCCP_CPA_GTTI_NATURE |
Global title contains nature of address. |
|
SCCP_CPA_GTTI_TRANS |
Global Title contains translation type. |
|
SCCP_CPA_GTTI_TNE |
Global Title contains translation type, numbering plan and encoding scheme. |
|
SCCP_CPA_GTTI_ALL |
Global title contains translation type, nature of address, numbering plan, and encoding scheme |
Possible values for ANSI SCCP are:
|
Value |
Description |
|---|---|
|
SCCP_CPA_GTTI_TRANS |
Global Title contains translation type. |
|
SCCP_CPA_GTTI_TNE |
Global Title contains translation type, numbering plan and encoding scheme. |
gttInfo: The global title information. Global title information should be encoded in accordance with GTT type, as specified in ITU / ANSI SCCP specification.
gttLength: the size of the GTT information.
Return Value
None
Description
Gets the global title information for this address.
Syntax
int
GetGlobalTitle(SKIM_OCTET& type,
SKIM_OCTET* gttInfo, SKIM_USHORT& gttLength) const
Input Parameters and Input/Output Parameters
None
Output Parameters
type: The address indicator flag for this GTT type.
Possible values for ITU SCCP are:
|
Value |
Description |
|---|---|
|
SCCP_CPA_GTTI_NATURE |
Global title contains nature of address. |
|
SCCP_CPA_GTTI_TRANS |
Global Title contains translation type. |
|
SCCP_CPA_GTTI_TNE |
Global Title contains translation type, numbering plan, and encoding scheme. |
|
SCCP_CPA_GTTI_ALL |
Global title contains translation type, nature of address, numbering plan and encoding scheme. |
Possible values for ANSI SCCP are:
|
Value |
Description |
|---|---|
|
SCCP_CPA_GTTI_TRANS |
Global Title contains translation type. |
|
SCCP_CPA_GTTI_TNE |
Global Title contains translation type, numbering plan and encoding scheme. |
gttInfo: The global title translation information. Global title information should be encoded in accordance with GT type, as specified in ITU / ANSI SCCP specification.
gttLength: The size of the GTT information.
Return Value
None