Documentation:Reference:TDI GH - MdsWiki
Navigation
Personal tools

From MdsWiki

Jump to: navigation, search

GE (X,Y)

Logical Elemental. Tests for first greater than or equal to second.
Usual Forms X >= Y, X GE Y.
Function Form GE(X,Y).

Arguments X and Y must both be numeric or character.
Complex numbers are an error.

Signals. Single signal or smaller data.
Units... None unless both have units and they don't match.
Form.... Logical of compatible shape.
Result.. True if X is greater than or equal to Y; otherwise,
false. A reserved operand is always false. Character are
compared in the processor collating sequence.
>>>>>>>>>WARNING, floating point operations may not match an exact
calculation for nonterminating binary fractions. You
cannot predict that .1+.1>=.2 is true. Integer values
may be truncated when matched to floating numbers.

Example. 2>=2.0 is $TRUE.

GETDBI (STRING,[INDEX])

MDS Operation. Get database information.
Arguments Optional: INDEX.
STRING character scalar. The string may be
abbreviated in upper or lower case to any unique form.

Logical OPEN_FOR_EDIT modifiable
MODIFIED changes made
Long SHOTID shot number
NUMBER_OPENED database pointers active
MAX_OPEN database pointers allowed
Character NAME experiment name
DEFAULT default/current node
INDEX integer scalar less than MAX_OPEN value.
Determines which tree location is reported.
The default value of 0 is the current tree.

Result.. Depends on the experiment, shot number, and history.

See also. $DEFAULT, $EXPT, $SHOT, and $SHOTNAME constants.

GETNCI ([NODE],STRING,[USAGE])

MDS Operation. Get node characteristic information about tree elements.

Arguments Optional: NODE and USAGE.
NODE a NID or long node identifier or a PATH or character
form of the path of a tree element--child or member, or
a wildcarded path. May be an array.
Default is current position in tree.
>>>>>>>>>WARNING, path names are case-sensitive.
STRING character scalar. The string may be abbreviate in upper
or lower case to any unique form. Case-insensitive.
USAGE character scalar or vector. This limits the search of
NODE names. It must be a valid usage name like "ALL",
"ANY", or "TEXT".

The STRING names by returned type follow.

Byte unsigned CLASS storage classification
DTYPE storage data type
USAGE allowed data type
Character FULLPATH path from top of tree
MINPATH shortest relative path
NODE_NAME last part of pathname
ORIGINAL_PART_NAME Original node name in device
PATH path from top or tag
Logicals COMPRESSIBLE has arrays
COMPRESS_ON_PUT use comprssion on put
DO_NOT_COMPRESS no compression allowed
ESSENTIAL node is essential
IS_CHILD parent relationship
IS_MEMBER parent relationship
NID_REFERENCE contains nid references
NO_WRITE_MODEL write to model disabled
NO_WRITE_SHOT write to shot disabled
PARENT_STATE parent on or off
PATH_REFERENCE contains path references
SETUP_INFORMATION has setup operations
STATE on or off
USAGE_ACTION allows only action
USAGE_ANY allows any data
USAGE_AXIS allows only axis
USAGE_COMPOUND_DATA allows only compound_data
USAGE_DEVICE allows only conglomerate
USAGE_DISPATCH allows only dispatch
USAGE_NUMERIC allows VMS data
USAGE_SIGNAL allows only signal
USAGE_STRUCTURE allows no data, was NONE
USAGE_SUBTREE allows only subtree
USAGE_TASK allows only task
USAGE_TEXT allows only text
USAGE_WINDOW allows only window
WRITE_ONCE change only once
Long DEPTH tree parents above
LENGTH data size
NID_NUMBER tree logical offset
NUMBER_OF_CHILDREN number of child nodes
NUMBER_OF_MEMBERS number of member nodes
PARENT_RELATIONSHIP child or member
Long unsigned GET_FLAGS bit flags
OWNER_ID rights identifier
STATUS status
NID BROTHER next child or member
CHILD first child
MEMBER first member
PARENT the one above in tree
NID arrays CHILDREN_NIDS list of children
CONGLOMERATE_NIDS
MEMBER_NIDS list of members
Quadword unsigned TIME_INSERTED VMS date and time
Word unsigned CONGLOMERATE_ELT number of elements
Node data RECORD actual data


Signals. None, except for RECORD.
Units... None, except for RECORD.
Form.... VECTOR concatenation of all elements found for the list
of NIDs and PATHs. Scalar for non-array results of
single input. All data types are the same for one
request except possibly for RECORD. Character names vary
in length except for NODE_NAME, which has length 12.

