V

V

File
vovfdl.tcl
Usage
V listOfTests
Description
V stands for verify. The input parameter listOfTests is a space-separated list of tests to be performed by the program CheckTest. See the documentation for CheckTest for more information on the syntax of these tests.
For test, i.e. for each element in the input list, this procedure adds an annotation whose text is TEST=$test, to the most recently defined transition, stored in make(transId).
Side Effects
All annotations with text beginning with TEST= are replaced.

ves

File
vovenvutils.tcl
Usage
ves environment
Description
Similar to the shell alias to switch environment.

VFmakeProperSetname

File
vovfdl.tcl
Usage
VFmakeProperSetname setname

VncFmtTaskerReservation

File
vovutils.tcl
Usage
VncFmtTaskerReservation taskername

VncGetNcConfigDir

File
vovutils.tcl
Usage
VncGetNcConfigDir

VncJobClassSearchPath

File
vovutils.tcl
Usage
VncJobClassSearchPath
Description
Modeled on vovenv_dirs; in vovutils so accesible to vovresourced
Uses the variable env(VOV_JOBCLASS_DIRS). On UNIX, this is a colon separated list of directories. On Windows, the separator is semicolon.
Returns
List of directories in which jobclass files can be found. First, dirs named by env(VOV_JOBCLASS_DIRS), then $VOVDIR/local/jobclass and finally $VOVDIR/etc/jobclass.

VncSourcePolicyFiles

File
vovutils.tcl
Usage
VncSourcePolicyFiles
Description
Now source the project or site-specific policy files.

VncSourceQueueConfigFile

File
vovutils.tcl
Usage
VncSourceQueueConfigFile qnameOrSetupFile quiet (default=0)
Description
Set the values of VOV_HOST_NAME and VOV_PROJECT_NAME to locate the Accelerator server, and open the trace.

vov_gcd

File
vov_common.tcl
Usage
vov_gcd u v

vov_getImage

File
vov_common.tcl
Usage
vov_getImage imageName

vov_getImageCopy

File
vov_common.tcl
Usage
vov_getImageCopy imgName

vov_makeImage

File
vov_common.tcl
Usage
vov_makeImage imageName

vov_resizeImage

File
vov_common.tcl
Usage
vov_resizeImage img num denom background_color (default=)

vov_ssd_uniq_port

File
vov_un2id.tcl
Usage
vov_ssd_uniq_port user (default=)

vov_un2id

File
vov_un2id.tcl
Usage
vov_un2id s max (default=0xffff) min (default=0)
Description
Convert a string to a positive integer within the specified range (default 0 - 0xffff)

vov_update

File
vov_common.tcl
Usage
vov_update why idle (default=0)

vov_update_idle

File
vov_common.tcl
Usage
vov_update why idle

vov_update_idletasks

File
vov_common.tcl
Usage
vov_update_idletasks why

vovAddPhantomInputs

File
vovphantom.tcl
Usage
vovAddPhantomInputs jobId searchPath n (default=1)
Description
This procedure adds PHANTOM inputs to a job, based on a search path. The third parameter is the number of components in the path that are to be used as tail.

VovBarrierClose

File
vovutils.tcl
Usage
VovBarrierClose fp

VovBarrierOpen

File
vovutils.tcl
Usage
VovBarrierOpen file mode (default=664)

VovChmod

File
vovutils.tcl
Usage
VovChmod pathName newPermissions

vovClientInit

File
vov_boot.tcl
Usage
vovClientInit flag
Description
Initialize the TCL interface. The argument flag is passed to vtk_init and can be one of "tcl" "tk" "tix" "all".
Returns
Either "ok" or raises an error if initialization fails.
Side Effects
calls {\tt vovEnableTk}

VovCompareTimeSpec

File
vovutils.tcl
Usage
VovCompareTimeSpec t1 t2

vovConflictControl

File
vov_messages.tcl
Usage
vovConflictControl
Description
Check the value of the VOV_CONFLICT_CONTROL. If it is ABORT or CONTINUE, return its value. If it has another value, print a warning and return ABORT. If it is not set, return the empty string. For backward compatibility, check also VOV_FAIL_ON_CONFLICT: if it is set, return ABORT.

vovCreateLogDirUltraSafe

File
vovenvutils.tcl
Usage
vovCreateLogDirUltraSafe logdir args
Description
This one is hard to test. At Samsung, the file mkdir $dir command fails with the error "Can't create directory: file already exists" So, if we get that error, we just try again, slowly.

VovDaemon::checkConfigFile

File
vovdaemonlib.tcl
Usage
VovDaemon::checkConfigFile daemonName

VovDaemon::checkInfoFile

File
vovdaemonlib.tcl
Usage
VovDaemon::checkInfoFile daemon args

VovDaemon::initVariables

File
vovdaemonlib.tcl
Usage
VovDaemon::initVariables daemonName

VovDaemon::loadFile

File
vovdaemonlib.tcl
Usage
VovDaemon::loadFile file

VovDaemonMgrReread

File
vovdaemonlib.tcl
Usage
VovDaemonMgrReread daemon

vovDestroyTopLevel

File
vov_common.tcl
Usage
vovDestroyTopLevel w (default=)
Description
Destroy the top level. If the toplevel is the main application window it will be destroyed and the application will exit.

vovDialog

File
vov_dialog.tcl
Usage
vovDialog title text bitmap default args
Description
This is a minimal modification of the default {\tt dialog} normally distributed with Tk. This procedure displays a dialog box, waits for a button in the dialog to be invoked, then returns the index of the selected button.

VovDiskFullCallback

File
vov_boot.tcl
Usage
VovDiskFullCallback code

vovDroppedAsyncConnectionCallBack

