gmxGetPoint

Author: Hiroshisa Mori / joshua@globalbase.org + [Transrate]Reiko Inoue Bendtsen c/o Suzaku Translations / (http://www.suzaku-translations.com/) +

PROTOTYPE

<gmxGetPoint> filename pointdata </gmxGetPoint>

ARGUMENTS

filename [1] XLT_STRING [UNDEF REF (XLT_STRING)]

pointdata [1] XLT_PAIR [UNDEF REF (XLT_PAIR)]

ATTRIBUTES

path-type [arbitrary]: How a filename path is given. absolute/related/network/key default="absolute"

mode [arbitrary]: How a return value is given. normal/block default="normal"

EVALUATION TYPE

applicative

AGENT(S) BELONGS

gbmx

ENVIRONMENT BELONGS

Env1,Env0

EXPLANATION

This function acquires data of coordinate positions, pointdata , from the matrix file filename . If the channel type is vector data, the return value varies depending on how the mode attribute is given. If mode="normal," the value of dim_code corresponding to the vector is returned. If mode="block," the vector data itself is returned. Note that if the channel type is not vector data, mode must be set to "block."

filename can be given as abosolute path or relative path from the root of the xl server. If you specify the attribute path-type="absolute," an absolute path is specified and if you specify path-type="related," a relative path is specified. Note that the method of specifying absolute path cannot be used without access right to Env1 ( XL administrator priviledge).

The data format of pointdata is a list of XLT_INTEGER [UNDEF REF (XLT_INTEGER)]or XLT_FLOAT [UNDEF REF (XLT_FLOAT)]with a length of the dimensions indicated by filename plus 1,if only one point is given. One element is added because one integer value that gives the access level is placed at the head. If two or more points are added, multiple lists indicating coordinate values shall be specified.

[UP] Go To Page Top

RETURN VALUE

If no errors occur, an S formula that lists ( channel number [ XLT_INTEGER [UNDEF REF (XLT_INTEGER)]] coordinate position data) for the number of channels is returned. The coordinate position data takes the value of the corresponding type depending on channel data type, either XLT_INTEGER [UNDEF REF (XLT_INTEGER)]or XLT_FLOAT [UNDEF REF (XLT_FLOAT)]. If mode="block," it takes the value of the corresponding type.

ERRORS

XLE_PROTO_INV_PARAM [UNDEF REF (XLE_PROTO_INV_PARAM)]
1. "param"
  The format of pointdata is illegal.
2. "attribute::mode"
  The value of the mode attribute is not supported.
3. "attribute:path-type"
  The value of path-type is not supported.
XLE_PROTO_INV_OBJECT [UNDEF REF (XLE_PROTO_INV_OBJECT)]
No pixels exist for the coordinate position given by pointdata.
Connection is not allowed as a result of authentication.
XLE_PROTO_OPEN_FILE [UNDEF REF (XLE_PROTO_OPEN_FILE)]
Unable to open the file specified by filename.
XLE_SEMANTICS_TYPE_MISSMATCH [UNDEF REF (XLE_SEMANTICS_TYPE_MISSMATCH)]
The data types of pointdata and filename do not match.
XLE_PROTO_PERMISSION_DENIED [UNDEF REF (XLE_PROTO_PERMISSION_DENIED)]
It was attempted to execute path-type="absolute" in the Env0 environment.

REFERENCE

BUGS

[UP] Go To Page Top