Tcl Environment
When a
Tcl
script is started, the standard set of
Tcl
and, if running with the
Tk
widgets support,
Tk
variables is available in the interpreter.
In addition, the toolkit provides access to internal toolkit status information via the global array variable
cactvs
. It is automatically present both in the top-level interpreter and in slave and thread interpreters. Many of the elements in the array may be modified by script commands. If they are manipulated this way, their effects are immediate, but not persistent, and visible in all interpreters.
In case the current application includes a Python interpreter, it contains an equivalent global dictionary. Changes made in any language to the control variable are visible in the other.
Parameter changes are forgotten the next time the interpreter is executed.
-
cactvs(application)
Short application name.
-
cactvs(application_long_name)
Long name of application.
-
cactvs(application_mode)
A code for the type of application context the
Tcl
interpreter is operating in. Possible values are 0 (undefined), 1 (simple standalone executable), 2 (executable running encapsulated
Tcl
script), 3 (full interactive interpreter), 4 (restricted interactive interpreter), 5 (full interpreter running command script), 6 (restricted interpreter running command script), 7 (link library for 3rd party application), 8 (
Tcl
module for 3rd party
Tcl
interpreter), 9 (
Tcl
module for
Tcl
Web browser plug-in), 10 (
Python
module with secondary
Tcl
partner interpreter for 3rd party
Python
interpreter) or 11 (database
UDF
module).
-
cactvs(aromaticity_model)
The aromaticity model to use. Possible values are
cactvs
(the default),
daylight
(which has some nasty problems, but using it will improve compatibility of the results of
Smarts
matching with Daylight software, and tripos, for a really weird and not very useful system.
-
cactvs(async_computation_receiver_port)
Port number used for asynchronous networked property computation requests.
-
cactvs(auto_vector_extension)
A boolean flag which controls the behavior of the toolkit when individual elements of vector property data are set with an element index that is larger than the current size of the vector. By default, only existing vector indices (
0
to
$size-1
) and the new element just beyond current vector size (
$size
) may be used. If the flag is set, any vector index may be addressed. Missing vector elements between the newly set element and the current vector size are filled with default values.
-
cactvs(auxdatapath)
Search path for auxiliary data files required by computational modules.
-
cactvs(base_os)
The operating system core version, i.e. something like
Linux 2.6
or
Linux3.11
for Linux distributions. This is a read-only string.
-
cactvs(bmp_support)
Boolean flag indicating whether this toolkit version support image generation in various legacy Windows bitmap formats.
-
cactvs(build_date)
The date this executable was built, in seconds since 1970, suitable for use with
clock format
command.
-
cactvs(bunzip2_program)
The fully resolved path name of the
bunzip2
program used for I/O of bz2-compressed files.
-
cactvs(byte_order)
A read-only element informing about the byte order of the current platform. It is set to to either
littleendian
or
bigendian
.
-
cactvs(cache_lifetime)
Cactvs
maintains a cache in the user‘s home directory to cache files obtained from databases and Internet URLs. This parameter defines the lifetime of objects in the cache in seconds. Older objects are searched again in the standard search path.
-
c
actvs(captcha_image_file)
The name of the file with last
Captcha
image received as result of an attempt to contact an Internet service. This can happen for example when up- or downloading a Google Docs spreadsheet table file. If no such file exists, the element is an empty string. The file is also deleted and the variable is reset when a decoded
Captcha
was successfully used for log-in.
-
cactvs(captcha_string)
The decoded contents of the Captcha image file above. Its contents are used when attempting to access protected Internet sites. This variable must be set with user interaction. By default, it is a
NULL
string.
-
cactvs(captcha_token)
The access token associated with the
Captcha
image file and decoded string. This is used as credential for Internet service log-ins. The variable is typically set together with the
Captcha
image file when a service requires additional authentication. Scripts would then present the image, get the user to decode it, store the decoded string in the
cactvs(captcha_string)
variable and then attempt another log-in. Modules which support
Captcha
log-ins automatically read and set the
Captcha
variables in the course of their operation.
-
cactvs(cmdxpath)
Search path for
Tcl
command extension modules. The standard
Tcl
package path is automatically added to this search path. The main difference between a
Cactvs
Tcl
expansion and a standard
Tcl
package is the presence of a descriptor structure with metadata.
Cactvs
Tcl
extensions may be loaded as normal
Tcl
packages, but then do not provide access to the module description data via the
cmdx
command.
-
cactvs(color_support)
A read-only boolean flag indicating if the decoding of named colors is supported, either by access to a local X11 color names database or by a compiled-in database.
-
cactvs(compatible)
Regular expression used to match compatible OS variants for dynamically loading modules.
-
cactvs(compress_support)
A read-only boolean flag indicating that the processing of compressed data is supported. This includes
zlib
and
gzip
compression and on most platforms
bzip2
. Internally, some data file formats use the lzo compression format.
-
cactvs(connect_timeout)
The maximum number of seconds to wait and, if necessary, retry after a short break in the process of establishing a socket connection. If set to zero, only a single connection attempt is made. Setting it to a negative value configures an unlimited number of connection attempts - but then a command trying to connect to a dead service never returns.
-
cactvs(cpu_limit)
A read-only variable describing any hard CPU execution time limits set for the interpreter. If the value is -1, which is the default, no limits have been set. Setting a CPU limit is only supported for specific interpreters on certain platforms (for example,
tclcactvs
on Linux), and limits must be set at start-up (option -C for
tclcactvs
).
-
cactvs(crypt_support)
A read-only boolean flag indicating whether the application support encryption by the crypt (and other) algorithms.
-
cactvs(currency_converter_host)
The default currency exchange rate host. If set to an empty string, Internet-based currency conversion is disabled. Conversion is automatically run if a monetary value is requested in a different currency from the one the data is stored in, and the exchange rate has not yet been cached,. Example:
ens set $eh E_PRICE “100.50 EUR”
ens get $eh E_PRICE(USD)
-
cactvs(data_directory)
The name of the installation directory which contains script libraries, filters, bitmaps, help files and other auxiliary files needed for the proper operation of the toolkit. The stand-alone interpreter
csweb
(and its variants) are the only toolkit applications which do not access this resource.
-
cactvs(database_file_key)
An integer indicating that for access to data files a suitable file key must be present. The default value is zero, meaning that no such key is needed. This is only used in very special circumstances when a Cactvs library was built to allow operation only on specifically named files.
-
cactvs(database_log_file)
The name of a file to write logging information for database accesses to.
-
cactvs(database_log_mode)
An boolean value indicating the current log mode. Disabled logging is represented by value 0.
-
cactvs(databasepath)
Search path for database connector modules.
-
cactvs(dataset_count)
The current number of dataset objects. Note that not all datasets necessarily have
Tcl
handles, so there may be a discrepancy between this value and the result list length of the
dataset list
command.
-
cactvs(dataset_swap_threshold)
Maximum size of datasets before disk swapping of contained objects is automatically performed. The default value is 10000. A negative value disables automatic disk swapping.
-
cactvs(datatool_program)
The name or, if not found in a standard location, fully specified path of the NCBI
datatool
program. This program is needed to process PubChem ASN.1 data in text format. For binary ASN.1 data, this program is not used.
-
cactvs(db_support)
A read-only boolean flag indicating whether this interpreter supports database access functions and loadable database client modules (
dbase
and
dbx
Tcl
commands).
-
cactvs(default_currency)
The default currency, which is implicitly assumed when dealing with currency data without an explicit currency indicator. The string should be set to the standard international trade name of the selected currency (i.e. EUR, USD, JPY) though a couple of colloquial names are also recognized (Euro, US$, Yen). In any case, a maximum of four characters are significant.
-
cactvs(default_database)
Name of the default database. These default values are used to initialize dbx database interface objects and do not directly influence operation.
-
cactvs(default_database_host)
Default database host.
-
cactvs(default_database_options)
Default database options to use in the connection string. The format is database-dependent.
-
cactvs(default_database_password)
Default database access password.
-
cactvs(default_database_type)
Type of the default database (
mysql
,
oracle
, etc.).
-
cactvs(default_database_user)
Default database user.
-
cactvs(default_hydrogen_addition_mode)
The default hydrogen processing mode for file objects. Possible values are
asis
,
add
,
strip
,
stripall
, and
addblind
. More information can be found in the documentation of the
molfile set
command in the section describing the
hydrogens
attribute.
-
cactvs(default_reaction_screen_property)
The default property to use for reaction query screening. This is typically
X_SCREEN
.
-
cactvs(default_similarity_property)
The default property to use for similarity queries. This is typically
E_SCREEN
.
-
cactvs(default_substructure_screen_property)
The default property to use for substructure query screening. This is typically either
E_SCREEN
or
E_QUERY_SCREEN
.
-
cactvs(default_superstructure_screen_property)
The default property to use for superstructure query screening. This is typically either
E_NO_HYDROGEN_SCREEN
or
E_NO_HYDROGEN_QUERY_SCREEN
.
-
cactvs(dependency_warning)
If set, warn about property dependencies detected when parsing a property definition which involves dependent properties which are not yet known. Having such dependencies is not illegal, and the dependencies are updated at a later time when the unresolved, referred property has been set up. However, in case these properties are never read, dangling dependencies are never resolved and ignored, and this may indicate a programming error.
-
cactvs(distribution)
The platform this package was compiled for, including distribution information. Example:
Linux2.6-SuSE10.2-64. This element is read-only.
-
cactvs(do_database_lookup)
If set, look-up of extension modules in databases is enabled.
-
c
actvs(do_signals)
If set (which is the default), untrusted or flaky property computation modules may be executed with a set of signal handlers in place, which try to recover from segmentation fault errors and other signals. Recovery is not guaranteed to work if the module corrupted working memory. The signal handler overhead is not insignificant, and properties should be configured to rely on installed signal handlers only if required, and where the problem is not fixable, for example because the source code is not available.
-
cactvs(do_timeouts)
If set, allow time-outs in property computations to occur. This flag is on by default.
-
cactvs(download_package)
The name of the package as downloaded from the
Xemistrry
web site. This is usually a name constructed following the pattern
cactvstools-$(distribution)-$(version)$(licensee).tar.gz
, where the dollar parts are substituted by the distribution and version information. Academic packages do not have the licensee part.
-
cactvs(download_url)
The address of the directory page for the download area this packages originates from. For academic packages, this is usually
http://www.xemistry.com/academic.
-
cactvs(dynamic_loader_mode)
If this flag is to a positive value (it is set by default), the toolkit allows the loading of dynamic extension modules of all supported classes if not prohibited by class-specific flags. Specifically, a value of one allows loading of modules found in the trusted path, a value of two loading from both the standard and trusted path, with the trusted path having preference, and a value of three again loading from both paths, but the the standard path having preference.
-
cactvs(element_sequence)
A list of the numbers of the elements of the periodic system in standard formula sequence (6 = carbon, 1=hydrogen, 0 = pseudo-atoms, 89= Actinium, and so forth).
-
cactvs(ens_count)
The current number of ensemble objects. Note that not all ensembles necessarily have
Tcl
handles, so there may be a discrepancy between this value and the result list length of the
ens list
command.
-
cactvs(eol)
The platform-dependent default end-of-line character(s).
-
cactvs(eutilshost)
The name of the host with the
NCBI
Eutils
suite of
Entrez
database access services. If set to an empty string,
Entrez
access is disabled. Setting it to a different host is only useful if you run an
Entrez
clone in-house. The default is
eutils.ncbi.nlm.nih.gov.
-
cactvs(executable_type)
The platform model the executable was compiled for. It is either 32 or 64 bits. This information is read-only.
-
cactvs(executablepath)
Search path for executable programs, such as compressors and decompressors.
-
cactvs(explicit_stereo_h)
A global formatting flag used by various property computation routines and file I/O modules which indicates preference to retain hydrogens at stereo centers for maximum interpretation reliability, or whether to strip them and to rely on the proper re-attachment by a reader or decoder. By default this flag is set, i.e. stereo hydrogen is preferentially retained.
-
cactvs(expr_support)
A read-only boolean flag which indicates whether the application supports
SQL
-style expressions on data attached to objects, for example via the
expr
object commands.
-
cactvs(extension_support)
A read-only boolean flag which indicates whether this interpreter is capable of loading extension modules, for example file I/O format handlers or datatype handler modules.
-
cactvs(extra_format_flags)
A list of the names of extra formatting bits which should be used for property data formatting in the interpreter. By default this is an empty list.
-
cactvs(fcgi_redirect)
This read-only boolean variable is an indicator on whether the
stdout
,
stderr
and
stdin
standard I/O channels have been redirected to the corresponding
FCGI
channels. To activate or cancel redirection, use the
fcgi
Tcl
command, which is available in some interpreter versions (
tclcactvs
,
csweb
).
-
c actvs(fcgi_support)
A read-only boolean flag indicating whether this application was compiled with
FCGI
(fast
CGI
) support. This flag informs about the availability of the
fcgi
script command as well as the ability of various output mechanisms to directly stream into an
FCGI
channel, or a standard channel redirected into a
FCGI
channel.
-
cactvs(filexpath)
The search path for structure file I/O module extensions
-
cactvs(filterpath)
The search path for filter definitions.
-
cactvs(fontpath)
The search path for TrueType fonts used by several imaging modules.
-
cactvs(full_smarts_support)
A read-only boolean flag indicating whether this interpreter was compiled with a full
SMARTS
parser.
SMILES
and some basic
SMARTS
(essentially the flat match attribute level as found in query
Molfiles
) can be processed even if this capability was not added.
-
cactvs(gdbm_support)
A read-only boolean flag indicating whether this interpreter was compiled with
GDBM
key/value store support.
-
cactvs(gunzip_program)
The fully resolved path name of the
gunzip
program used for I/O of
gzip
-compressed files. An external decoder is only forked if the file is a simple file, and might contain formatting features which cannot be resolved by the simple zlib-based internal program emulation.
-
cactvs(gzip_program)
The fully resolved path name of the
gzip
program used for I/O of
gzip
-compressed files. An external decoder is only forked if the file is a simple file, and might contain formatting features which cannot be resolved by the simple zlib-based internal program emulation.
-
cactvs(host)
The name of the computer the interpreter is running on. Read only.
-
cactvs(host_domain)
Domain name of the host, if identifiable.
-
cactvs(host_ip)
The IP address of the computer the interpreter is running on. Read-only. Depending on the number of network interfaces detected, additional read-only entries named
host_ip2
etc. may be present.
-
cactvs(iconv_program)
The fully resolved path name of the
iconv
program used for I/O of files encoded in UCS-2 and other non-ASCII encodings of text data.
-
cactvs(inchi_support)
A read-only boolean flag indicating whether this interpreter supports operations with InChI strings, including decoding of such strings in the
ens create
command, computing the
E_INCHI, E_STDINCHI, E_INCHIKEY
and
E_STDINCHIKEY
properties, and I/O support for InChI files with or without auxiliary data.
-
cactvs(internet_lookup_level)
This element controls the extent to which Internet-based operations can be implicitly executed. If set to level 0, no external Internet communication takes place. Level one enables the use of Internet services in computational modules and file I/O modules. They are still subject to fine-grained control from the settings of the host control variables and the structure security flag. Level 2 additionally enables the lookup of property definitions and extension modules in Internet repositories named in the search paths. The default Internet lookup level is one.
-
cactvs(internet_support)
A read-only boolean flag informing whether this interpreter was compiled with support for accessing Internet resources, for example via URLs or
SOAP
messages.
-
cactvs(interrupted)
A flag set when an interrupt (user pressing ctrl-c, time-out of operation with time limit) occurred. Commands which can be interrupted, or have a time-out, reset the variable to 0 when the command execution begins. Examples: The
molfile scan
and
ens transform
commands. Note that this variable is global, so when multiple script threads are run, this value may be unreliable.
-
cactvs(io_support)
A read-only boolean flag indicating whether this interpreter supports file-based chemistry data I/O. This flag is only unset in a few specialized link libraries where chemistry data is directly stored in the internal data structures by a third-party application program.
-
cactvs(is_slave)
A read-only boolean flag indicating whether this interpreter is a slave interpreter (for example, a property computation interpreter for scripted properties) or not. Thread main interpreters are not slaves.
-
cactvs(itcl_support)
A read-only boolean flag indicating whether the
Itcl
Tcl
object-oriented programming extension commands are available in this interpreter as a compiled-in component. If not, the Itcl module may still be loaded with standard
Tcl
load
or
package
commands.
-
cactvs(java_class_path)
The Java VM class path, if this is an executable which also has a Java VM compiled in.
-
cactvs(json_support)
A read-only boolean flag indicating whether the application was compiled with an integrated
JSON
parser. This flag informs about the availability of the
json
script command, and support for various json-based encoding and decoding schemes, for example for table data I/O.
-
cactvs(keyxpath)
The database key extension module search path.
-
cactvs(knime_input1_table)
This read-only variable only exists if the interpreter is linked to a
KNIME
node. It contains the handle of the table associated with the first output port of the
KNIME
node, or an empty string if no such port exists. The table has been automatically set up and configured.
-
cactvs(knime_input2_table)
This read-only variable only exists if the interpreter is linked to a
KNIME
node. It contains the handle of the table associated with the second output port of the
KNIME
node, or an empty string if no such port exists. The table has been automatically set up and configured.
-
cactvs(knime_input3_table)
This read-only variable only exists if the interpreter is linked to a
KNIME
node. It contains the handle of the table associated with the third input port of the
KNIME
node, or an empty string if no such port exists. The table has been automatically set up and configured.
-
cactvs(knime_output1_table)
This read-only variable only exists if the interpreter is linked to a
KNIME
node. It contains the handle of the table associated with the first output port of the
KNIME
node, or an empty string if no such port exists. The table has been automatically set up and configured.
-
cactvs(knime_output2_table)
This read-only variable only exists if the interpreter is linked to a
KNIME
node. It contains the handle of the table associated with the second input port of the
KNIME
node, or an empty string if no such port exists. The table has been automatically set up and configured.
-
cactvs(knime_output3_table)
This read-only variable only exists if the interpreter is linked to a
KNIME
node. It contains the handle of the table associated with the third input port of the
KNIME
node, or an empty string if no such port exists. The table has been automatically set up and configured.
-
cactvs(knime_interface_mode)
This read-only variable only exists if the interpreter is linked to a
KNIME
node. It contains a string describing the node connectivity. Examples are
input1
(one input port, no output ports),
output2 (two output ports, no inputs)
,
bridge11
(one input, one output),
bridge12
, (one input, two outputs) etc.
-
cactvs(largefile_support)
A read-only boolean flag indicating if this version of the library supports 64-bit file operations. There are probably no platforms that are still supported which do not allow operations on files with more then 4GB.
-
cactvs(lhasa_support)
A read-only boolean flag indicating that the interpreter supports the
lhasa
object which understands
Lhasa
reaction transforms and the parsing of
Patran
and
Chmtrn
data.
-
cactvs(library_directory)
The path of the directory where the bundled link libraries for this installation are stored. For stand-alone applications, this element is empty.
-
cactvs(license_comment)
Comments regarding the license. Read only.
-
cactvs(license_developer)
Developer of an application. Read only.
-
cactvs(license_hostname)
Name of licensed host, empty if not set. Read-only.
-
cactvs(license_hostid)
Host-ID of licensed host, 0 if not set. More elements
license_hostid2
to
license_hostid10
are present if multiple host IDs are covered by a license. Since academic packages are not bound to host IDs, this array element is not present in such packages. If present, this is a read-only element.
-
cactvs(license_ip)
IP-address for licensed host, 0 if not set. More fields
license_ip2
to
license_ip10
are provided if multiple IP addressed are covered by a license. Since academic packages are not bound to IP addresses, this array element is not present in such packages. If present, this is a read-only element.
-
cactvs(license_maxversion)
Maximal toolkit version covered by license. 0 if not set.
-
cactvs(license_minversion)
Minimal toolkit version covered by license. 0 if not set.
-
cactvs(license_netmask)
Network mask for license. 0 if not set. Read only.
-
cactvs(license_network)
Network address for license. 0 if not set. Read only.
-
cactvs(license_serial)
Serial number of license. 0 if not set. Read only.
-
cactvs(license_support)
A read-only boolean flag indicating whether this interpreter support license handling.
-
cactvs(license_timeout)
Time-out date for license in standard Unix notation (seconds since 1970). 0 for permanent licenses. Read only. Use the
clock format
command to convert it into a readable representation.
-
cactvs(license_type)
License type (
commercial
,
academic
,
government
,
evaluation
). Read only.
-
cactvs(license_user)
Licensed host account user name, not present if not set. More elements
license_user2
to
license_user10
are present if multiple user names are covered by a license. Since academic packages are not bound to users, this array element is not present in such packages. If present, this is a read-only element.
-
cactvs(licensee)
Licensee of the basic toolkit. Read only. This is a free-form string, not a host account name (see above).
-
cactvs(licensor)
Licensor name. Read only.
-
cactvs(lookuphosts)
A list of the names of the hosts used for lookup operations (such as chemical name and
CAS
number resolution in the
ens create
command). The default host list is
cactus.nci.nih.gov (NCI resolver) and opsin.ch.cam.ac.uk (systematic name resolver). www.genome.jp (KEGG) and chemspider.com are also supported as an additional resolvers and can be added or replaced if desired
.
If this array element is set to an empty string, compound name lookup/resolution is disabled. Operations involving contacting the name lookup hosts are not controlled by the
::cactvs(structure_security)
variable setting, because no connection tables are transmitted.
It is possible to attach a directory/file part to the host name for the
NCI
resolver. If a lookup host is specified in this fashion, the default path (
/chemical/structure/
) is overridden. This feature allows access to experimental releases of this service.
-
cactvs(lookupmode)
This array element can be used to fine-tune the operation of the
NCI
resolver. By default, this element is unset, and the default resolver mode is selected when the resolver host is contacted. One useful supported value is
name_pattern
, which invokes substring name search on the resolver.
-
cactvs(lzo_support)
A read-only boolean flag indicating whether the interpreter supports the
Lzo
compression/decompression scheme. This method can for example be used in Minimol compression, resulting in a somewhat faster decompression compared to standard
Zlib
.
-
cactvs(malloc_bytes)
Total count of allocated bytes. Only updated when memory debugging is active.
-
cactvs(malloc_count)
Count of memory allocation operations. Only updated when memory debugging is active.
-
cactvs(malloc_free)
Count of memory release operations. Only updated when memory debugging is active.
-
cactvs(malloc_total)
Currently allocated memory byte count. Only updated when memory debugging is active, and only valid on Windows (where you can obtain the original allocation size of a memory block from its address).
-
cactvs(max_threads)
The maximum number of threads which can concurrently use the library. Both
Tcl
interpreter threads and threads without an interpreter are counted. This is a read-only value.
-
cactvs(maximum_ring_count)
The maximum number of rings allowed in an ensemble. This value is primarily intended to act as a safeguard against the processing of structures with insane numbers of rings, as it can happen while decoding overlapping 3D structures, and not as a principal limitation of the toolkit. The default value of 1000 is certainly sufficient even for large proteins.
-
cactvs(maximum_stereo_distance)
The maximum number of bonds traversed to check stereogenicity, and, indirectly, compute various stereo descriptors. Ligands which differ only beyond this bond distance are not considered different for the purpose of stereo handling. The default value is 22, which corresponds to the maximum required value to handle all entries in the FDA registry.
-
cactvs(memory_limit)
A read-only variable indicating any hard memory limits which have been set for the application. In case this value is -1, no limits are set, which is the default. Memory limits can only be set for certain interpreter versions (for example,
tclcactvs
on Linux), and only on start-up (option -M for
tclcactvs
).
-
cactvs(minimol_support)
A read-only boolean flag which indicates whether this interpreter has support for Minimols.
-
cactvs(mmap_buffer_size)
The maximum length of the memory map buffer for field-based file I/O, in bytes. This attribute affects only a few file formats which can utilized large memory buffers, most notably the
cbs
search file format. If the data size of a field exceeds this limit, the data are read by means of traditional file I/O and not consume system memory resources.
-
cactvs(mmap_high_threshold)
Maximum size of files which should use memory mapping for accelerated reading. Note that this limited applies only to full file mapping - file formats with direct access query fields will still map those fields for accelerated access.
-
cactvs(mmap_low_threshold)
Minimum size of files read via memory mapping for accelerated reading.
-
cactvs(molecule_bond_set)
A bit set of those bond types which contribute to grouping atoms into molecules. The default set consists of the bond types
normal, complex,
and
3center
.
-
cactvs(molfile_count)
The number of currently active
molfile
object handles. Note that not all structure file access objects necessarily have
Tcl
handles, so there may be a discrepancy between this value and the result list length of the
molfile list
command.
-
cactvs(multithreaded)
A read-only boolean flag indicating whether this interpreter supports multi-threaded scripts. This is not equivalent to the
thread_support
flag. The latter is a prerequisite and indicates that the core library supports multiple threads.
-
cactvs(namespace)
The local URN namespace, which is for example used during property look-up. By default, it is set to
.local.
-
cactvs(namespacepath)
The namespace resolution path.
-
cactvs(network_count)
The current number of network objects. Note that not all networks necessarily have
Tcl
handles, so there may be a discrepancy between this value and the result list length of the
network list
command.
-
cactvs(network_support)
A read-only boolean flag indicating whether this application was compiled with support for the
network
object, including its
vertex
and
connection
minor objects, plus the associated script commands of the same name.
-
cactvs(no_file_extensions)
If set to 1, no file format extensions are loaded, even if they are listed in the local system configuration file for automatic loading. Also, automatic look-up for extension modules on file suffixes is blocked.
-
cactvs(no_proxy_hosts)
A comma-separated list of host names which should be contacted directly, not via the proxy host. This variable is only used if a proxy has been configured. The default is an empty list.
-
cactvs(no_rpc)
If this flag is set,
RPC
communication with other
Cactvs
applications is disabled. Since the Windows port currently does not support
RPC
inter-process communication, this flag has no effect on that platform.
-
cactvs(objectpath)
Search path for compiled objects used by property computation modules, including dynamic shared objects, OSX bundles or Windows DLLs.
-
cactvs(ocrhost)
The host to use when performing chemical structure drawing
OCR
, for example when reading
GIF
or
PNG
files as chemical structure files where these image do not possess hidden embedded structure data. The default host
cactvs.nci.nih.gov
runs the OSRA service.
-
cactvs(online)
Flag indicating whether the local host has Internet access. Automatically updated.
-
cactvs(openphacts_id)
The application ID for accessing
OpenPhacts
data.
-
cactvs(openphacts_key)
The key for accessing
OpenPhacts
data.
-
cactvs(os)
The name of the operating system the interpreter is running on, in the full nomenclature used also to name the toolkit packages, i.e. with the name of the operating system distribution. Read only.
-
cactvs(osra_program)
The name or full path of a local installation of the
Osra
chemical OCR program. If it is found, it is used in preference to the Web service, which is advantageous in case of confidential data.
-
cactvs(paper_size)
The default paper size. Usually set to
A4
, or
Letter
, but the standard range of DIN and US sizes is recognized.
-
cactvs(persistent_bond_set)
Bit set of bonds which are persistent, meaning that they are not completely discarded when the structure changes. The default set consists of the bond types
normal, complex, 3center
,
search_not
, and
rgroup
.
-
cactvs(platform)
Platform information -
unix
,
mac
or
windows
.
-
cactvs(private_attributes)
A modifyable value which determines whether
Python
wrapper objects of core toolkit objects may store additional private attributes, in addition to the standard toolkit-implemented attributes. By default this flag is unset to catch errors in the naming of attributes. If set, any attribute that is not a standard attribute is stored in a private object dictionary, without rasing an error.
-
cactvs(processor_count)
The number of processor cores seen by the interpreter. There is no distinction between multi-core and multi-die processors. This attribute is read-only.
-
cactvs(property_definition_count)
The number of properties currently registered in the core. This attribute is read-only.
-
cactvs(property_lock)
If set, properties cannot be deleted from the internal property database, and many operations changing the character of a property are also disabled. This is normally only used in multi-threaded scripts where locking the property database can give a significant speed boost because it eliminates the need to look and unlock individual property definitions.
-
cactvs(propertypath)
The search path for property definitions.
-
cactvs(proxy_host)
The name of a proxy server which is used as an indirect Internet access gateway. All standard Internet-access operations will automatically reroute requests via this proxy, if a proxy host is set. If the string is empty, which is the default, direct Internet access without a proxy is used.
-
cactvs(proxy_password)
A password which is supplied to the Internet proxy server, if one has been configured.
-
cactvs(proxy_user)
The username to supply to the Internet proxy server, if one has been configured.
-
cactvs(pubchemhost)
The host name which is used for PubChem-related data retrieval via the PUG interface, or screen scraping of certain information pages. The default is
pubchem.ncbi.nlm.nih.gov.
-
cactvs(python_error_nessage
The last error message generated by a Python interpreter. If the current application does not contain an embedded Python interpreter, this is always an empty string.
-
cactvs(python_support)
A boolean read-only flag indicating whether a parallel
Python
interpreter is available in this application, which can be accessed with the
python
command, or indirectly by using properties with computation functions written in
Python
.
-
cactvs(qlz_support)
A read-only boolean read-only attribute indicating whether the object swap system uses the faster
QLZ
compressor instead of slower
zlib
compression.
-
cactvs(reaction_count)
The current number of reaction objects. Note that not all reactions necessarily have
Tcl
handles, so there may be a discrepancy between this value and the result list length of the
reaction list
command.
-
cactvs(release_date)
Release date of the toolkit, in standard Unix format as seconds since 1970, intended for use with the
clock format
command. Read only.
-
cactvs(repository_support)
A read-only boolean flag indicating whether this interpreter supports repository objects.
-
cactvs(repxpath)
The alternate representation module search path
-
cactvs(ring_bond_set)
Bit set of bond types which define rings in structures. The default set consists of the bond types
normal, complex
, and
3center
.
-
cactvs(ringset)
The type of ring set computed by default.
-
cactvs(rpc_id)
ID of RPC communication protocol between
Cactvs
processes.
-
cactvs(rpc_support)
A read-only boolean flag indicating whether this application was compiled with support for
RPC
-based socket-facilitated data exchange between
Cactvs
applications, for example remote property calculations. This flag only informs about that specific data exchange mechanism. The availability of other socket-based mechanisms (remote datasets, remote query processing, table row data transfer, file access via URLs, etc.) are not covered.
-
cactvs(rpc_version)
Version of RPC communication protocol.
-
cactvs(script)
The read-only name of the currently executed application script. Empty if no script is run. Depending on the main interpreter type, this is either a
Tcl
or a
Python
script.
-
cactvs(script_url)
If the script interpreter executes a script obtained by Internet access via an URL, the URL is listed here. Read only.
-
cactvs(secondary_script)
The read-only name of the secondary application script, i.e. the helper
Python
script when running a main
Tcl
script, or the helper
Tcl
script when running a main
Python
interpreter. If no such string is used, this is an empty value.
-
cactvs(setsize_exceeded)
Flag indicating that a command which allows the specification of a maximum number of result objects has exceeded this number. Commands which can be controlled in this manner reset the variable to 0 when the command execution begins. Example: The
ens transform
command. This is a global element and may be unreliable in case multiple script threads are used.
-
cactvs(smiles_version)
The version of
SMILES
/
SMARTS
to use. Currently, it can be set to 4.9 or 4.3 (or any value below 4.9). The difference is that in version 4.9 the
x
atom attribute is interpreted according to the newly introduced
Daylight
definition (number of ring bonds), while before that this letter was unused and interpreted as an
Cactvs
extension (number of heteroatom ligands). In 4.9 mode, the former
x
extension is now accessed via the letter
z
. The default is 4.9, i.e. full support of the most current
Daylight
definition.
-
cactvs(smtp_host)
The default mail host to use when sending email with the
mail
command.
-
cactvs(smtp_password)
The password to use when connecting to above mail host.
-
cactvs(smtp_port)
The port to use to connect to the mail host. The default is 587, the newer recommended value both for
smtp
and
smpts
transfers. Some mail host may require other ports, such as the old standard 25, or the alternative port 465 for direct
smpts
without negotiation.
-
cactvs(smtp_user)
The user ID to use when connecting to above mail host.
-
cactvs(soap_method)
Name of default method called via
SOAP
request.
-
cactvs(soap_schema)
Default
SOAP
communication schema name.
-
cactvs(soap_uri)
Default URI associated with
SOAP
communication schema.
-
cactvs(source_lookup)
If this boolean flag is set, the system will attempts to retrieve source code of modules obtained via Internet connections.
-
cactvs(sourcepath)
The search path for source code for extension modules.
-
cactvs(standalone)
A read-only boolean flag which is set for applications which encapsulate an application script and an interpreter into a single, stand-alone executable.
-
cactvs(stationpath)
The directory path where to look for auto-loaded station definition files.
-
cactvs(strict_smarts)
If set,
SMARTS
specifications are interpreted according to strict Daylight specs. The default interpretation is more lenient, for example the aliphatic attribute of upper-case element symbols is not enforced to avoid the need for lengthy aromatic/aliphatic alternative symbols or # notation. Even without this flag, there are various methods to decode a substructure specification according to strict Daylight rules, for example by appending a ! character to the
SMARTS
string, or using appropriate decoder flags in
ens create
or
molfile read
commands. This option only applies to newly decoded
SMARTS
substructures. Substructures read from files such as
cbin/cbase/bdb
which encode the internal object structure of the toolkit already contain the interpretation implicitly and persistently as part of the atom and bond attribute set.
-
cactvs(structure_security)
If this boolean flag is set, no structure or reaction information is sent over Internet connections as a decodable connection table. It is off by default for academic distributions, but on for commercial packages.
If it is on, Internet lookup is still allowed by means of sending identifiers which are likely to be non-confidential (for example, CAS numbers, or
PubChem
CIDs and SIDs) or which cannot be reversed (
Cactvs
hash codes). However, implicit sending of the structure as connection table to Internet services which provide computation or identifier lookup is suppressed if the flag is on. For example, computation of property
E_CID
for the PubChem identifier by means of contacting the PubChem database then always fails, regardless whether the structure has a CID or not, because that operation would require a potentially confidential structure to be sent as decodable InChI string to that database.
This flag can be changed by developers who know what they are doing. Also, direct scripting of any type of Internet access is possible regardless of the flag setting. This flag is a basic safeguard against unintentional data leakage.
-
cactvs(swap_count)
The number of objects which are currently swapped out (see
ens swapout
,
reaction swapout
commands). This element is read-only.
-
cactvs(swap_directory)
The name of a directory to use for ensemble and reaction swapping. By default it is initially an empty string, which is replaced by an automatically created process-specific subdirectory of the system temp directory once the swap subsystem has been initialized.
If this element is set to the name of an existing, writable directory before the first swap operation commences, that directory will be used instead. Changing the control variable value after the first object has been swapped has no effect. An automatically set up swap directory is deleted upon program shutdown. In a user swap directory, only the swap files are removed when the program exits.
-
cactvs(swap_store_type)
Select the type of object store used to swap out excessive numbers of ensemble and reaction objects (see for example the
swapthreshold
dataset
object attribute). The default store is
gdbm
(simple key/value store), but it may also be set to
none
(use separate native Cactvs binary files) or
tokyocabinet
(advanced key/value store). The
tokyocabinet
store is not supported on Windows. Setting this attribute has only an effect before the first object is swapped out. If a method is set which is not supported, the best available method is automatically selected when the first object is swapped out, and the array variable element updated to the actually employed method.
-
cactvs(swap_support)
A read-only boolean flag indicating whether this interpreter supports the swapping of objects to a disk store.
-
cactvs(system_error_code)
The error code of the last
Cactvs
library error of the current thread. Custom errors, for example raised by modules which use a custom message and not the standard message table have an error code of minus one. This is a read-only element, and thread-local.
-
cactvs(system_error_message)
The last raw
Cactvs
library error message of the current thread, without any formatting for the
Tcl
interpreter. Most library messages also generate a
Tcl
error message, but there are many error messages in the toolkit related, for example, to command syntax problems which are part of the scripting layer and not handled by the core library. Such errors do not change the library message. This is a read-only element, and thread-local.
-
cactvs(table_count)
The current number of table objects in the application. Note that not all tables necessarily have
Tcl
handles, so there may be a discrepancy between this value and the result list length of the
table list
command.
-
cactvs(table_support)
A read-only boolean flag indicating whether this application was compiled with support for the chemistry-aware table object, and the associated
table
and
tablex
commands.
-
cactvs(table_swap_threshold)
Maximum size of datasets embedded in tables before disk swapping of contained objects is automatically performed. The default value is 10000. A negative value disables automatic disk swapping. This object-specific control value overrides the generic
dataset
object swap threshold in
cactvs(dataset_swap_threshdold)
.
-
cactvs(tablexpath)
The search path for table I/O module extensions
-
cactvs(tcl_error_message)
The last
Tcl
error message generated by the interpreter. This is a read-only element, and thread-local.
-
cactvs(tcl_support)
A read-only boolean flag indicating whether this interpreter support
Tcl
as scripting language. If seen from the
Tcl
side, this is obviously always true, but there may be
Python
-only interpreters where this flag is not set.
-
cactvs(testdatapath)
The search path for test data associated with extension modules for self-tests.
-
cactvs(test_interpreter)
The name of a
Tcl
slave interpreter which has been set up for regression testing. Usually an empty string and not used in user applications.
-
cactvs(thread_count)
The current number of threads registered with the core library. This value cannot exceed the upper limit compiled into the toolkit, which can be learned from
::cactvs(max_threads).
-
cactvs(thread_support)
A read-only boolean flag indicating whether the core library supports multiple threads. This is not equivalent tot he
multithreaded
flag, which indicates that multi-threaded
Tcl
script interpreters are supported. There are configurations which do not allow multiple parallel scripts, but support implicit multi-threading on operations such as file scanning from a single Tcl interpreter.
-
cactvs(timezone)
The current time zone in minutes west of GMT. This is used when setting up and storing time/date values. If the system clock is on GMT time, the value is always zero.
-
cactvs(tk_support)
A read-only boolean flag indicating whether this interpreter supports the
Tk
graphical toolkit as a compiled-in module. If not set, it is still possible to load
Tk
as dynamic module with the standard
load
or
package
Tcl
commands.
-
cactvs(tmpdir)
The name of the directory for temporary files. This path can be changed if desired. By default it is the standard system temp directory.
-
cactvs(tokyocabinet_support)
A read-only boolean attribute indicating support of the Tokyo Cabinet key/value store. It this is available, the default object swap store is a Tokyo Cabinet file (instead of
gdbm
or separate native binary object serialization files), and the
tc
Tcl
command extension module is present. Currently, the Windows version of the
Cactvs
suite does not support Tokyo Cabinet.
-
cactvs(trace)
A bit combination of flags to trace various subsystems. Symbolic names for the subsystems are translated into the proper bit. Example:
set cactvs(trace) ss
traces substructure matching.
-
cactvs(tre_support)
A read-only boolean flag indicating whether this interpreter supports extended regular expressions, and approximate regular expressions by means of the
Tre
library. If it is not set, only standard
PCRE/Perl
regular expressions are supported.
-
cactvs(trusted_executable_directory)
The name of a directory which contain only trusted executables which may be invoked by the toolkit. Usually, this is the installation directory for executables bundled with the toolkit.
-
cactvs(trusted_objectpath)
A search path for trusted shared libraries, OSX bundles and Windows DLLs implementing extension modules. Depending on the extension loaded mode, objects in this path may still be loaded even if the loading of modules from the full set of search paths is disabled. See also :
:cactvs(dynamic_loaded_mode)
.
-
cactvs(trusted_scriptpath)
A search path for sources of trusted scripts. Scripts from this source may be loaded and executed even if normal script auto-loading is disabled.
-
cactvs(typexpath)
The search path for handlers of additional data types.
-
cactvs(use_bad_property_cache)
If this boolean flag is set, the toolkit remembers property names for which the look-up of property definition records failed. Since the look-up path can involved lengthy database searches and Internet accesses, this flag can in some cases prevent poor performance because of repeated failure to identify the same property name. On the other hand, if this flag is set, adding a new property definition during the runtime of an application after a look-up for this new property has failed has no effect and such a property definition needs to be loaded explicitly.
-
cactvs(use_reference_objects)
A flag indicating what type of
Tcl
interpreter data value objects are used for toolkit objects. The default value of zero indicates that object handles obtained from earlier commands are strings which are decoded when a command is executed. A value of one indicates that the interpreter objects are actually wrappers for pre-resolved pointers. Using reference objects speeds up scripts, but slightly changes the pattern of handle allocations, and under many circumstances requires extra memory because toolkit objects remain in a zombie state until all interpreter reference objects have been reclaimed.
-
cactvs(user_affiliation)
The company, university or other institution the user is working for. This information is used in pre-setting various header data blocks. The veracity of this item is not checked.
-
cactvs(user_email)
The e-mail address of the user, initially guessed by the library. This information is used in pre-setting various header data blocks, and also for Web data sources which require some identification. The veracity of this item is not checked.
-
cactvs(user_id)
The current system user name, as extracted from the login data or similar sources. Read only.
-
cactvs(user_name)
The full name of the user, if it could be determined. Works reliably only on IRIX. This information is used in pre-setting various header data blocks. The veracity of this item is not checked.
-
cactvs(uuid_support)
A read-only flag indicating whether the toolkit was compiled with support for handling and generating UUIDs. This is usually true.
-
cactvs(value_buffer_size)
The maximum size of a single property data element may request when it is converted to a string. Normally set to something big like 256K, but can be reduced to cope with external tools which have maximum line sizes, etc.
-
cactvs(version)
Version number of the
Cactvs
toolkit. Read only.
-
cactvs(wedge_interpretation)
This attribute can be used to switch the stereochemical interpretation of wedge bonds. The default model is
cactvs
, the other possible value is
idbs
for compatibility with
IDBS
software. In
Cactvs
mode, the stereo center is always at the wedge tips. In
IDBS
mode, bonds which go down have the wedge base at the stereo center. This flag also changes the style of generated wedges in 2D layouts (properties
A_XY
and
B_FLAGS
).
-
cactvs(wrapper)
A read-only string which holds the name of a wrapper program (usually a Bourne shell or
MSDOS
script) invoking the interpreter, and possibly also setting a program script as hidden argument. For standard
Cactvs
installations, these are the
cs??
scripts. In case a raw interpreter without a wrapper is run, this string is empty.
-
cactvs(xdr_support)
A read-only boolean attribute which indicates whether this application supports
XDR
-based
Cactvs
object streams. This feature is required for native
Cactvs
file I/O, handling serialized packed object strings, the object swap store, and other toolkit functions.
-
cactvs(xml_support)
A read-only boolean attributes which indicates whether the application was compiled with an integrated
XML
parser. This affects the availability of the
soap
command, as well as support for various
XML
-based chemical structure and reaction or table data file formats.