vtk_node

vtk_node_barrierinvalid_get

Obsolete

Usage:         
vtk_node_barrierinvalid_get nodeId

Description:
(Obsolete) This procedure is redundant with vtk_node_get, which also returns 
the value of the barrierInvalid flag, in addition to many other values.

Returns:       
The value of the barrierInvalid flag on the node.

vtk_node_cache

Usage:         
vtk_node_cache [OPTIONS] nodeId setId

Description:   
Cache a node, given its id, and add it to a specified nodeset. 
The procedure fails if an illegal nodeId or setId are passed. 


Options: 
-neighbors Get the node and its neighbors also. 
            

Examples: 
vtk_node_cache 35173 24123 
vtk_node_cache -neighbors 35173 24123


vtk_node_change_status

Usage:         
vtk_node_change_status nodeId newNodeStatus  FLAG  WHY_REASON

Description:   
This procedure changes the status of a node and its children. The argument FLAG is one of:

* THIS_NODE_ONLY - changes only the specified node
* ALL_CHILDREN -  changes status of all the children 
* NODE_AND_CHILDREN -  changes the status of the node and all children
* AUTOMATIC - the status propagation depends on the status: 
	if status is VALID, only the given node is affected (THIS_NODE_ONLY), 
	if status is INVALID, all nodes are affected (NODE_AND_CHILDREN). 
                
The _FORCE string can be appended to the flags to force status changing for Running and Retracing jobs. 
              
The WHY_REASON is shown in the GUI or other text output that shows why a job has a given status 
              
Examples:
vtk_node_change_status 12345 SLEEPING AUTOMATIC "manual invalidation"
vtk_node_change_status 12345 INVALID NODE_AND_CHILDREN "custom script changed status"

Returns:       
Nothing

vtk_node_connectivity

Usage:         
vtk_node_connectivity nodeId

Description:   
Determine the connectivity of a node. 

Example:
vtk_node_connectivity 12345 
ISOLATED

Returns:       
One of ISOLATED INPUT OUTPUT or USED.

vtk_node_forget

Usage:         
vtk_node_forget nodeId

Description:   
Forget the given node. If the node is a job, you must be the owner or ADMIN to be able to forget it. 

Example: 
vtk_node_forget 12345

Returns:       
Nothing

vtk_node_format

Usage:         
vtk_node_format nodeId format

Description:   
This procedure retrieves information about the node based on the format string. 

Example: 
vtk_node_format 12345 {@STATUS@ @LEVEL@} 
VALID 12 

@PROPERTIES@ : Returns a list of data type (S=string, I=integer) followed by the property name. 

Example:
vtk_node_format 12345 @PROPERTIES@ S FORCE_STATUS_CHANGE S GUI_LABEL 

@PROPDUMP@ : Returns A dictionary of property names and property attributes. Each property attribute list 
consists of a dictionary. The dictionary consists of a description/value pairs. 

Example: 
vtk_node_format 12345 @PROPERTIES@ 
FORCE_STATUS_CHANGE { type S value  {set status to VALID by clif} } 
GUI_LABEL { type S value  {shortLabel} }

vtk_node_get

Usage:         
vtk_node_get [-usecache] nodeId [array]

Description:   
Returns information about a node (job or file). If the nodeId doesn't exist, 
an error is returned. With just the nodeId a list of five elements is returned: 
              
* node status 
* BARRIER or NORMAL 
* timestamp 
* FILE | TOOL 
* node name -- NO LONGER MEANINGFUL! 
* node extended status 
              
With the optional array argument, the array is filled with information about the node. 
              
Examples:
With the placeId as unique argument: 

vtk_node_get 1234565 
INVALID NORMAL {Sat Apr  5 09:45:20 2003} TOOL no_name SCHEDULED 

With the optional array argument: 

vtk_node_get 3137 nodeInfo 
nodeInfo(status)         = INVALID 
nodeInfo(type)           = NORMAL 
nodeInfo(timestamp)      = 1025278326 
nodeInfo(objtype)        = TOOL 
nodeInfo(extendedstatus) = SCHEDULED

Returns:       
A list of 6 elements

vtk_node_get_ios

Usage:         
vtk_node_get_ios nodeId formatString

Description:   
This procedure retrieves the inputs and outputs of a node. 