File
vov_boot.tcl
Usage
vovDroppedAsyncConnectionCallBack

VovDumpPreemptionRules

File
vovtraceutils.tcl
Usage
VovDumpPreemptionRules fileName

VovEdition

File
vovutils.tcl
Usage
VovEdition

vovEnableTk

File
vov_boot.tcl
Usage
vovEnableTk
Description
Initialize the part of the Tcl interface that has to do with Tk.
Side Effects
Colors are initialized

vovenv

File
vovenvutils.tcl
Usage
vovenv var separator op args
Description
A utility to manage the environment variables, such as PATH or LM_LICENSE_FILE, whose value is a list of strings separated by a special character.
  • var is the name of the variable,
  • separator is :" in UNIX and ";" in Windows NT or "auto" (recommended) to automatically choose between ";" and ":".
  • op is one of ADD APPEND PREPEND DELETE,
  • The remaining args are the components that must be added or removed from the variable. In all cases, duplicates will be avoided.
Return
The new value of the environment variable.
Side Effects
The value of the variable is modified with setenv.

vovenv_current_env

File
vovenvutils.tcl
Usage
vovenv_current_env
Return
The name of the current environment.
Side Effects
env(VOV_ENV) is set if it is not defined.

vovenv_do_switch

File
vovenvutils.tcl
Usage
vovenv_do_switch new_env_spec
Description
The new environment specification is a list of environment names, each with optional parameters, separated by + and - signs. The optional parameters are shown in parenthesis and are separated by commas.
Examples: E1 E1+E2-E3 +E2-E3 E1(p1,p2)+E2+E3(p1)
If the new environment specification begins with a '+', the environment is added to the current one, else it replaces it.
Return
"success" or "failure"

vovenv_produce_script

File
vovenvutils.tcl
Usage
vovenv_produce_script shelltype file
Description
Produce a script that can be sourced by the shell specified by shelltype The script only contains the variables that have changed.
Return
"success" or "failure"

vovenvCaptureEnvironment

File
vovenvutils.tcl
Usage
vovenvCaptureEnvironment logdir force addToFlow (default=0)
Description
Capture the environment in a file, if necessary.
Return
envfile
Side Effects
Set env(VOV_ENV) -- If we are in a legitimate environment, use it by default. -- Else use an environment file.

vovenvCreateSnapshotPropertyValue

File
vovenvutils.tcl
Usage
vovenvCreateSnapshotPropertyValue

vovenvReadSnapshotPropertyFromObject

File
vovenvutils.tcl
Usage
vovenvReadSnapshotPropertyFromObject objId

vovenvSaveSnapshotPropertyOnObject

File
vovenvutils.tcl
Usage
vovenvSaveSnapshotPropertyOnObject objId

VovError

File
vovutils.tcl
Usage
VovError msg

VovErrorCount

File
vovutils.tcl
Usage
VovErrorCount

VovExit

File
vovutils.tcl
Usage
VovExit status

VovExpandBang

File
vovutils.tcl
Usage
VovExpandBang
Description
The ! ("bang") is expanded as the most recent my job in the current directory.

VovFatalError

File
vovcgi.tcl
Usage
VovFatalError msg args

VovFeedback

File
vovutils.tcl
Usage
VovFeedback msg

vovFindGoodEnvFile

File
vovenvutils.tcl
Usage
vovFindGoodEnvFile envfile

VovForgetIdleLimits

File
vovtraceutils.tcl
Usage
VovForgetIdleLimits minAge (default=0)

vovForgetIsolatedFiles

File
vovtraceutils.tcl
Usage
vovForgetIsolatedFiles verbose (default=1) update (default=1)
Description
Forget all files that are isolated. If verbose is set, print a message for each file that is forgotten. If update is set, the Tk function update is called after each node has been processed. We do not touch isolated nodes that appear to have just been created (the node timestamp is recent).
Return
The number of nodes that have been forgotten.

vovForgetIsolatedNodes

File
vovtraceutils.tcl
Usage
vovForgetIsolatedNodes verbose (default=1) update (default=1)

vovForgetNodesByRule

File
vovtraceutils.tcl
Usage
vovForgetNodesByRule rule
Description
Forget all nodes that match the given rule.
Return
The number of forgotten nodes.

VovForgetOldUnusedLimits

File
vovtraceutils.tcl
Usage
VovForgetOldUnusedLimits thresholdSpec (default=7d)

vovForgetRetracingBlockingNodes

File
vovtraceutils.tcl
Usage
vovForgetRetracingBlockingNodes verbose (default=1) update (default=1)
Description
Forget all files that with status RETRACING and with no inputs
Return
The number of nodes that have been forgotten.

VovGetLocalHostName

File
vovutils.tcl
Usage
VovGetLocalHostName
Description
Returns hostname as vovserver sees it.

VovGetNullDevice

File
vovutils.tcl
Usage
VovGetNullDevice

VovGetNumericPriority

File
vovutils.tcl
Usage
VovGetNumericPriority s

VovGetNumericSecurity

File
vovutils.tcl
Usage
VovGetNumericSecurity s

vovGetPortNumberFromEnv

File
vovutils.tcl
Usage
vovGetPortNumberFromEnv envName defaultValue (default=)
Description
@ args envName
Typically VOV_PORT_NUMBER defaultValue, in case the variable is not defined.

VovGetPrimaryServer

File
vov_common.tcl
Usage
VovGetPrimaryServer

VovGetPrimaryServerUrl

File
vov_common.tcl
Usage
VovGetPrimaryServerUrl

VovGetPriorityChars

File
vovutils.tcl
Usage
VovGetPriorityChars n

VovGetProductName

