vovprop

Get, set, delete, and show properties on objects.


vovprop: Usage Message
  
  USAGE:
      % vovprop SET [-text] objectIdList propName propValue
      % vovprop GET [-default DEFAULT_VALUE_IF_PROP_MISSING] objectId propName
      % vovprop DELETE objectId propName
      % vovprop SHOW objectId [-namepat regexp] [-nameonly]
      % vovprop SHOW [-namepat regexp] [-nameonly] id1 [id2 ... idN]
  
      The action (GET, SET, DELETE, DEL, SHOW, LIST) is case-insensitive.
      LIST and SHOW are equivalent.
  
  OPTIONS FOR GET:
      -default V        -- Specify a default value in case objectId
                           or property is missing.
  
  OPTIONS FOR SET:
      -integer          -- Specify that property is of type integer.
      -text             -- Specify that property is of type string.
      -auto             -- Determine type automatically (default).
      -sticky           -- The property is sticky (default).
      -nosticky         -- The property is not sticky.
      -asynch           -- Do not wait for reply from server.
      -synch            -- Wait for reply from server (default).
      -elements         -- If setting a property on a set, do so for the
                           elements contained in the set instead of the
                           set itself.
      -noelements       -- If setting a property on a set, do so on the set
                           itself (default).
  
  OPTIONS FOR SHOW,LIST:
      -namepat R        -- Show only properties where name matches regexp R
      -nameonly         -- Show only name, and omit value
  
  OTHER OPTIONS:
      -v                -- Increase verbosity.
      -h                -- Print this help.
  
  EXAMPLES:
      % vovprop SET -text 1 "ABC" "xyz"
      % vovprop SET -text 1 "NUM" 1234
      % vovprop GET 000123456 ABC
      % vovprop GET -default "" 000123456 ABC
      % vovprop DEL 000123456 ABC
      % vovprop SHOW 000123456
  
  NOTES:
      A property of a job that is not 'sticky' will be forgotten
      if the job is re-run successfully.
  

Usage

% vovprop SET [-text] objectIdList propName propValue
% vovprop GET [-default DEFAULT_VALUE_IF_PROP_MISSING] objectId propName
% vovprop DELETE objectId propName
% vovprop SHOW objectId [-namepat regexp] [-nameonly]
% vovprop SHOW [-namepat regexp] [-nameonly] id1 [id2 ... idN]

The action (GET, SET, DELETE, DEL, SHOW, LIST) is case-insensitive. LIST and SHOW are equivalent.

GET Options

- default V
Specify a default value in case objectId or property is missing.

SET Options

-integer
Specify that property is of type integer.
-text
Specify that property is of type string.
-auto
Determine the type automatically.
-sticky
The property is sticky (default).
-nosticky
The property is not sticky.
-asynch
Do not wait for reply from server.
-synch
Wait for reply from server (default).
-elements
If setting a property on a set, do so for the elements contained in the set instead of the set itself.
-noelements
If setting a property on a set, do so on the set itself (default).

SHOW, LIST Options

-namepat R
Show only properties where name matches regexp R
-nameonly
Show only name, and omit value

Other Options

-v
Increase verbosity.
-h
Print the help.

Examples

% vovprop SET -text 1 "ABC" "xyz"
% vovprop SET -text 1 "NUM" 1234
% vovprop GET 000123456 ABC
% vovprop GET -default "" 000123456 ABC
% vovprop DEL 000123456 ABC
% vovprop SHOW 000123456

Comments

A property of a job that is not 'sticky' will be forgotten if the job is re-run successfully.

Properties can also be managed using the Tcl API's vtk_prop_get and vtk_prop_set. Use vtk_prop_list to get a list of the names of the properties attached to an object.