gmxCreate:gmxPhase

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

PROTOTYPE

<gmxPhase> Phase_commands .... <gmxPhase> <gmxPhase/>

ARGUMENTS

gmxCreate

gmxCreate/ gmxMatrixParam

gmxCreate/gmxMatrixParam/ gmxPriority

gmxCreate/ gmxMatrixDimDivide

gmxCreate/ gmxMatrixBlockSize

gmxCreate/ gmxMatrixPixelSize

gmxCreate/ gmxChannelInfo

gmxCreate/ gmxPhase

ATTRIBUTES

area [mandatory] Integer: Phase area to be set.

type [arbitrary] Character string: Specification of normal/direct/equ Phase_commands; the default is "normal."

equ [arbitrary] Integer: Target phase area of equivalent

mode [arbitrary] Character string: active/direct/server/client mode; the default is "active."

EVALUATION TYPE

normal

AGENT(S) BELONGS

gbmx

ENVIRONMENT BELONGS

Env1/gmxCreate

EXPLANATION

This function specifies the phase script of the matrix to be generated.

This function specifies the mode to be set for the attribute mode. This function specifies the phase area code to be set for the attribute area.

The attribute type can take the values normal or direct, which is the same value as the type attribute of the quote function, as well as equ. If normal is specified, an evaluated $ element is set as the phase command in the same way as for interpretation of the normal attribute of the quote function. On the other hand, if direct is specified, $ elements are not evaluated. If equ is specified, the same phase command as the area code given by the equ attribute is set for the script.

[UP] Go To Page Top

RETURN VALUE

XLT_NULL [UNDEF REF (XLT_NULL)]or error

ERRORS

XLE_SEMANTICS_INV_FORMAT [UNDEF REF (XLE_SEMANTICS_INV_FORMAT)]
The corresponding element was used outside gmxCreate.
XLE_PROTO_INV_PARAM [UNDEF REF (XLE_PROTO_INV_PARAM)]
- "area"
  The area attribute is not specified.
- "equ"
  The equ attribute is not specified, although the type is set to "equ."
XLE_PROTO_UNSUTISFIED_INFO [UNDEF REF (XLE_PROTO_UNSUTISFIED_INFO)]
set_matrix_cal caused an error. The number indicates an error code.

REFERENCE

BUGS

[UP] Go To Page Top