File
vovutils.tcl
Usage
VovGetProductName

vovGetProjectFileName

File
vovtraceutils.tcl
Usage
vovGetProjectFileName pf serverdir (default=)

VovGetProp

File
vovutils.tcl
Usage
VovGetProp objId name dflt

VovGetPropertyWithTimeout

File
vovutils.tcl
Usage
VovGetPropertyWithTimeout objId propName args
Description
A robust implementation of vtk_prop_get with timeout, default values, etc. This implementation tries multiple times

VovGetRegistry

File
vovregistrylib.tcl
Usage
VovGetRegistry
Description
Return the path to the VOV registry directory

VovGetRegistryFiles

File
vovregistrylib.tcl
Usage
VovGetRegistryFiles

VovGetSecurityLevel

File
vovutils.tcl
Usage
VovGetSecurityLevel
Description
Return the numeric value of the current user security.
2 = READONLY
3 = USER
4 = LEADER
5 = ADMIN

vovGetSnapshotDir

File
vovenvutils.tcl
Usage
vovGetSnapshotDir logdir
Description
Try to keep snapshots away from the logs, to avoid NFS caching.

VovGetSubsets

File
vovtraceutils.tcl
Usage
VovGetSubsets setIdOrName

VovGetSymbolicSecurity

File
vovutils.tcl
Usage
VovGetSymbolicSecurity n

VovGetToolName

File
vovfdl.tcl
Usage
VovGetToolName name
Description
Get the characteristic name of a tool (on NT, drop the .exe .bat suffix).

VovGetUniqueJobs

File
vovtraceutils.tcl
Usage
VovGetUniqueJobs doRecursive doVerbose allJobsRef setId

VovGetUserName

File
vovutils.tcl
Usage
VovGetUserName

VovGetVovPortFromWebPort

File
vovtraceutils.tcl
Usage
VovGetVovPortFromWebPort webhost webport useSsl
Description
set webhost [lindex [split $queue "@"] 1] set webport $result($queue,webport)

vovHashEnvironment

File
vovenvutils.tcl
Usage
vovHashEnvironment

vovHelp

File
vov_common.tcl
Usage
vovHelp txt

VovHierFlow::BLOCK

File
vovhierflow.tcl
Usage
VovHierFlow::BLOCK name type arg1 args

VovHierFlow::C

File
vovhierflow.tcl
Usage
VovHierFlow::C args

VovHierFlow::computeSubFlowStats

File
vovhierflow.tcl
Usage
VovHierFlow::computeSubFlowStats subFlowName stats w (default=)

VovHierFlow::customize

File
vovhierflow.tcl
Usage
VovHierFlow::customize window menu

VovHierFlow::DominantStatus

File
vovhierflow.tcl
Usage
VovHierFlow::DominantStatus s1 s2

VovHierFlow::FOLDER

File
vovhierflow.tcl
Usage
VovHierFlow::FOLDER name args
Description
  • -doc DOCS -side SIDE: Where side can be "left" "right" "top" "bottom" (as in Tk pack)
  • -balloon MvSG -buttons B: Where B is one of "vertical","horizontal","none"
  • -hide: Hide the folder (frame not visible, but there)
  • -label L: Where L can be "normal" or "none"

VovHierFlow::GetFromParentFolder

File
vovhierflow.tcl
Usage
VovHierFlow::GetFromParentFolder what dflt

VovHierFlow::HLF

File
vovhierflow.tcl
Usage
VovHierFlow::HLF name script args

VovHierFlow::HLFAddBlockMenu

File
vovhierflow.tcl
Usage
VovHierFlow::HLFAddBlockMenu w setName type

VovHierFlow::HLFAddSetControls

File
vovhierflow.tcl
Usage
VovHierFlow::HLFAddSetControls f setname side

VovHierFlow::HLFAddSubFlowControls

File
vovhierflow.tcl
Usage
VovHierFlow::HLFAddSubFlowControls f subFlowName

VovHierFlow::HLFballoon

File
vovhierflow.tcl
Usage
VovHierFlow::HLFballoon w msg
Description
$::VovGUI::widget(balloon) bind $w -balloonmsg $msg

VovHierFlow::HLFbindings

File
vovhierflow.tcl
Usage
VovHierFlow::HLFbindings w setName

VovHierFlow::HLFdoc

File
vovhierflow.tcl
Usage
VovHierFlow::HLFdoc w docs

VovHierFlow::HLFgetContext

File
vovhierflow.tcl
Usage
VovHierFlow::HLFgetContext

VovHierFlow::HLFinitializeStructure

File
vovhierflow.tcl
Usage
VovHierFlow::HLFinitializeStructure

VovHierFlow::HLFpopContext

File
vovhierflow.tcl
Usage
VovHierFlow::HLFpopContext

VovHierFlow::HLFpopupMenu

File
vovhierflow.tcl
Usage
VovHierFlow::HLFpopupMenu name x y type w

VovHierFlow::HLFpushContext

File
vovhierflow.tcl
Usage
VovHierFlow::HLFpushContext f

VovHierFlow::HLFrender

File
vovhierflow.tcl
Usage
VovHierFlow::HLFrender name top

VovHierFlow::HLFrenderInside

File
vovhierflow.tcl
Usage
VovHierFlow::HLFrenderInside name w

VovHierFlow::HLFrenderNewWindow

File
vovhierflow.tcl
Usage
VovHierFlow::HLFrenderNewWindow name

VovHierFlow::HLFshowDocs

File
vovhierflow.tcl
Usage
VovHierFlow::HLFshowDocs docSpec

VovHierFlow::HLFStartVovConsole

File
vovhierflow.tcl
Usage
VovHierFlow::HLFStartVovConsole proj host port setName

