gmxCreate:gmxChannelInfo

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

PROTOTYPE

<gmxChannelInfo/> <gmxChannelInfo> initialize_data <gmxChannelInfo>

ARGUMENTS

gmxCreate

gmxCreate/ gmxMatrixParam

gmxCreate/gmxMatrixParam/ gmxPriority

gmxCreate/ gmxMatrixDimDivide

gmxCreate/ gmxMatrixBlockSize

gmxCreate/ gmxMatrixPixelSize

gmxCreate/ gmxChannelInfo

gmxCreate/ gmxPhase

ATTRIBUTES

channel [mandatory] Integer: Target channel number

type [mandatory] Character string: Data type of a channel

send [arbitrary] Character string: Turns on the on/off MF_SEND flag. The default is "off."

file [arbitrary] Character string: Turns on the on/off MF_SFILE flag. The default is "off."

visu [arbitrary] Character string: Turns on the on/off MF_VISU flag. The default is "off."

send_file [arbitrary] Character string: Turns on the on/off MF_SEND_FILE flag. The default is "off."

send_visu [arbitrary] Character string: Turns on the on/off MF_SEND_VISU flag. The default is "off."

EVALUATION TYPE

applicative

AGENT(S) BELONGS

gbmx

ENVIRONMENT BELONGS

Env1/gmxCreate

EXPLANATION

This function specifies information of each channel of the matrix to be generated. The attributes specify data type and flags. The list of data types that can be set is shown below.

Basic data types
- bit - Bit type
- int8 - 8-bitsigned integer type
- int16 - 16-bitsigned integer type
- int32 - 32-bitsigned integer type
- int64 - 64-bitsigned integer type
- uint8 - 8-bitunsigned integer type
- uint16 - 16-bitunsigned integer type
- uint32 - 32-bitunsigned integer type
- uint64 - 64-bitunsigned integer type
- float - Floating point type
- double - Double-precision floating point type
- string - Character string type
- block - Block type
- sexp - XL S formula type
- rgb8 - 8-bitRGB type
Vector types
- int8_v - 8-bitsigned integer type
- int16_v - 16-bitsigned integer type
- int32_v - 32-bitsigned integer type
- int64_v - 64-bitsigned integer type
- uint8_v - 8-bitunsigned integer type
- uint16_v - 16-bitunsigned integer type
- uint32_v - 32-bitunsigned integer type
- uint64_v - 64-bitunsigned integer type
- float_v - Floating point type
- double_v - Double-precision gloating point type
- string_v - Character string type
- rgb8_v - 8-bitRGB type

The gmxChannelInfo function is able to specify the initial data corresponding to the data types above as internal elements. Integer type and floating point type data is converted to the relevant types above and initialized. If no internal elements are given, data is not initialized.

[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)]
- "channel"
  The channel attribute is not specified.
- "type"
  The type attribute is not specified.
- "invalid type ( type)"
  The value of the type attribute is invalid.
XLE_PROTO_UNSUTISFIED_INFO [UNDEF REF (XLE_PROTO_UNSUTISFIED_INFO)]
set_matrix_channel_info caused an error. The number indicates an error code.
XLE_SEMANTICS_TYPE_MISSMATCH [UNDEF REF (XLE_SEMANTICS_TYPE_MISSMATCH)]
The data type given by the type attribute and the value type given during initialization do not match.

REFERENCE

BUGS

[UP] Go To Page Top