org.asam.ods

Interface SMatLinkOperations

All Known Subinterfaces:

SMatLink

All Known Implementing Classes:

_SMatLinkStub, SMatLink, SMatLink, SMatLinkPOA

public interface SMatLinkOperations

The ASAM ODS submatrix link interface.

Method Summary

Methods

Modifier and Type	Method and Description
BuildUpFunction	getLinkType() (20001) Get the link or build type.
int	getOrdinalNumber() (20002) Get the ordinal or sequence number
SubMatrix	getSMat1() (20003) Get the first submatrix of the link.
Column[]	getSMat1Columns() (20004) Get the bind columns of the first submatrix used in the link (e.g.
SubMatrix	getSMat2() (20005) Get the second submatrix of the link.
Column[]	getSMat2Columns() (20006) Get the bind columns of the second submatrix used in the link (e.g.
void	setLinkType(BuildUpFunction linkType) (20007) Set the build or link type.
void	setOrdinalNumber(int ordinalNumber) (20008) Set the ordinal or sequence number.
void	setSMat1(SubMatrix subMat1) (20009) Set the first submatrix of the link.
void	setSMat1Columns(Column[] columns) (20010) Set the bind columns of the first submatrix used in the link (e.g.
void	setSMat2(SubMatrix subMat2) (20011) Set the second submatrix of the link.
void	setSMat2Columns(Column[] columns) (20012) Set the bind columns of the second submatrix used in the link (e.g.

Method Detail

getLinkType

BuildUpFunction getLinkType()
                            throws AoException

(20001) Get the link or build type.

Returns:

The link type.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getOrdinalNumber

int getOrdinalNumber()
                     throws AoException

(20002) Get the ordinal or sequence number

Returns:

The sequence number.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getSMat1

SubMatrix getSMat1()
                   throws AoException

(20003) Get the first submatrix of the link.

Returns:

The first submatrix of the link.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getSMat1Columns

Column[] getSMat1Columns()
                         throws AoException

(20004) Get the bind columns of the first submatrix used in the link (e.g. Time).

Returns:

The columns of the first submatrix.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getSMat2

SubMatrix getSMat2()
                   throws AoException

(20005) Get the second submatrix of the link.

Returns:

The second submatrix of the link.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getSMat2Columns

Column[] getSMat2Columns()
                         throws AoException

(20006) Get the bind columns of the second submatrix used in the link (e.g. Time).

Returns:

The columns of the second submatrix.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setLinkType

void setLinkType(BuildUpFunction linkType)
                 throws AoException

(20007) Set the build or link type.

Parameters:

linkType - The requested build-up function.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_INVALID_BUILDUP_FUNCTION AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setOrdinalNumber

void setOrdinalNumber(int ordinalNumber)
                      throws AoException

(20008) Set the ordinal or sequence number.

Parameters:

ordinalNumber - The sequence number.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_INVALID_ORDINALNUMBER AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setSMat1

void setSMat1(SubMatrix subMat1)
              throws AoException

(20009) Set the first submatrix of the link.

Parameters:

subMat1 - The first sub matrix of the sub matrix link.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_INVALID_SUBMATRIX AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setSMat1Columns

void setSMat1Columns(Column[] columns)
                     throws AoException

(20010) Set the bind columns of the first submatrix used in the link (e.g. Time).

Parameters:

columns - The column sequence of the sub matrix.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_INVALID_COLUMN AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setSMat2

void setSMat2(SubMatrix subMat2)
              throws AoException

(20011) Set the second submatrix of the link.

Parameters:

subMat2 - The second sub matrix of the sub matrix link.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_INVALID_SUBMATRIX AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

setSMat2Columns

void setSMat2Columns(Column[] columns)
                     throws AoException

(20012) Set the bind columns of the second submatrix used in the link (e.g. Time). If there is more than one column bound the column sequence must be identical with the column sequence of the first submatrix.

Parameters:

columns - The column sequence of the sub matrix.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_INVALID_COLUMN AO_NO_MEMORY AO_SESSION_NOT_ACTIVE