VovHierFlow::HLFStartVovProject

File
vovhierflow.tcl
Usage
VovHierFlow::HLFStartVovProject proj

VovHierFlow::HLFupdateSetLabel

File
vovhierflow.tcl
Usage
VovHierFlow::HLFupdateSetLabel tkLabel blockName setName

VovHierFlow::HLFupdateStatusBarForSet

File
vovhierflow.tcl
Usage
VovHierFlow::HLFupdateStatusBarForSet tkcanvas STAT

VovHierFlow::HLFupdateSubFlow

File
vovhierflow.tcl
Usage
VovHierFlow::HLFupdateSubFlow label subFlowName

VovHierFlow::HLFupdateSubProject

File
vovhierflow.tcl
Usage
VovHierFlow::HLFupdateSubProject label name proj host port setName

VovHierFlow::HLFUpdateViewButtonForSet

File
vovhierflow.tcl
Usage
VovHierFlow::HLFUpdateViewButtonForSet f action setId

VovHierFlow::HLFUpdateViewButtonForSubFlow

File
vovhierflow.tcl
Usage
VovHierFlow::HLFUpdateViewButtonForSubFlow f action flowName

VovHierFlow::iconName

File
vovhierflow.tcl
Usage
VovHierFlow::iconName icon

VovHierFlow::init

File
vovhierflow.tcl
Usage
VovHierFlow::init

VovHierFlow::RunAllInSubflow

File
vovhierflow.tcl
Usage
VovHierFlow::RunAllInSubflow subFlowName

VovHierFlow::RunCustomize

File
vovhierflow.tcl
Usage
VovHierFlow::RunCustomize window menu

VovHierFlow::SETrenderInside

File
vovhierflow.tcl
Usage
VovHierFlow::SETrenderInside w setId args

VovHierFlow::SETrenderNewWindow

File
vovhierflow.tcl
Usage
VovHierFlow::SETrenderNewWindow setname

VovHierFlow::SPACER

File
vovhierflow.tcl
Usage
VovHierFlow::SPACER args

VovHierFlow::SUBPROJECT

File
vovhierflow.tcl
Usage
VovHierFlow::SUBPROJECT name projAtHost args

VOVHTML_FINISH

File
vovhtml.tcl
Usage
VOVHTML_FINISH contentType (default=text/html) attachment (default=)
Description
Put the completed HTML page on stdout

VOVHTML_START

File
vovhtml.tcl
Usage
VOVHTML_START useFile (default=1) fakeDiskFull (default=0)
Description
Start building an HTML page If useFile is nonzero, use a temporary file, else build page in memory
Returns
1 for success, 0 if errors were encountered
The lines in the page are added by the proc OUT{}

vovHtmlPlotMetrics

File
vovhtmlmetricplot.tcl
Usage
vovHtmlPlotMetrics args
Description
Generate a plot of one or more metrics. with a legend on the right. Args:
  • -output html|query|raw|csv
  • -title TITLE
  • -subtitle SUBTITLE
  • -resource RESOURCE
  • -width WIDTH
  • -height HEIGHT
  • -glitch SECONDS
  • -ymax MAX_Y_SHOWN_IN_PLOT
  • -bininterval TIMESPEC
  • -debug 0|1
  • -m "family metricname [color] [label]" (can be repeated)

VovHttpGET

File
vovutils.tcl
Usage
VovHttpGET host port url replyVar args
Description
This procedure must be reentrant, because it calls vwait, which may cause some callbacks to be called which in turn could call this proc again. Get data from 'url' via HTTP at host:port, put reply in the variable named by replyVar. The timeout argument is in seconds and must be positive.
Returns
1 if all goes well; 0 if the socket cannot be opened or if there is a timeout.

vovInvalidateNode

File
vovtraceutils.tcl
Usage
vovInvalidateNode id whyReason (default=)
Description
Invalidate the specified node.
Returns
1 if something was done, 0 otherwise.

VovIsCGI

File
vov_boot.tcl
Usage
VovIsCGI

VovIsLm

File
vovutils.tcl
Usage
VovIsLm

VovIsNc

File
vovutils.tcl
Usage
VovIsNc

VovIsWin

File
vovutils.tcl
Usage
VovIsWin

VovJobClassGetProperty

File
vovutils.tcl
Usage
VovJobClassGetProperty className propName defaultValue (default=)

VovJSON::getArray

File
vovjson.tcl
Usage
VovJSON::getArray args

VovJSON::getObject

File
vovjson.tcl
Usage
VovJSON::getObject args

VovJSON::init

File
vovjson.tcl
Usage
VovJSON::init

VovLDAP::close

File
vovldap.tcl
Usage
VovLDAP::close lh

VovLDAP::getDnAttributes

File
vovldap.tcl
Usage
VovLDAP::getDnAttributes dn attrList (default=)
Description
Get attributes for a specific DN.

VovLDAP::getEmail

File
vovldap.tcl
Usage
VovLDAP::getEmail users delim (default= ) subject (default=) body (default=)
Description
Get e-mail addresses from LDAP based on user names. Requires one or more users to be passed in, separated by commas.
Return
User name if none is found. If a subject is passed in, return a mailto link for users with subject. Otherwise, return a list of e-mail addresses.

VovLDAP::getGroupMembers

File
vovldap.tcl
Usage
VovLDAP::getGroupMembers group
Description
Get members of a specific group

VovLDAP::getUserAttributes

File
vovldap.tcl
Usage
VovLDAP::getUserAttributes user attrList (default=)
Description
Get a list of attributes for a specific user. If no attributes are passed, use config file settings.

VovLDAP::getUserDn

