You are here: SwitchKitฎ Development Environment - TCAP Interface Users Guide > 3 SKIM Parameter Classes > SKIM_Operation Class Methods

SKIM_Operation Class Methods

This section provides details about the methods available for the SKIM_Operation class.

SetType()

Description

Sets the type of this operation

Syntax

int SetType(SKIM_USHORT type);

Input Parameters

type: the operation type is one of the following:

SKIM_TC_INVOKE (Same as Invoke Last for ANSI)

SKIM_TC_INVOKE_NL

SKIM_TC_RESULT

SKIM_TC_RESULT_L

SKIM_TC_ERROR

SKIM_TC_REJECT (For ANSI)

SKIM_TC_U_REJECT (For ITU)

SKIM_TC_CANCEL

Input/Output Parameters, Output Parameters

None

GetType()

Description

Returns the type of this operation.

Syntax

SKIM_USHORT GetType();

Input Parameters, Input/Output Parameters & Output Parameters:

None

Return Values

The type of this component is one of the following:

SKIM_TC_INVOKE

SKIM_TC_INVOKE_NL (Same as Invoke Last for ANSI)

SKIM_TC_RESULT

SKIM_TC_RESULT_L

SKIM_TC_ERROR

SKIM_TC_REJECT

SKIM_TC_U_REFJECT (For ITU)

SKIM_TC_R_REFJECT (For ITU)

SKIM_TC_L_REFJECT (For ITU)

SKIM_TC_CANCEL

SetInvokeId()

Description

Populates the invoke ID for this operation. Invoke IDs are common to all operation types. For ANSI TCAP, use this API to set the correlation ID for RESULT/ERROR/REJECT operations.

Syntax

void SetInvokeId(SKIM_OCTET invokeId);

Input Parameters

value: The invoke ID value. The valid range is 0-255.

Input/Output Parameters

None

Output Parameters

None

GetInvokeId()

Description

Returns the invoke ID of an operation. Invoke IDs are common to all operation types. For ANSI TCAP, use this API to get the correlation ID for RESULT, ERROR, and REJECT operations.

Syntax

SKIM_OCTET GetInvokeId();

Input Parameters, Input/Output Parameters & Output Parameters

None

Return Value

The invoke ID as an unsigned character.

SetLinkedId()

Description

Sets the linked ID (ITU) or correlation ID (ANSI) to the value supplied. This is valid only when the operation type is SKIM_TC_INVOKE or SKIM_TC_INVOKE_NL. For any other operation type this method simply returns and nothing is set. You do not need to call this method if the linked ID is not relevant. It is assumed that no linked ID is present unless this method is called.

Syntax

void SetLinkedId(SKIM_OCTET id);

Input Parameters, Input/Output Parameters, & Output Parameters

None

HasLinkedId()

Description

Returns SKIM_TRUE if the linked ID (ITU) or correlation ID (ANSI) is present in Invoke operation. This is valid only when the operation type is SKIM_TC_INVOKE.

Syntax

SKIM_BOOLEAN HasLinkedId();

Input Parameters, Input/Output Parameters, & Output Parameters

None

Return Value

SKIM_TRUE: Linked ID present.

SKIM_FALSE: Linked ID not present.

GetLinkedId()

Description

Gets the linked ID (ITU) or correlation ID (ANSI) of an invoke, if supplied. This is valid only when the operation type is SKIM_TC_INVOKE or SKIM_TC_INVOKE_NL.

Syntax

SKIM_OCTET GetLinkedId();

Return Value

The linked ID is returned as an unsigned character.

SetClass()

Description

Sets the operation class for TCAP components. The SetClass() method is used for ITU TCAP only.

Syntax

void SetClass(const SKIM_USHORT val);

Input Parameters

val: A number from 1 to 4 indicating the operation class:

Class 1: Both success and failure are reported

Class 2: Only failure is reported

Class 3: Only success is reported

Class 4: Neither success, or failure is reported

Input Parameters, Input/Output Parameters, & Output Parameters

None

Return Value

None

GetClass()

Description

Retrieves the operation class for TCAP invokes. The GetClass method is used for ITU TCAP only.

Syntax

SKIM_USHORT GetClass() const;

Input Parameters, Input/Output Parameters, & Output Parameters

None

Return Values

A number from 1 to 4 indicating the operation class:

Class 1: Both success and failure are reported

Class 2: Only failure is reported

Class 3: Only success is reported

Class 4: Neither success, nor failure is reported

SetInvokeTimeout()

Description

Sets the timeout value for TCAP invokes. This is valid only when the operation type is SKIM_TC_INVOKE (used for ITU only).

Syntax

void SetInvokeTimeout(SKIM_UINT timeout);

Input Parameters

val: the timeout value in seconds. Range is 1-500.

Input/Output Parameters and Output Parameters

None

SetParameter()

Description