Result.. A scalar or simple vector list of results. RECORD may
not be able to VECTOR the results of a list of
NIDs/PATHs. Logicals allow easy testing of bit or value.
>>>>>>>>>WARNING, only GETNCI can handle arrays of NIDs/PATHs.
>>>>>>>>>WARNING, a NID/PATH result used in an expression will have its
data taken--just as if the node name had been used.
Thus GETNCI(\TOP.XRAY,"MEMBER")//" Z" might be
"Xray diagnostic Z" if the first member were the
description.

Example. GETNCI(\TOP.XRAY,"PARENT") is \TOP as is
GETNCI("\TOP.XRAY","par").

GOTO (NAME)

CC Statement. Branch to label.
Usual Form GOTO NAME;.
Function Form GOTO(NAME). Decompiles to usual form.

Argument. NAME must be character with name of a label in the
local code.

Result.. None.

Example. IF (_X[2]) GOTO _MYLABEL;
...
LABEL _MYLABEL : ... .

GT (X,Y)

Logical Elemental. Tests for first greater or equal to second.
Usual Forms X > Y, X GT Y.
Function Form GT(X,Y).

Arguments X and Y must both be numeric or character.
Complex numbers are an error.

Signals. Single signal or smaller data.
Units... None unless both have units and they don't match.
Form.... Logical of compatible shape.

Result.. True if X is greater than Y; otherwise, false. A
reserved operand is always false. Character are compared
in the processor collating sequence.
>>>>>>>>>WARNING, floating point operations may not match an exact
calculation for nonterminating binary fractions. You
cannot predict that .1+.1>=.2 is true. Integer values
may be truncated when matched to floating numbers.

Example. 2>2.0 is $FALSE.

G_COMPLEX (X,[Y])

Conversion Elemental. Convert to G-precision floating complex.

Arguments Optional: Y.
X numeric.
Y numeric. Default is zero.

Signals. Single signal or smaller data.
Units... Single or common units, else bad.
Form.... G-precision complex of compatible shape.

Result.. If Y is absent and X is complex, the AIMAG(X) is Y.
If X and Y are present, the real parts of each are used.
Immediate at compilation.
>>>>>>>>>WARNING, truncation does not cause an error.

Example. G_COMPLEX(3,4.1) is CMPLX(3.0G0,4.1G0), approximately.

G_FLOAT (A)

Conversion Elemental. Convert to G-precision floating real.

Argument. A must be numeric.

Signals. Same as A.
Units... Same as A.
Form.... G-precision real of same shape.

Result.. Integers, reals and the real part of complex numbers are
converted to G-precision reals.
Immediate at compilation.
>>>>>>>>>WARNING, truncation does not cause an error.

Example. G_FLOAT(12), G_FLOAT(12.) G_FLOAT(12H0) are 12.0G0,
approximately.

HELP_OF (A)

MDS Operation. Get the help field.

Argument. Descriptor as below.

Result.. A is searched for this:
DSC$K_DTYPE_PARAM, the help field, textual information.
Otherwise, an error.

Example. HELP_OF(BUILD_PARAM(42,"the answer",$VALUE>6)) is
"the answer".
See also. $VALUE and $THIS for use of this within a parameter.

HUGE (X)

F90 Inquiry. The largest number in the model representing numbers of
the same type as the argument.

Argument. X must be numeric scalar or array.

Signals. Same as X.
Units... Same as X.
Form.... Scalar of same type as real part of X.
Result.. The result is r^q - 1 if X is integer and
(1-(b^-p))b^emax if X is real, where r is the integer
base, q is the number of digits, b is the real base, p
is the number of digits, emax is the maximum exponent in
model numbers like X.

Examples. HUGE(1.0) is (1-(2^-24))*2^127 and
HUGE(0) is 2^31-1 on the VAX.

H_COMPLEX (X,[Y])

Conversion Elemental. Convert to H-precision floating complex.

Arguments Optional: Y.
X numeric.
Y numeric. Default is zero.

Signals. Single signal or smaller data.
Units... Single or common units, else bad.
Form.... H-precision complex of compatible shape.

Result.. If Y is absent and X is complex, the AIMAG(X) is Y.
If X and Y are present, the real parts of each are used.
Immediate at compilation.

Example. H_COMPLEX(3,4.1) is CMPLX(3.0H0,4.1H0), approximately.

H_FLOAT (A)

Conversion Elemental. Convert to H-precision floating real.

Argument. A must be numeric.

Signals. Same as A.
Units... Same as A.
Form.... H-precision real of same shape.

Result.. Integers, reals and the real part of complex numbers are
converted to H-precision reals.
Immediate at compilation.

Example. H_FLOAT(12), H_FLOAT(12.) H_FLOAT(12H0) are 12.0H0,
approximately.