File
vovldap.tcl
Usage
VovLDAP::getUserDn user
Description
Get the DN for a specific user.

VovLDAP::getUserGroups

File
vovldap.tcl
Usage
VovLDAP::getUserGroups user
Description
Get groups to which a specific user belongs

VovLDAP::getUsersMatching

File
vovldap.tcl
Usage
VovLDAP::getUsersMatching attr value
Description
Get users matching a specific attribute value

VovLDAP::init

File
vovldap.tcl
Usage
VovLDAP::init

VovLDAP::map

File
vovldap.tcl
Usage
VovLDAP::map results
Description
Order and map results according to configuration

VovLDAP::open

File
vovldap.tcl
Usage
VovLDAP::open

VovLicenseViolationCallback

File
vov_boot.tcl
Usage
VovLicenseViolationCallback hasViolation

VovLimitClientsForThisUser

File
vov_common.tcl
Usage
VovLimitClientsForThisUser nickname max
Description
Find how many clients with the give nickname we already have.

vovLongId

File
vov_common.tcl
Usage
vovLongId id

VovLooksLikeAnId

File
vovutils.tcl
Usage
VovLooksLikeAnId s

VovMessage

File
vovutils.tcl
Usage
VovMessage msg verboseLevel (default=0)

VovMetricsReloadHistorical

File
vovtraceutils.tcl
Usage
VovMetricsReloadHistorical family beginTs
Description
This procedure reloads historical metrics for the given family back to the specified timestamp

VovOutputConflictHandlerAbort

File
vovfdl.tcl
Usage
VovOutputConflictHandlerAbort jobId placeId oldJobId

VovOutputConflictHandlerRetry

File
vovfdl.tcl
Usage
VovOutputConflictHandlerRetry jobId placeId oldJobId

VovParseStdOptions

File
vovutils.tcl
Usage
VovParseStdOptions argList usage allowEmptyArgList (default=0)
Description
Parse options -h and -v
Also print usage message if the argList is empty.

VovParseTimeSpec

File
vovutils.tcl
Usage
VovParseTimeSpec spec
Description
Convert a VOV timespec into a number of seconds The empty string returns 0. Bad specs cause an error.

VovPlotMetrics

File
vovmetricplots.tcl
Usage
VovPlotMetrics args

VovPlotMetricsFrame

File
vovmetricplots.tcl
Usage
VovPlotMetricsFrame frame script args

VovPlotMetricsFrame_close

File
vovmetricplots.tcl
Usage
VovPlotMetricsFrame_close frame

VovPlotMetricsFrameSetConfig

File
vovmetricplots.tcl
Usage
VovPlotMetricsFrameSetConfig frame element val

VovPlotShowSchedulerMetrics

File
vovmetricplots.tcl
Usage
VovPlotShowSchedulerMetrics topFrame configFile

VovPredictGet

File
vovfdl.tcl
Usage
VovPredictGet

VovPredictRam

File
vovfdl.tcl
Usage
VovPredictRam

VovPredictReduce

File
vovfdl.tcl
Usage
VovPredictReduce str max (default=80)
Description
Convert to string

VovPredictXdur

File
vovfdl.tcl
Usage
VovPredictXdur

VovPrintStack

File
vovfdl.tcl
Usage
VovPrintStack

VovPrintUsage

File
vovutils.tcl
Usage
VovPrintUsage message

VovProduct

File
vovutils.tcl
Usage
VovProduct args

VovProjectStall

File
vovtraceutils.tcl
Usage
VovProjectStall whyReason

VovProjectUnstall

File
vovtraceutils.tcl
Usage
VovProjectUnstall whyReason

VovPsig

File
vovutils.tcl
Usage
VovPsig args
Description
Compute the signature of an Altair Engineering project from the environment (default) or from positional or keyword parameters
Examples:
  • VovPsig: compute signature from env-vars
  • VovPsig proj host: proj@host
  • VovPsig -host foo -proj bar -port 666: bar@foo:666

vovReadFile

File
vovenvutils.tcl
Usage
vovReadFile file

VovReorderTags

File
vov_policy.tcl
Usage
VovReorderTags inputTagList referenceTagList
Description
Given an input list of tags (inputTagList) and a partial order of tags specified in referenceTagList, return a list of all input tags in an order that satisfies the partial ordering.

VovRgyFindEntries

File
vovregistrylib.tcl
Usage
VovRgyFindEntries avar args
Description
Scan array named by avar (loaded by VovRgyLoadData) for entries matching any of the -attr options

VovRgyGetDirectory

File
vovregistrylib.tcl
Usage
VovRgyGetDirectory

VovRgyGetGeneric

File
vovregistrylib.tcl
Usage
VovRgyGetGeneric avar psig key

VovRgyLoadData

File
vovregistrylib.tcl
Usage
VovRgyLoadData namepat userpat avar verbose (default=0)
Description
Fill variable named by avar with registry info; return count of entries If namepat is non-null-string, include only entries matching name regex If user is non-null-string, include only entries owned by user.

VovScanClock

File
vovutils.tcl
Usage
VovScanClock s
Description
Best effort to scan a clock specification. It could also be a unix timestamp
Examples:
 VovScanClock 20081231
 VovScanClock 20081231T120000
 VovScanClock [clock seconds]
 VovScanClock "Oct 31, 2008"
 VovScanClock "31-Oct-2008"

VovSearchFile

File
vovutils.tcl
Usage
VovSearchFile file dirList errorHandling (default=quiet)

VovServerBusyCallback

File
vov_boot.tcl
Usage
VovServerBusyCallback

VovServerConfig

File
vovtraceutils.tcl
Usage
VovServerConfig name value
Description
This procedure is used mostly with the output from "vovshow -policy"
Another version of this procedure is defined by vovserver before sourcing the policy.tcl file