Copies a user-defined parameter into the given operation. If an operation does not have a parameter, you do not need to call this method. The parameter is assumed to be not present unless this method is called with a non-zero vector.

Syntax

void SetParameter(vector <byte> ¶m);

Input Parameters,

buf: A vector containing the parameter to copy into this operation.

Input/Output Parameters and Output Parameters:

None

GetParameter()

Description

Copies the parameter in a given operation into a user-supplied vector. Returning a vector.size () of zero indicates that no parameter is present.

Syntax

void GetParameter(vector <byte> ¶m);

Input Parameters and Input/Output Parameters

None

Output Parameters:

buf: A vector for the parameter to copy.

IsLastOperation()

Description

Specifies whether the given operation is the last incoming operation associated with a TCAP transaction.

Syntax

bool IsLastOperation();

Input Parameters, Input/Output Parameters & Output Parameters

None

Return Value

SKIM_TRUE: If given operation is the last operation.

SKIM_False: If given operation is not the last operation.

SetOpCode() (For ITU)

Description

Sets the operation field of a given operation. This is valid only when operation type is:

SKIM_TC_INVOKE

SKIM_TC_RESULT_L

SKIM_TC_RESULT_NL

Syntax

void SetOpCode(const SKIM_LONG code);

Input Parameters, Input/Output Parameters & Output Parameters

None

GetOpCode()(For ITU)

Description

Gets the operation field of a given operation. This is valid only when the operation type is:

SKIM_TC_INVOKE

SKIM_TC_RESULT_L

SKIM_TC_RESULT_NL

Syntax

void GetOpCode(SKIM _LONG & code);

Input Parameters, Input/Output Parameters

None

Output Parameters

code: The operation code.

SetOpCode() (For ANSI)

Description

Sets the operation field of a given operation. This is valid only when operation type is:

SKIM_TC_INVOKE

SKIM_TC_RESULT_L

SKIM_TC_RESULT_NL

Syntax

void SetOpCode(const bool isNational, const SKIM_OCTET family, const SKIM_OCTET code);

Input Parameters,

IsNational: True if National, false if private

family: Operation family. Possible values are provided in Appendix A ANSI TCAP Operation Family.

code: The operation code specifier.

Input/Output Parameters and Output Parameters:

None

GetOpCode()(For ANSI)

Description

Gets the operation field of a given operation.This is valid only when operation type is:

SKIM_TC_INVOKE

SKIM_TC_RESULT_L

SKIM_TC_RESULT_NL

Syntax

GetOpCode(bool& isNational, SKIM_OCTET& family,

SKIM_OCTET& code);

Input Parameters and Input/Output Parameters

None

Output Parameters

IsNational: True if National, false if private

family: Operation family. Possible values are provided in Appendix A ANSI TCAP Operation Family.

code: the operation code.

SetErrorCode() (For ITU)

Description

Sets the error code in an error operation.

Syntax

void SetErrorCode(SKIM_OCTET errorCode);

Input Parameters

code: the error code.

Input/Output Parameters and Output Parameters:

None

GetErrorCode() (For ITU)

Description

Gets the error code in an error operation.

Syntax

void GetErrorCode(SKIM_OCTET &errorCode);

Input Parameters and Input/Output Parameters

None

Output Parameters

code: the error code.

SetErrorCode() (For ANSI)

Description

Sets the error code in an error operation.

Syntax

void SetErrorCode(SKIM_BOOLEAN isNational, SKIM_OCTET errorCode);

Input Parameters

IsNational: True if National, false if private.

code: The error code. Possible values are provided in Appendix - TCAP Codes.

Input/Output Parameters and Output Parameters

None

GetErrorCode() (For ANSI)

Description

Gets the error code in an error operation.

Syntax

void GetErrorCode(SKIM_BOOLEAN &isNational, SKIM_OCTET &errorCode);

Input Parameters, Input/Output Parameters

None

Output Parameters

IsNational: True if National, false if private.

code: The error code. Possible value provided in Appendix - TCAP Codes.

SetRejectCause()

Description

Sets the problem code for a reject operation.

Syntax

void SetRejectCause(const SKIM_OCTET type, const SKIM_OCTET code);

Input Parameters

type: The problem family. As specified in Appendix A.

code: The problem code. As specified in Appendix A.

Input/Output Parameters and Output Parameters

None

GetRejectCause()

Description

Gets the problem code for a reject operation.

Syntax

void GetRejectCause(SKIM_OCTET& type, SKIM_OCTET& code);

Input Parameters and Input/Output Parameters

None

Output Parameters

type: The problem family

code: The problem code

American National Standards Institute. ANSI administers and coordinates the U.S. voluntary standardization and conformity assessment system for the
telecommunications industry. More details on these standards may be
viewed at www.ansi.org.
International Telecommunications Union (UN)
See Transaction Capability Application Part.
A sequence of eight bits.