org.asam.ods

Interface MeasurementOperations

All Superinterfaces:

InstanceElementOperations

All Known Subinterfaces:

Measurement

All Known Implementing Classes:

_MeasurementStub, Measurement, Measurement, MeasurementPOA

public interface MeasurementOperations
extends InstanceElementOperations

The ASAM ODS measurement interface.The interface Measurement extends the interface InstanceElement. Thus all methods of the interface InstanceElement do also work here.

Method Summary

Methods

Modifier and Type	Method and Description
SMatLink	createSMatLink() (16001) Create a submatrix link.
SMatLink[]	getSMatLinks() (16002) Get the list of the submatrix links .
ValueMatrix	getValueMatrix() (16003) Get the value matrix of a measurement.
ValueMatrix	getValueMatrixInMode(ValueMatrixMode vmMode) (16005) Get the value matrix of a measurement in the requested mode.
void	removeSMatLink(SMatLink smLink) (16004) Remove a submatrix link.

Methods inherited from interface org.asam.ods.InstanceElementOperations

addInstanceAttribute, compare, createRelatedInstances, createRelation, deepCopy, destroy, getApplicationElement, getAsamPath, getId, getInitialRights, getName, getRelatedInstances, getRelatedInstancesByRelationship, getRights, getValue, getValueByBaseName, getValueInUnit, getValueSeq, listAttributes, listRelatedInstances, listRelatedInstancesByRelationship, removeInstanceAttribute, removeRelation, renameInstanceAttribute, setInitialRights, setName, setRights, setValue, setValueSeq, shallowCopy, upcastMeasurement, upcastODSFile, upcastSubMatrix

Method Detail

createSMatLink

SMatLink createSMatLink()
                        throws AoException

(16001) Create a submatrix link. The submatrix link is only valid in the current session. When the session is closed the submatrix link will be destroyed.

Returns:

The new submatrix 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

getSMatLinks

SMatLink[] getSMatLinks()
                        throws AoException

(16002) Get the list of the submatrix links .

Returns:

The available submatrix links.

Throws:

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

getValueMatrix

ValueMatrix getValueMatrix()
                           throws AoException

(16003) Get the value matrix of a measurement. By calling this method, the value matrix mode of the returned value matrix will be taken from the context variable 'VALUEMATRIX_MODE'. For more information especially on different modes of the value matrix, see description at the method getValueMatrixInMode() of this interface.

Returns:

The value matrix.

Throws:

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

removeSMatLink

void removeSMatLink(SMatLink smLink)
                    throws AoException

(16004) Remove a submatrix link.

Parameters:

smLink - The sub matrix link to be removed.

Throws:

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

getValueMatrixInMode

ValueMatrix getValueMatrixInMode(ValueMatrixMode vmMode)
                                 throws AoException

(16005) Get the value matrix of a measurement in the requested mode. The server checks the independent column. If there is more than one submatrix at the measurement there must be exactly one independent column with the same measurement quantity in each submatrix, otherwise the exception AO_INVALID_VALUEMATRIX_STRUCTURE is thrown. The server throws the exception AO_INVALID_VALUEMATRIX_STRUCTURE when it is unable to create the value matrix due to the data of the measurement - if there are no independent columns - if there are different independent columns - if there are sub matrices with more than one independent local column. The server sorts the values according to the values of the independent localcolumn (in ascending order). It is up to the server what value is returned when a measurement quantity has two different values at the same measurement point. The gaps in the value matrix are marked with appropriate flags in TS_ValueSeq (flagvalue = 0). In the CALCULATED mode the server returns the calculated values for implicit and raw values. The server returns at each measurement point the explicit value as the value for the implicit channels. The raw values are calculated to the explicit values. In the STORAGE mode the server returns the values of the localcolumn as they are in the physical storage. Writing values to a value matrix is only allowed when the value matrix is STROAGE.

Parameters:

vmMode - The requested mode of the value matrix.

Returns:

The value matrix.

Throws:

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