VovServerMessage

File
vovutils.tcl
Usage
VovServerMessage msg

VovSetCGIError

File
vov_boot.tcl
Usage
VovSetCGIError msg

VovSetChangeStatusProp

File
vovtraceutils.tcl
Usage
VovSetChangeStatusProp id msg status
Description
Keep a history of reconciled

vovSetGlobalBackground

File
vov_boot.tcl
Usage
vovSetGlobalBackground projectName bg (default=) fg (default=)
Description
This procedure is called from vov_boot.tcl There is a duplicate in tracesrv.cc (VovTrace::getTraceColor()). This should call the C++ procedure. It is possible to have many VOV windows associated to different projects. We want to distinguish them using the background and foreground color. This procedure sets the global window background and foreground to be a function of the project name. If the variables VOV_BACKGROUND and/or VOV_FOREGROUND are set, they prevail. The default colors in VOV are designed to work with a light background.
Return
The pair (foregroundColor, backgroundColor).
Side Effects
vov_color(background) and vov_color(foreground) are set.

vovShortId

File
vov_common.tcl
Usage
vovShortId id
Description
Convert id from its long to its short form. For example, 00012345 becomes 12345.

VovShowProgress

File
vovfdl.tcl
Usage
VovShowProgress module (default=10)

VovSignature

File
vovutils.tcl
Usage
VovSignature

vovTaskerLoadColorMap

File
vov_common.tcl
Usage
vovTaskerLoadColorMap

vovTaskerStatus2Color

File
vov_common.tcl
Usage
vovTaskerStatus2Color status

vovTaskerStatus2ColorFg

File
vov_common.tcl
Usage
vovTaskerStatus2ColorFg status

VovSQL::canonicalizeLogName

File
vovsql.tcl
Usage
VovSQL::canonicalizeLogName logFile

VovSQL::canUseMaterializedView

File
vovsql.tcl
Usage
VovSQL::canUseMaterializedView handle view start_ts end_ts

VovSQL::checkMySqlConnector

File
vovsql.tcl
Usage
VovSQL::checkMySqlConnector

VovSQL::close

File
vovsql.tcl
Usage
VovSQL::close handle
Description
Closes a connection handle

VovSQL::commit

File
vovsql.tcl
Usage
VovSQL::commit handle
Description
OBSOLETE
Commits statements that have been processed when auto commit mode is off

VovSQL::configure

File
vovsql.tcl
Usage
VovSQL::configure args
Description
Gets database configuration from db/config.tcl.

VovSQL::createIndex

File
vovsql.tcl
Usage
VovSQL::createIndex handle table index columns args
Description
Create an index

VovSQL::createMaterializedView

File
vovsql.tcl
Usage
VovSQL::createMaterializedView handle table view

VovSQL::createSequence

File
vovsql.tcl
Usage
VovSQL::createSequence handle name args
Description
OBSOLETE
Create an Oracle sequence, do nothing for other vendors

VovSQL::createTable

File
vovsql.tcl
Usage
VovSQL::createTable handle table members

VovSQL::createTempTable

File
vovsql.tcl
Usage
VovSQL::createTempTable handle table members

VovSQL::createTrigger

File
vovsql.tcl
Usage
VovSQL::createTrigger handle table name when what sql args
Description
Create a trigger that executes the specified SQL

VovSQL::dropIndex

File
vovsql.tcl
Usage
VovSQL::dropIndex handle table index args
Description
Drop an index

VovSQL::escapeString

File
vovsql.tcl
Usage
VovSQL::escapeString handle str maxLen (default=0)

VovSQL::exec

File
vovsql.tcl
Usage
VovSQL::exec handle stmt args
Description
Execute a non-select statement Return the number of affected rows or 0.

VovSQL::getColumnCollation

File
vovsql.tcl
Usage
VovSQL::getColumnCollation handle table column args
Description
Return the collation of the column.

VovSQL::getColumnDescription

File
vovsql.tcl
Usage
VovSQL::getColumnDescription handle table column
Description
Return the description of the column or the empty string if the column does not exist.

VovSQL::getColumnNumericPrecision

File
vovsql.tcl
Usage
VovSQL::getColumnNumericPrecision handle table column args
Description
Return the numeric precision of the specified column for the specified table.

VovSQL::getColumns

File
vovsql.tcl
Usage
VovSQL::getColumns handle table args
Description
Return a list of columns found in the specified table.

VovSQL::getColumnWidth

File
vovsql.tcl
Usage
VovSQL::getColumnWidth handle table column args
Description
Return the width of the specified column for the specified table.

VovSQL::getDbApp

File
vovsql.tcl
Usage
VovSQL::getDbApp
Description
Return the value of variable VOV_DB_APP.

VovSQL::getDbDir

File
vovsql.tcl
Usage
VovSQL::getDbDir
Description
Get database directory

VovSQL::getDbInfo

File
vovsql.tcl
Usage
VovSQL::getDbInfo

VovSQL::getFeatureIdNameMap

File
vovsql.tcl
Usage
VovSQL::getFeatureIdNameMap handle array args
Description
Used for loading the feature ID to name mapping and vice-versa filtered by any specified tag IDs -tagids { idList } -featureids { idList } -featurenames { nameList } -negatetags Constrain the lookup to the NOT of the specified tags -negatefeatures Constrain the lookup to the NOT of the specified features

VovSQL::getIdNameMap

File
vovsql.tcl
Usage
VovSQL::getIdNameMap handle table array args
Description
Loads reference tables for ID to name mapping and vice-versa Args: -ids { idList } -names { nameList } -negate Constrain the lookup to the NOT of the specified object names