Example (result modified for clarity): 
vtk_node_get_ios 12345 "@ID@ @STATUS@ @STICKY@" 

{
    {04395184 VALID N} {02049739 VALID N} {02049881 VALID S} {02050021 VALID N}
} {
    {02055399 INVALID N}
}


Returns:       
{list of inputs} {list of outputs}

vtk_node_get_sets

Usage:         
vtk_node_get_sets nodeId or setId

Description:   
Get the list of all sets to which the node or set belongs. 

Example: 
vtk_node_get_sets 12345

Returns:       
A list of {id name} pairs for all sets the node or set belongs to.

vtk_node_history

Usage:         
vtk_node_history nodeId FLAGS direction levels

Description:
This procedure returns a formatted string representing a depth-first traversal of the trace starting from the nodeId as specified by direction and levels. Direction is either "FORWARD" or "BACKWARD". FLAGS is a list of one or more of the following tokens: ANNOTATION PLACE TRANSITION NODE.   

Returns:       
A formatted string

vtk_node_impact

Usage:         
vtk_node_impact nodeId [array]

Description:     
This procedure returns a summary of jobs and files in the downcone of the given node. 
With one argument, the procedure returns a formatted string, such as the one shown below. 
This usage is discouraged. With two arguments, the procedure fills the relevant fields in 
the specified array (also shown below in the example). 
                
Examples:
vtk_node_impact 12345 
VALID NODES Files: 22 Tools: 5 Duration:3m15s 
OTHER NODES Files: 21 Tools: 17 Duration:15m21s
----------- 
TOTAL Files: 43 Tools: 22 Duration:18m36s 
vtk_node_impact 4567 a 
parray a 
a(other,duration)   = 181 
a(other,files)      = 10 
a(other,jobs)       = 7 
a(other,unknown)    = 0 
a(valid,duration)   = 1092 
a(valid,files)      = 223 
a(valid,jobs)       = 180 
a(valid,unknown)    = 0

Returns:       
A formatted string or "ok|error"

vtk_node_status_logging

Usage:         
vtk_node_status_logging nodeOrSetId  OPTIONAL_LOGGING_TYPE  -recursive

Description:     
This procedure sets or gets the WHYSTATUS reason logging type for a 
node or a set (applies to all nodes in the set). Within a set, the recursive 
option applies to nodes in subsets recursively. If the ID of System:nodes is provided, 
the change applies to all nodes. This can be used to globally enable or disable status logging. 
If no logging type is provided, the logging type of nodeOrSetId is returned. The log entries are 
recorded in the server journals, not the server log. Getting the value for a set returns a 
summary in the format "UNSET v NONE w ALL x INVALID y DOWNCONE z TOTAL t". If the ID is 0, 
set the trace policy setting which acts as a global on all nodes. The node's value overrides 
it unless UNSET. Logging type is one of:
                
* UNSET; Use the trace policy setting (default UNSET)
* NONE; Disables logging of status changes
* ALL; Enables logging of all status changes
* INVALID; Enables logging of status turning INVALID
* DOWNCONE; Enables logging of INVALID status propagating to downcone nodes
                
Examples: (12345 is a job or file ID, 678 is a set ID) 
vtk_node_status_logging 12345
vtk_node_status_logging 12345 ALL
vtk_node_status_logging 678 
vtk_node_status_logging 678 -recursive
vtk_node_status_logging 678 DOWNCONE
vtk_node_status_logging 678 NONE -recursive
vtk_node_status_logging [vtk_set_find System:nodes] NONE
vtk_node_status_logging 0 ALL
vtk_node_status_logging 0 NONE 

Returns:       
If getting value, the logging type of the node. If setting value, the number of nodes that changed logging type

vtk_node_why

Usage:         
vtk_node_why nodeId maxReasons

Description:   
This procedure retrieves the reasons for the status of the specified node. The argument 
maxReasons is silently limited in the range [1,100]. 
              
Example:
vtk_node_why 12345 4 
clevercopy -m 644 ./OBJ/FTaux/FTaux.pdf ./../../../../bui... 
is INVALID 
Invalid input: 02049603 ${BUILD_TOP}/flowtracer/src/html/FTaux.pdf 
1. (FILE) ${BUILD_TOP}/flowtracer/src/traceui/vtknode.cc 
is younger by 2m13s 
NodeId=00003475

Returns:       
A formatted string.