Documentation:Reference:TCL 3 - MdsWiki
Navigation
Personal tools

From MdsWiki

Jump to: navigation, search

SAVE

Save a macro definition in a macro library.
Format: SAVE macro-name [/LIBRARY=file_spec]
Parameters
macro-name
The name of a command macro. The string can contain from 1 to 32 characters.
qualifiers
/LIBRARY
The library into which the macro is to be inserted. If omitted the default library specified in a SET LIBRARY command is used. The library must be created via a CREATE LIBRARY (or using the VMS Librarian) command before macros can be saved.

SET

Format: SET option
SET CURRENT
Sets the "current" shot number for an experiment.
Format:
SET CURRENT experiment shotnumber
or
SET CURRENT /INCREMENT
SET DEFAULT
Moves the current default position in the tree.
Format:
SET DEFAULT node_name
The PINO system maintains a current default position in the tree. In all commands which take a node_name as a parameter (including this one) the node_name is a tree path relative to the current default path. This command changes the current default. Much like the SET DEFAULT command in DCL.
PARAMETERS:
node_name - a node or path name specifying a node in the tree. see help specify node_name for details.
EXAMPLES
After issuing the command:
TCL> SET DEFAULT \TOP.TIMING.SUB1
an ADD NODE command would create a node under TOP.TIMING.SUB1
TCL> ADD NODE MY_TIME
would create the node \TOP.TIMING.SUB1.MY_TIME
SET NODE
The SET NODE command is used to change some characteristics of a node.
Format:
SET NODE node_name qualifiers
Node name may contain wildcard characters.
QUALIFIERS
/SUBTREE
Format: SET NODE node_name /SUBTREE
This command will make the node specified by node_name into a SUBTREE reference. When this tree is opened (with SET TREE) a SUBTREE will be opened for the node specified.
NOTES: The node specified must not have any children. The tree must be open for edit.
/NOSUBTREE
Format: SET NODE node_name /NOSUBTREE
This command will turn the node specified by node_name into an ordinary node if was a subtree reference. If the node was not a subtree reference then this command will do nothing.
NOTE: The tree must be open for edit.
/ON
Sets the state of this node to ON. Node will become active if/when all if the nodes parents are also on.
/OFF
Sets the state of this node to OFF. This node and all its descendants will become inactive.
/WRITE_ONCE
Sets the write once characteristic of this node. If node is write once, data can be loaded into the node only once. No updates are permitted. Use the /NOWRITE_ONCE qualifier to remove this restriction.
/COMPRESS_ON_PUT
Sets the compress on put characteristic of this node. If node is set compress on put, MDS will automatically compress the data whenever it is written to the tree.
/DO_NOT_COMPRESS
Sets the do not compress characteristic of this node. Specifies that the node should not be compressed during datafile compression.
/ESSENTIAL
Marks the node as essential.
/SHOT_WRITE
Specifies that data should only be written to this node in the pulse file, not in the model.
/MODEL_WRITE
Specifies that data should only be written to this node in the model file, not in a pulse file.
/INCLUDED
Specifies that the SUBTREE should be included in
CREATE PULSE /CONDITIONAL
commands.
PARAMETERS
node_name - a node or path name specifying a node in the tree. see help specify node_name for details.
SET TREE
This command opens the tree specified for read access.
Format:
SET TREE file_name [/shot=shot_number]
This command will open the tree 'file_name'. All subtrees: (and their subtrees...) will be opened.
QUALIFIERS
/SHOT=shot_number
Specifies the shot number of the tree to open. Default = -1 which is the model.
/READONLY
Opens the tree for readonly access.
SET COMMAND
Changes your current command table to that of another MDSDCL utility.
Format: SET COMMAND [file-spec]
Parameters
[file-spec]
Specifies the name of a MDS command definition file. (I.E. ADS$COMMANDS or CCL$COMMANDS)
Command_Qualifiers
/DEF_FILE=def_file_spec
This qualifier permits you to change the default file specification used in invoking indirect commands.
/HELPLIB=file_spec
Change the help library used when using the HELP command
/PROMPT=string
Enables you to have MDS use a different prompt string.
Format: SET COMMAND/PROMPT=string file_spec
Specifies the string to replace the default MDS prompt:string. The:string:can consist of more than one character. All valid ASCII characters can be used in the string.
In order to include spaces or lowercase letters in your string, you must enclose the string in quotation marks. Otherwise, letters are automatically converted to uppercase, and leading and trailing spaces are removed.
examples
1. > SET COMMAND/PROMPT="PCL> "/HELPLIB=PCLHELP/DEF_FILE="*.PCL" PCL$COMMANDS
PCL> DRAW/AX FOO BAR
This command will change the command interpreter to accept PCL commands. The prompt has been changed to PCL> and the HELP command will obtain help on PCL commands. An indirect command that doesn't specify a file type will cause the command interpreter to look for the file with type .PCL .
SET KEY (VMS ONLY)
Changes the current key definition state. Keys are defined by the DEFINE/KEY command.
Format: SET KEY
Command_Qualifiers
/APPLICATION
Sets the keypad keys 0-9 and period,hyphen and comma to act as definable function keys. see /NUMERIC
/LOG
/NOLOG
Controls whether the system displays a message indicating that the key state has been set. The default is /LOG.
/NUMERIC
Sets the keypad keys 0-9 and period,hyphen and comma to not act as function keys but issue their original values of 0-9,period,hyphen and comma respectively. see /APPLICATION
/STATE=state-name
/NOSTATE
Specifies the state for the system to set. The state name can be any alphanumeric string. If you omit the /STATE qualifier or use /NOSTATE, the current state is left unchanged. The default state is DEFAULT.
SET INTERRUPT (VMS ONLY)
SET [NO]INTERRUPT
This command will place the interpreter in the interrupt mode. In this mode any input from the keyboard will interrupt any commands that are currently being executed. Control will return to prompting and the input will be accepted as commands. Hitting a defined function key will also interrupt activity. If interrupt mode is disabled (the default) any keyboard input will be placed in the type-ahead buffer and read in when normal prompting resumes.
SET LIBRARY (VMS ONLY)
Format:
SET LIBRARY file_spec
SET LIBRARY/CLOSE
parameters
file-spec
The file specification of the library you want to use. If the file type is omitted the type .TLB is used.
qualifiers:
/CLOSE
The close qualifier will close the current default library. If the close qualifier is present no file-spec is allowed.
SET PROMPT
Enables you to have MDS use a different prompt string.
Format: SET PROMPT=string
parameters
string
Specifies the string to replace the default MDS prompt:string----"$". The string can consist of more than one character. All valid ASCII characters can be used in the string.
In order to include spaces or lowercase letters in your string, you must enclose the string in quotation marks. Otherwise, letters are automatically converted to uppercase, and leading and trailing spaces are removed.
Examples
1. PCL> SET PROMPT="FOO --->"
FOO ---> DRAW/AX BAR FOO
The PCL> prompt is replaced with the string "FOO:--->:". When you see the prompt on your screen, you can enter any valid command. This example uses the DRAW/AX BAR FOO command.
SET VERIFY
Controls whether command lines and data lines in command procedures are either displayed at the terminal or printed in a batch job log. The information displayed by the SET VERIFY command can help you in debugging command procedures.
Format: SET [NO]VERIFY
SET VERSION (NO VMS, Requires version 1.8-2 or greater)
Controls whether nodes in the tree will retain older versions of data if overwritten. This command is only valid when the tree is open for edit.
Format: SET VERSION (/MODEL | /NOMODEL | /SHOT | /NOSHOT)
Examples
1. TCL> SET VERSION/SHOT/NOMODEL
Versioning will be enabled for data written into shot files (shot number > 0) but not in the model.
SET VIEW (NO VMS, Requires version 1.8-2 or greater)
Sets reference time for retrieving older versions of data. When a tree has versioning enabled old data records are retained in the datafile. When you change your reference time, you will effectively get a snapshot of the data which was in the tree at that time. The time specifier must be enclosed in double quotes and must be in the format of the dates showing by the DIR/FULL command.
Format: SET VIEW "full-date-time-spec" | "NOW"
Examples
1. TCL> SET VIEW "4-JAN-2007 09:56:35"
All subsequent directories and data access will return results as they would have returned at the date specified.
2. TCL> SET VIEW "NOW"
Clear the reference time. Show the current values of data in the tree.

SETEVENT

Sets an MDSplus event.
Format:
SETEVENT event-name
Example:
setevent saa_h908_01