VovSQL::getLogFileId

File
vovsql.tcl
Usage
VovSQL::getLogFileId handle relFile
Description
Returns the ID of a file that has been loaded into the database

VovSQL::getPassword

File
vovsql.tcl
Usage
VovSQL::getPassword u

VovSQL::getTagForFeatureId

File
vovsql.tcl
Usage
VovSQL::getTagForFeatureId handle feature_id
Description
Returns tag associated with a feature Id

VovSQL::getTrackedFileData

File
vovsql.tcl
Usage
VovSQL::getTrackedFileData handle fileName forceReload dataVar

VovSQL::getVendor

File
vovsql.tcl
Usage
VovSQL::getVendor
Description
Returns the configured or overridden DB vendor

VovSQL::init

File
vovsql.tcl
Usage
VovSQL::init

VovSQL::isColumn

File
vovsql.tcl
Usage
VovSQL::isColumn handle table column args
Description
Determine if a column exists in the specified table

VovSQL::isConstraint

File
vovsql.tcl
Usage
VovSQL::isConstraint handle table constraint args
Description
Determine if a constraint exists in the specified table

VovSQL::isDatabase

File
vovsql.tcl
Usage
VovSQL::isDatabase handle dbname

VovSQL::isIndex

File
vovsql.tcl
Usage
VovSQL::isIndex handle table index args
Description
OBSOLETE except for vovsql_create_tables_jobs, which should create indexes along the way instead of at the end. Determine if an index exists in the configured database

VovSQL::isSequence

File
vovsql.tcl
Usage
VovSQL::isSequence handle sequence args
Description
OBSOLETE Determine if an Oracle sequence or trigger exists. Returns 1 for other vendors since they do not use sequences.

VovSQL::isTable

File
vovsql.tcl
Usage
VovSQL::isTable handle table args
Description
Determine if a table exists in the configured database

VovSQL::isTrigger

File
vovsql.tcl
Usage
VovSQL::isTrigger handle trigger args
Description
Determine if a trigger exists

VovSQL::isUser

File
vovsql.tcl
Usage
VovSQL::isUser handle user args
Description
Determine if a user exists in the configured database

VovSQL::lastInserted

File
vovsql.tcl
Usage
VovSQL::lastInserted handle table
Description
Returns the id of the last inserted record in the table

VovSQL::loop

File
vovsql.tcl
Usage
VovSQL::loop handle stmt variables script args
Description
Execute Tcl upon each row in the result set

VovSQL::open

File
vovsql.tcl
Usage
VovSQL::open args
Description
Opens and returns a connection handle for the configured database

VovSQL::query

File
vovsql.tcl
Usage
VovSQL::query handle stmt args
Description
Execute a select statement

VovSQL::raiseError

File
vovsql.tcl
Usage
VovSQL::raiseError msg info (default=) code (default=-1)

VovSQL::refreshMaterializedView

File
vovsql.tcl
Usage
VovSQL::refreshMaterializedView handle view

VovSQL::rollback

File
vovsql.tcl
Usage
VovSQL::rollback handle
Description
OBSOLETE
Rolls back changes made by statements that have been processed when auto commit mode is off

VovSQL::setAutoIncrement

File
vovsql.tcl
Usage
VovSQL::setAutoIncrement handle table value
Description
Sets the auto increment value for a table to the specified value.

VovSQL::setErrorControl

File
vovsql.tcl
Usage
VovSQL::setErrorControl ec
Description
Set the way errors are handled in the VovSQL namespace. See raiseError for possible values. Note that "internal" is used only during the sourcing of the sql config file, to differentiate between an error raised on purpose, such as "Database is not running," and an error in the actual sourcing of the file.

VovSQL::setPassword

File
vovsql.tcl
Usage
VovSQL::setPassword u p

VovSQL::showConfig

File
vovsql.tcl
Usage
VovSQL::showConfig
Description
Show configuration

VovSQL::sqlite3_busy_callback

File
vovsql.tcl
Usage
VovSQL::sqlite3_busy_callback
Description
Procedure called if the sqlite3 database is locked.

VovSQLPort::autoIncrement

File
vovsql.tcl
Usage
VovSQLPort::autoIncrement
Description
Returns SQL fragment for defining a column that auto-increments its values. This is applicable to MySQL and SQLite only. Oracle uses a sequence and trigger to accomplish this.

VovSQLPort::autoInteger

File
vovsql.tcl
Usage
VovSQLPort::autoInteger args
Description
Returns SQL fragment for the data type for an auto-incrementing integer This is applicable to PostgreSQL only, other vendors are forwarded to the VovSQLPort::integer procedure as normal.

VovSQLPort::begin

File
vovsql.tcl
Usage
VovSQLPort::begin
Description
OBSOLETE
Returns SQL fragment for BEGIN

VovSQLPort::char

File
vovsql.tcl
Usage
VovSQLPort::char width
Description
Returns a SQL fragment for defining a character column type of the specified width

VovSQLPort::concat

File
vovsql.tcl
Usage
VovSQLPort::concat args

VovSQLPort::createTempTable

File
vovsql.tcl
Usage
VovSQLPort::createTempTable
Description
Returns a SQL fragment for creating a temporary table

VovSQLPort::dropTempTable

File
vovsql.tcl
Usage
VovSQLPort::dropTempTable table
Description
Returns a SQL statement for dropping a temporary table

VovSQLPort::formatTs

File
vovsql.tcl
Usage
VovSQLPort::formatTs field format
Description
Heatmap uses day,hour format

VovSQLPort::greaterThan

File
vovsql.tcl
Usage
VovSQLPort::greaterThan a b
Description
Returns a SQL fragment returning a boolean bit based on whether value a is greater than value b.

VovSQLPort::greatest

File
vovsql.tcl
Usage
VovSQLPort::greatest
Description
Returns a SQL fragment for the vendor-specific function that compares column or static values to determine the one with the highest value.

VovSQLPort::init

File
vovsql.tcl
Usage
VovSQLPort::init

VovSQLPort::integer

File
vovsql.tcl
Usage
VovSQLPort::integer type (default=INT) signed (default=UNSIGNED)
Description
Return SQL fragment containing integer data type definition based on arguments passed.

VovSQLPort::isNull

File
vovsql.tcl
Usage
VovSQLPort::isNull
Description
Returns SQL fragment for use in a where clause to determine if a column contains a null value.

VovSQLPort::least

File
vovsql.tcl
Usage
VovSQLPort::least
Description
Returns SQL fragment for the vendor-specific function that compares column or static values to determine the one with the lowest value.

VovSQLPort::lessThan

File
vovsql.tcl
Usage
VovSQLPort::lessThan a b
Description
Returns SQL fragment returning a boolean bit based on whether value a is less than value b.

VovSQLPort::roundTs

File
vovsql.tcl
Usage
VovSQLPort::roundTs field format roundTo
Description
Denial plot uses this, but only Oracle requires it. The formatTs procedure above will work for all other vendors. This will be OBSOLETE once we pull support for Oracle

VovSQLPort::vendor

File
vovsql.tcl
Usage
VovSQLPort::vendor vendorList sql alt (default=)
Description
Returns the specified SQL if the configured vendor matches that of the specified vendor. Otherwise, it returns the alternate SQL if specified.

VovStartRetraceHierarchical

File
vovsql.tcl
Usage
VovStartRetraceHierarchical priority mode resources what targetId recursiveLevel (default=0)

VovTmpFile

File
vovsql.tcl
Usage
VovTmpFile file

VovTranslateMsgText

File
vovutils.tcl
Usage
VovTranslateMsgText msg
Description
Temporarily just return message for English. When i18n or l10n is added, this is where the translation logic will be added.

VovUpdateValidityWave

File
vovutils.tcl
Usage
VovUpdateValidityWave daemon now verbose (default=0)
Description
A validity wave is a wave that has values u and 1

VovUserError

File
vovutils.tcl
Usage
VovUserError msg noexit (default=0)

vovUseSnapshot

File
vovutils.tcl
Usage
vovUseSnapshot
Description
We use the snapshot if: the env(VOV_ENV) is not set. the env(VOV_ENV) is set to either "" or "DEFAULT" or if it begins with the component "SNAPSHOT" with no file argument (i.e. no SNAPSHOT(....)).

VovVerboseMessage

File
vovutils.tcl
Usage
VovVerboseMessage verbose msg

VovVersion

File
vovutils.tcl
Usage
VovVersion
Description
Return the version of the current VOVDIR installation. It expects to find the file $VOVDIR/etc/version.txt

VovWarning

File
vovutils.tcl
Usage
VovWarning msg verboseLevelIgnored (default=0)

VovWhy

File
vovwhy.tcl
Usage
VovWhy nodeId args

VovWXWhy

File
vovwhy.tcl
Usage
VovWXWhy jobId status

vtk_counter_create

File
vovtraceutils.tcl
Usage
vtk_counter_create name

vtk_fairshare_get

File
vov_policy.tcl
Usage
vtk_fairshare_get
Description
Added for backwards compatibility.

vtk_flexlm_exclude_tags

File
vov_policy.tcl
Usage
vtk_flexlm_exclude_tags tags

vtk_flexlm_monitor_filter

File
vov_policy.tcl
Usage
vtk_flexlm_monitor_filter tag feature
Description
Filter features for vtk_flexlm_monitor_all based on tag and feature name. The procedure must return a Boolean. The default procedure simply returns 1 for all features.

vtk_flexlm_monitor_mapname

File
vov_policy.tcl
Usage
vtk_flexlm_monitor_mapname tag feature
Description
This is a procedure that can be overwritten in resources.tcl.
Map license feature name to FT resourcemap right-hand-side The default procedure simply returns the empty string, meaning no mapping.

vtk_flexlm_monitor_resname

File
vov_policy.tcl
Usage
vtk_flexlm_monitor_resname tag feature
Description
Map license tag and feature name to VOV resourcemap name. The default procedure simply prepends License: to the feature name

vtk_flexlm_turbo

File
vov_policy.tcl
Usage
vtk_flexlm_turbo lmFeature turboFactor
Description
Use vtk_flexlm_overbook instead.

VTK_GENERIC_GET_BUCKETS

File
vovtraceutils.tcl
Usage
VTK_GENERIC_GET_BUCKETS array

vtk_percent_pp

File
vtkutils.tcl
Usage
vtk_percent_pp number

vtk_resource_policy_hook

File
vov_policy.tcl
Usage
vtk_resource_policy_hook projectName resName max
Description
This procedure is used to limit the max number of a resource assigned to a project.

vtk_resourcemap_procedure

File
vov_policy.tcl
Usage
vtk_resourcemap_procedure procedure
Description
Register a procedure used to update a resource map. Only used in vovresourced.

vtk_resourcemap_sum

File
vov_policy.tcl
Usage
vtk_resourcemap_sum sum components
Description
Define a resource as being the sum of some components. The resource is then also mapped to the OR of the components. The counterpart of this procedure is updateAllSumResources which is called by vovresourced.

vtk_trace_info

File
vovtraceutils.tcl
Usage
vtk_trace_info args

vtk_user_info

File
vovtraceutils.tcl
Usage
vtk_user_info args