intro_acl_intrinsic_functions
ACL Intrinsic functions (grouped by topic):
Arithmetic functions:
log - base 10 log
ln - natural log
sqrt - square root
sin - sine
sind - sine (argument in degrees)
cos - cosine
cosd - cosine (argument in degrees)
tan - tangent
tand - tangent (argument in degrees)
asin - arc sine
asind - arc sine (result in degrees)
acos - arc cosine
acosd - arc cosine (result in degrees)
atan - arc tangent
atand - arc tangent (result in degrees)
atan2 - arc tangent of the quotient of the arguments
atan2d - arc tangent of the quotient of the arguments
(result in degrees)
sinh - hyperbolic sine
cosh - hyperbolic cosine
tanh - hyperbolic tangent
asinh - arc hyperbolic sine
acosh - arc hyperbolic cosine
atanh - arc hyperbolic tangent
secant - secant
cosecant - cosecant
cotan - cotangent
cotand - cotangent (argument in degrees)
hypot - square root of the sum of the squares of the arguments
round - round (to a specified number of digits)
ceil - smallest integer greater than or equal to its argument
floor - largest integer less than or equal to its argument
trunc - truncate
fmod - remainder of the arguments
fract - fractional component
abs - absolute value
min - minimum of two values
max - maximum of two values
exp - base e exponentiation (e^n)
isInfinity - tests to see if a value is infinite
isNaN - tests to see if a value is a NaN
Bitwise functions:
or - bitwise or
and - bitwise and
xor - bitwise exclusive or
lshft - circular left shift
rshft - circular right shift
bit - bit test
setBit - set a bit in a value
clearBit - clear a bit in a value
bitComplement - complement (invert) bits in a value
bitField - extracts a bit field value
deviceBitField - extracts a bit field value from a device reading
setBitField - sets a bit field value
circularShift - bit field circular shift
bitCount - returns the number of bits set in a value
lowestBit - returns the lowest bit set in a value (or -1)
highestBit - returns the highest bit set in a value (or -1)
valueToLogicalArray - converts bit values into a logical array
Array value functions:
sum - sum of an array of values
mean - mean of an array of values
median - median of an array of values
minimum - minimum of an array of values
maximum - maximum of an array of values
range - range of an array of values
stddev - standard deviation of an array of values
rms - RMS of an array of values
variance - variance of an array of values
mode - returns the most commonly occurring value in an array
(If there are multiple mode values, the smallest
value is returned.)
identical - checks to see if all values in an array are identical
histogram - divides an array of values into buckets
String functions:
head - returns the beginning of a string
tail - returns the end of a string
substring - returns a substring of a string
strncmp - compares the first n characters of two strings
trim - removes leading and trailing blanks from a string
leftTrim - removes leading blanks from a string
rightTrim - removes trailing blanks from a string
case - changes the case of a string
toUpper - converts a string to upper case
toLower - converts a string to lower case
capitalize - capitalizes the first character in each word of
a string
toString - converts a value to its corresponding string
toTrimmedString - converts a value to a string with no spaces
stringCopy - copies one string to another
stringSetChar - overwrite a substring of one string with another
(similar to stringCopy)
stringGetChar - retrieve a substring from a string
(similar to substring but with different defaults)
stringConcatenate - concatenate two strings
stringCompare - compares one string to another (case sensitive)
stringCompareNocase - compares one string to another (case insensitive)
regexpCompareString - compares a string to a pattern (case sensitive)
regexpCompareStringNocase - compares a string to a pattern
sprintf - formats output strings like sprintf with the
additional functionality of toString
formatDateString - format a date string using the format specifiers
in strftime
sscanf - functions like sscanf with the additional
functionality of toNumeric
toNumeric - converts a string to its numeric value
stringToDouble - converts a string to a double precision
floating point value
stringToInteger - converts a string to an integer
stringLength - returns the length of a string
delimitedStringLength - returns the length of a string using delimiters
nonblankLength - returns the nonblank length of a string
findChar - returns the first location of one of a set
of characters in a string
findNotChar - returns the first location of a character which is
not a member of a set of characters in a string
getFirstChar - retrieve the first or last nonblank character
getLastChar - retrieve the last nonblank character in a string
firstCharPos - find the first or last nonblank character position
lastCharPos - find the last nonblank character position in a string
characterCount - returns the number of characters in a string
wordCount - returns the number of words in a string
findString - returns the position of one string within another
regexpFindString - returns the position of one string within another
using regular expressions for the search
stringStartsWith - determines if a string starts/ends with a substring
stringEndsWith - determines if a string ends with a substring
insertString - inserts a string within another string
replaceString - replaces one string with another string in a string
regexpReplaceString - replaces one string with another string in a
string using regular expressions for the search
replaceBracketedString - replace a bracketed substring
replaceChar - replaces any of a set of characers wih another
character
split - splits up a string based upon finding a delimiter
string
regexpSplit - splits up a string based upon finding a delimiter
string which is a regular expression
splitByCharSet - splits up a string based upon finding any of a
set of delimiter characters
stringToken - returns the next token from a string and removes
it from the original string
stringGetValue - returns the next token of the specified type from
a string and removes it from the original string
stringType - returns a string describing the argument string's
type
pos - pads with spaces/truncates a string to a specified
length
pad - pads a string with a specified character to a
specified length
justify - left justify, right justify, or center a string
center - center a string
leftJustify - left justify a string
rightJustify - right justify a string
strShift - left or right shift a string
leftShift - left shift a string
rightShift - right shift a string
reverse - reverses a string
repeatString - repeats a substring a number of times
decimal - returns a value as a decimal string
hex - returns a value as a hexadecimal string
binary - returns a value as a binary string
octal - returns a value as an octal string
radix - returns a value as an arbitrary radix (2-36) string
stripSpaces - strips any whitespace from a string
stripCharacters - strips a requested set of characters from a string
stripEolCharacters - strips end of line characters from a string
stripNonprintables - strips nonprintable characters from a string
stripHtml - strips HTML tags from a string
stripBrackets - strips beginning and ending brackets from a string
stripQuotes - strips beginning and ending quotes from a string
quoteString - adds beginning and ending quotes to a string
unescapeString - replaces escape characters in a string with
their original characters
escapeString - replaces characters in a string with their
corresponding escape characters
findTagString - finds and extracts delimited tags from a string
getTaggedValue - extracts a tag/value pair from a string
makePrintable - expand any tabs and remove or replace any
nonprintable characters in a string
isLowerCase - determines whether or not a string is in all
lower case characters
isUpperCase - determines whether or not a string is in all
upper case characters
isQuotedString - determines whether or not a string is quoted
isBracketedString - determines whether or not a string is bracketed
isAlphabeticString - determines whether or not a string is composed
entirely of alphabetic characters (plus optional
white space)
isAlphanumericString - determines whether or not a string is composed
entirely of alphanumeric characters
(plus optional white space)
isBlankString - determines whether or not a string is composed
entirely of white space
isFloatString - determines whether or not a string represents
a floating point number
isIntegerString - determines whether or not a string represents
an integer number
isHexString - determines whether or not a string represents
a hexadecimal number
isPrintableString - determines whether or not a string is composed
entirely of printable characters
isStringFilledWithChar - determines whether or not a string is
composed entirely of a single character
isDeviceString - determines whether or not a string represents
a device specification
isPropertyString - determines whether or not a string is a
device property name
isNodeString - determines whether or not a string is a
node name
isErrorString - determines whether or not a string is
an error name
isEventString - determines whether or not a string
represents a clock event
isDateString - determines whether or not a string
represents a date
isRad50String - determines whether or not a string is
composed entirely of valid rad50 characters
stringLineInfo - determines how many lines are in a string
stringExtractLine - extract a line from a string
consoleClassMaskToString - convert a console class mask to a string
stringToConsoleClassMask - converts a string to a console class mask value
Data manipulation functions:
arrayInvert - inverts the order of an array
arrayInsert - inserts a new element in an array
arrayAppend - append a new entry at the end of an array
arrayPrepend - insert a new entry at the beginning of an array
arrayDelete - deletes an existing entry from an array
arrayDeleteDuplicates - deletes duplicate entries from an array
arrayFill - fill an array with a value
compareWithTolerance - compares one or more values with another
with a tolerance
Device oriented functions:
device - converts an ACNET device to a device index value
deviceIndex - converts an ACNET device to a device index value
deviceSpec - converts a value to a device specification
name - returns a device name string
fullName - returns a device full name string
text - returns a device descriptive text string
fullText - returns a device full descriptive text string
units - returns a device units string
deviceValue - returns a numeric device value
deviceValueText - returns a device value as a string
deviceDigitalStatus - returns a device digital status value
deviceType - returns the type of a device property
hasProperty - determines whether or not a device has a
specified property
hasReading - determines whether or not a device has a
reading property
hasSetting - determines whether or not a device has a
setting property
hasStatus - determines whether or not a device has a
status property
hasControl - determines whether or not a device has a
control property
hasAnalogAlarm - determines whether or not a device has an
analog alarm property
hasDigitalAlarm - determines whether or not a device has a
digital alarm property
stateText - returns the text for a state of a state device
deviceNode - returns the source node for a device property
deviceDefaultLength - returns the default length of a device property
in bytes
deviceAtomicLength - returns the atomic length of a device property
in bytes
deviceMaximumLength - returns the maximum length of a device property
in bytes
deviceScalingLength - returns the scaling length of a device property
in bytes
deviceState - returns the state of a device
(valid, obsolete, or invalid)
isObsoleteDevice - determines whether or not a device is obsolete
isArrayDevice - determines whether or not a device/property
is an array
isStructureDevice - determines whether or not a device/property
is a structure
deviceDigitalStatus - returns a device digital status value
deviceDownloadProperties - returns the download properties associated
with a device
deviceIsDownloaded - determines if a device property is downloaded
upon front end reboot
deviceProperties - returns the properties associated with a device
numReadableProperties - returns the number of readable properties for
a device (optionally also returns the array
of properties)
numSettableProperties - returns the number of settable properties for
a device (optionally also returns the array
of properties)
deviceSsdn - returns the SSDN for a device property
deviceEmc - returns the EMC for a device property
deviceSsdr - returns the SSDR for a device
deviceProtectionMask - returns the device setting protection mask
deviceAlarmList - returns the device alarm list
deviceAlarmGroupInfo - returns device alarm group information
previousSibling - returns the device's previous sibling (or 0)
nextSibling - returns the device's next sibling (or 0)
controllingDevice - returns the device's controlling device (or 0)
bitText - returns the descriptive text for a specified bit
bitTextAll - returns the bit information for a device
bitDataText - returns the data text for a specified bit
analogAlarmText - returns the analog alarm text for a device
analogAlarmPriority - returns the analog alarm priority for a device
digitalAlarmText - returns the digital alarm text for a device
digitalAlarmTextAll - returns all of the digital alarm text for
a device
deviceCurrentAlarmText - returns the current alarm text for a device
ftpMaxFreq - returns the maximum fast time plot frequency
for a device or plot class
snapshotMaxFreq - returns the maximum snapshot plot frequency
for a device or plot class and optionally
the number of points as well
deviceStructureName - returns the structure name for a device property
deviceExpression - returns the expression for a device
deviceDepartment - returns the department responsible for a device
deviceMaintainer - returns the person responsible for
maintaining a device
alarmAcknowledgeMask - returns a device's alarm acknowledge mask
deviceCreator - returns the user who created a device
deviceCurrentAlarmText - returns the current alarm text for a device
deviceLastModifier - returns the user who last modified a device
deviceLastModifiedDate - returns the date when a device was last
modified
stringToDeviceName - finds device names matching a search string
deviceNameToFullName - returns the full device name corresponding
to a name
deviceFullNameToName - returns the device name corresponding to a
full name
deviceIsSettableByClass - determines if a device can be set by a
console class
alarmBlockFieldValue - returns individual alarm block field values
deviceVirtualMachine - returns device virtual machine information
deviceNodeType - returns the node type for a device property
isIrmDevice - determines whether a device property is
sourced by an IRM node
isLabviewDevice - determines whether a device property is
sourced by a LabView node
isMoocDevice - determines whether a device property is
sourced by a MOOC node
isOacDevice - determines whether a device property is
sourced by an OAC
isAcsysFefDevice - determines whether a device property is
sourced by an Acsys/FEF node
cacheDeviceInfo - cache device database information for
later retrieval
deviceFamilyMembers - returns the members of a family device
deviceInFamilies - returns families that a device is a member of
deviceInCompositeDevices - returns composite devices which use a
given device
deviceControlledDevices - returns the devices controlled by a device
virtualMachineDevices - returns the devices belonging to a
virtual machine
deviceListing - creates formatted device information strings
deviceListToDevices - retrieves the devices from a device list
duplicateSsdnProperties - returns any duplicate SSDN properties
to a given property on the same node
deviceParameterPageMapping - returns device parameter page mapping
instances
fileDevices - returns the devices specified in a file
sqlQueryDevices - returns devices from a SQL query
userAlarmListDevices - returns the devices in a user alarm list
userSaveListDevices - returns the devices in a user save list
downloadDevices - returns front end download devices
parameterPageDevices - returns the devices on a parameter page
lexSaDevices - returns devices in a Lex SA display
synopticDevices - returns devices in a Synoptic display
Device search functions:
genericDeviceSearch - searches for devices matching various parameters
deviceNameSearch - searches for all devices whose names match
a string
deviceFullNameSearch - searches for all devices whose full names
match a string
deviceDescriptionSearch - searches for all devices whose descriptions
match a string
deviceFullDescriptionSearch - searches for all devices whose full
descriptions match a string
deviceNodeSearch - searches for all devices from a given node
deviceSsdnSearch - searches for all devices whose SSDNs match
a pattern
Device scaling functions:
deviceRawToScaled - scale a raw device value
deviceRawToScaledCustom - scale a raw device value using
caller-supplied scaling parameters
deviceRawToHistoricScaled - scale a raw device value using historic
scaling
deviceRawToValueText - scale a raw value to its corresponding
string
deviceRawToValueTextCustom - scale a raw value to its corresponding
string using caller-supplied scaling
deviceScaledToRaw - convert a scaled device value to a raw value
deviceScaledToRawCustom - reverse scale a scaled device value using
caller-supplied scaling parameters
deviceRawToStatusText - scale a raw status value to a text string
deviceRawToStatusValue - scale a raw status value to a boolean
attribute value
deviceRawToControlText - scale a raw control value to a text string
deviceRawToEnumText - scale a raw enumerated reading value
to a text string
devicePrimaryToScaled - scales a primary device value
deviceScaledToPrimary - convert a scaled device value to
a primary value
devicePrimaryToScaledCustom - scale a primary device value using
caller-supplied scaling parameters
deviceReadSetScaling - return reading or setting scaling
information
deviceReadSetExtScaling - return extended reading or setting scaling
information
deviceReadSetHistoricScaling - return reading or setting historic
scaling information
deviceStatusScaling - returns status scaling information
for a device
deviceStatusScalingAll - returns all status scaling information for
a device
hasStatusAttribute - determines whether or not a device has a
status attribute
digitalControlInfo - returns digital control info for a device
digitalControlInfoAll - returns all of the digital control info
for a device
hasControlAttribute - determines whether or not a device has
a control attribute
deviceControlAttributes - returns the control attributes for a device
Time functions:
stringToDate - converts a string to a date value
dateToString - converts a date value to a string
convertSeconds - converts dates in seconds between date types
julianDate - converts a date value to a julian date
julianDateToDate - converts a julian date value to a date
15hzCount - returns 15Hz count since the calling process
started
millisecondsNow - returns the current time in milliseconds
since the Epoch
currentTime - current time in seconds and milliseconds
since the Epoch
currentTimeInClinks - current time in seconds and milliseconds
since January 1, 1972 00:00 CST
systemTime - returns system time in milliseconds since
ACL was initialized
cpuTime - returns CPU time in milliseconds since
ACL was initialized
timeAgo - returns date which is some number of
time units before a base time
timeFromDate - returns date which is some number of
time units after a base time
localtime - break down a date value into its component
values
Clock event functions:
eventOccurred - determines if a clock event has occurred
clearEventOccurred - clear the detection status for a clock event
timeSinceEvent - returns the elapsed time since an event
has occurred
eventDate - returns the date in clinks when an event last
occurred
eventCount - returns the current count for an event
Save/restore file functions:
oldestSrFile - returns the oldest save/restore file number
newestSrFile - returns the newest save/restore file number
saveFileInfo - returns information about a single save/restore
file
SDA functions:
currentSdaFile - returns the current SDA file number for a given
usage
dateToSdaFile - returns the SDA file number corresponding to
a given date
sdaFileDate - returns the starting or ending date for an
SDA file
isValidSdaFile - determines whether or not a value is a valid
SDA file number (file instance actually exists)
isValidSdaCase - determines whether or not a value is a valid
SDA case (case instance actually exists)
isValidSdaSet - determines whether or not a value is a valid
SDA set (set instance actually exists)
Node oriented functions:
node - converts a node name to a value
nodeIs - determines whether or not the specified
node has a particular status or type
nodeIsUp - determines whether or not the specified
node is up
nodeAttributeValue - returns ACNET node attribute values
cacheNodeInfo - cache node database information for
later retrieval
ipNameToNode - converts an IP name to an ACNET node value
trunkNodeToNode - converts a trunk and node number into a
node value
nodeToTrunkNode - converts an ACNET node value to its component
trunk and node number
nodeAcnetTasks - retrieves the ACNET tasks for a given node
isIrmNode - determines whether a node is an IRM node
isLabviewNode - determines whether a node is a LabView node
isMoocNode - determines whether a node is a MOOC node
isOacNode - determines whether a node is an OAC node
isAcsysFefNode - determines whether a node is an Acsys/FEF node
acnetPing - performs an ACNET ping on a node
coresidentNodes - returns the coresident nodes on an ACNET node
loggersOnNode - returns the data loggers running on an
ACNET node
oacsOnNode - returns the names of OACs running on an
ACNET node
nodeConsolidator - returns the consolidating node(s) for a node
Console oriented functions:
consoleExists - determines whether or not a specified
console exists (is defined) (may not be running)
consoleIsUp - determines whether or not a specified
console is running
consoleSlotExists - determines whether or not a console slot exists
consoleProcessName - retrieves the name of a console process
running in a specified console and slot
consoleTaskName - returns a console slot specific task name
consoleToNode - converts a console number to its corresponding
ACNET node
consoleToInstance - converts a console number to its corresponding
instance
findConsoleWindowTitle - find console window titles matching a string
File oriented functions:
fileExists - determines whether or not a file exists
fileLength - returns the length of a file in bytes
fileDate - returns the date of a file
fileOwner - returns the owner of a file
fileOwnerId - returns the owner ID for a file
filePermissions - returns the complete file permission set
for a file
fileHasPermission - returns a specific permission for a file
fileCopy - copies an existing file
(requires file copy privilege)
fileRename - renames an existing file
(requires file rename privilege)
fileDelete - deletes an existing file
(requires file delete privilege)
openFile - opens a file for reading and/or writing
closeFile - closes a file opened by an earlier call to
openFile
fileGetString - reads a string from a file opened by openFile
filePrintf - functions like fprintf with the additional
functionality of toString
printf - functions like printf with the additional
functionality of toString
printfNoNewline - functions like printf with the additional
functionality of toString (no newline added)
fscanf - functions like fscanf with the additional
functionality of toNumeric
fileRead - reads binary values from a file
fileRewind - rewinds a file to its beginning
fileWrite - writes binary values to a file
parseFileName - parses a file name into its component pieces
expandFileName - expands a file name starting with a tilde (~)
fileDirectory - returns file names for a directory
findInFile - searches for a text string in a file
findFileInPath - determines whether a file name points to an
existing file
fileNumLines - returns the number of lines (also characters
and words) in a file
fileFlush - flush any unwritten information to the file
flushOutputFile - flush any unwritten information to an
output file
flushLogFile - flush any unwritten information to the log file
Program environment functions:
myConsole - returns the caller's console number
myConsoleClass - returns the caller's console class
myConsoleInstance - returns the caller's console instance number
myConsoleSlot - returns the caller's console slot
myExecutableName - returns the caller's executable name
myHostName - returns the caller's host name
myNode - returns the caller's ACNET node
myProcessName - returns the caller's process name
myGenericProcessName - returns the caller's generic process name
mySystemInfo - returns basic system information
myUserName - returns the caller's user name
Data logger functions:
oldestLoggerTime - returns the oldest timestamp for a logged device
loggerNameToNode - converts a data logger name to its
corresponding node
nodeToLoggerName - convert a node value to a data logger name
loggerListInfo - returns general logger list information
loggerListDeviceStats - returns logger list device configuration stats
loggerListWrapTime - returns a logger list wrap time in hours
whereDeviceIsLogged - returns where a device is logged
whereDeviceWasLogged - returns where a device was logged in the past
allLoggerNodes - returns the names of all data loggers
loggerListDevices - returns the devices in a data logger list
MISCELLANEOUS functions:
exists - determines if a device or variable/symbol exists
sizeof - returns the number of elements in a device,
device list, input, or variable
byteSizeof - returns the size of a device or variable
in bytes (static)
sizeofVariable - returns the number of elements in a variable
byteSizeofVariable - returns the size of a variable in bytes
numElements - returns the number of elements in a variable
or a device specification
byteCompare - performs a byte comparison of two values
byteCopy - performs a byte copy of one value to another
condif - returns the second argument if the first has a
value of true or the third argument if it has
a value of false
scondif - returns the second argument as a string if the
first has a value of true or the third argument
as a string if it has a value of false
lor - logical or
land - logical and
floatToBinary - converts a single precision floating point
value to its equivalent binary value
binaryToFloat - converts a binary value to its equivalent
single precision floating point value
cast - return the equivalent value to a value
castDouble - return the equivalent double precision value
to a value
castFloat - return the equivalent single precision value
to a value
castInteger - return the equivalent integer value to a value
castLogical - return the equivalent logical (boolean) value
to a value
castLongLong - return the equivalent long integer value
to a value
castUnsignedInt - return the equivalent unsigned integer value
to a value
castUnsignedLongLong - return the equivalent unsigned long integer
value to a value
bcdToString - convert a BCD-encoded value into decimal string
bcdToDecimal - convert a BCD-encoded value into decimal integer
random - returns pseudo random numbers from 0 to 2^31 - 1
randomSeed - sets the seed value for the random function
prec - output precision
(eg. prec(value,fraction_digits))
stringToRad50 - convert a string to a radix 50 value
rad50ToString - converts a radix 50 value to a string
stringToColor - converts a string to a color value
stringToProperty - converts a string to a property value
stringToConvertType - converts a string to a convert type value
convertTypeToString - converts a convert type value to a string
totalNumberOfDevices - returns the total number of devices in the
control system
ssdnToString - converts an SSDN value to a standard string
stringToSsdn - converts a string to an SSDN value
emcToString - converts an EMC value to a standard string
stringToEmc - converts a string to an EMC value
timer - returns the current value of a timer
error - converts an ACNET error string to a value
errorToFacilityError - converts an ACNET error value to its component
facility and error number
userAlarmList - returns the state of a user alarm list
(enabled, bypassed, or empty)
setUserAlarmListStatus - sets the status of a user alarm list
settingsAreEnabled - determines if settings are enabled
(supports optional device name argument)
getLogicalName - returns the string corresponding to a
logical name
setLogicalName - sets a logical name to a value
deleteLogicalName - deletes a logical name
getenv - returns the string corresponding to an
environment variable
setenv - sets an environment variable to a value
delenv - deletes an environment variable
readLock - retrieves information about a lock
readProgramLocks - retrieves the locks held by a program
consoleSlotToWindow - convert a console slot to a primary window ID
consoleWindowToSlot - convert a console window ID to a slot
playBeep - plays a beep sound
playSound - plays an existing sound file
taskExists - determines if an ACNET task exists
taskId - returns an ACNET task ID
taskPid - returns an ACNET task process ID
taskIdToName - converts an ACNET task ID to a name
taskPidToName - converts an ACNET task process ID to name(s)
isServerTask - determines whether or not an ACNET task is
a server
processExists - determines if a process exists
processInfo - retrieves information about a process
consoleUserNameToFullName - converts a console user name to a full name
fullNameToConsoleUserName - converts a full name to a console user name
pageTitle - returns the title for a page
programMapping - returns the pages that a program is mapped to
concatenateStringArguments - concatenate the script string arguments
fshareFileInfo - returns information about a Filesharing file
genericStructInfo - returns information about a generic structure
appdsTableInfo - returns information about an APPDS table
feClassInfo - returns front end device class information
feSsdnClassLocation - returns the byte index of the device class
in an SSDN
stepMotorIsMoving - determines whether or not a stepping motor
is currently moving
networkServiceToPort - converts a network service name to a port
snapManagerDataDirectory - returns snapshot manager data file
information
dipoleThreeBumpInfo - returns dipole three bump information
dipoleFourBumpInfo - returns dipole four bump information
gifImageSize - determines the dimensions of a GIF image
Debugging functions:
variableNumReadings - returns the number of times a variable
has been read
variableNumSettings - returns the number of times a variable
has been set
variableType - returns the type of a variable as a string
valueType - returns the type of a value as a string
ifLevel - returns the current 'if' level of the script
loopLevel - returns the current loop level of the script
ACL Intrinsic functions (alphabetic order):
15hzCount - returns 15Hz count since the calling process started
abs - absolute value
acnetPing - performs an ACNET ping on a node
acos - arc cosine
acosd - arc cosine (result in degrees)
acosh - arc hyperbolic cosine
alarmAcknowledgeMask - returns a device's alarm acknowledge mask
alarmBlockFieldValue - returns individual alarm block field values
allLoggerNodes - returns the names of all data loggers
analogAlarmPriority - returns the analog alarm priority for a device
analogAlarmText - returns the analog alarm text for a device
and - bitwise and
appdsTableInfo - returns information about an APPDS table
arrayAppend - append a new entry at the end of an array
arrayDelete - deletes an existing entry from an array
arrayDeleteDuplicates - deletes duplicate entries from an array
arrayFill - fill an array with a value
arrayInsert - inserts a new element in an array
arrayInvert - inverts the order of an array
arrayPrepend - insert a new entry at the beginning of an array
asin - arc sine
asind - arc sine (result in degrees)
asinh - arc hyperbolic sine
atan - arc tangent
atan2 - arc tangent of the quotient of the arguments
atan2d - arc tangent of the quotient of the arguments
(result in degrees)
atand - arc tangent (result in degrees)
atanh - arc hyperbolic tangent
bcdToDecimal - convert a BCD-encoded value into decimal integer
bcdToString - convert a BCD-encoded value into decimal string
binary - returns a value as a binary string
binaryToFloat - converts a binary value to its equivalent
single precision floating point value
bit - bit test
bitComplement - complement (invert) bits in a value
bitCount - returns the number of bits set in a value
bitDataText - returns the data text for a specified bit
bitField - extracts a bit field value
bitText - returns the descriptive text for a specified bit
bitTextAll - returns the bit information for a device
byteCompare - performs a byte comparison of two values
byteCopy - performs a byte copy of one value to another
byteSizeof - returns the size of a device or variable in bytes (static)
byteSizeofVariable - returns the size of a variable in bytes
cacheDeviceInfo - cache device database information for later retrieval
cacheNodeInfo - cache node database information for later retrieval
capitalize - capitalizes the first character in each word of a string
case - changes the case of a string
cast - return the equivalent value to a value
castDouble - return the equivalent double precision value to a value
castFloat - return the equivalent single precision value to a value
castInteger - return the equivalent integer value to a value
castLogical - return the equivalent logical (boolean) value to a value
castLongLong - return the equivalent long integer value to a value
castUnsignedInt - return the equivalent unsigned integer value
to a value
castUnsignedLongLong - return the equivalent unsigned long integer
value to a value
ceil - smallest integer greater than or equal to its argument
center - center a string
characterCount - returns the number of characters in a string
circularShift - bit field circular shift
clearBit - clear a bit in a value
clearEventOccurred - clear the detection status for a clock event
closeFile - closes a file opened by an earlier call to openFile
compareWithTolerance - compares one or more values with another
with a tolerance
concatenateStringArguments - concatenate the script string arguments
condif - returns the second argument if the first has a value of
true or the third argument if it has a value of false
consoleClassMaskToString - convert a console class mask to a string
consoleExists - determines whether or not a specified console exists
(is defined) (may not be running)
consoleIsUp - determines whether or not a specified console is running
consoleProcessName - retrieves the name of a console process running
in a specified console and slot
consoleSlotExists - determines whether or not a console slot exists
consoleSlotToWindow - convert a console slot to a primary window ID
consoleTaskName - returns a console slot specific task name
consoleToInstance - converts a console number to its corresponding
instance
consoleToNode - converts a console number to its corresponding
ACNET node
consoleUserNameToFullName - converts a console user name to a full name
consoleWindowToSlot - convert a console window ID to a slot
controllingDevice - returns the device's controlling device (or 0)
convertSeconds - converts dates in seconds between date types
convertTypeToString - converts a convert type value to a string
coresidentNodes - returns the coresident nodes on an ACNET node
cos - cosine
cosd - cosine (argument in degrees)
cosecant - cosecant
cosh - hyperbolic cosine
cotan - cotangent
cotand - cotangent (argument in degrees)
cpuTime - returns CPU time in milliseconds since ACL was initialized
currentSdaFile - returns the current SDA file number for a given usage
currentTime - current time in seconds and milliseconds since the Epoch
currentTimeInClinks - current time in seconds and milliseconds
since January 1, 1972 00:00 CST
dateToSdaFile - returns the SDA file number corresponding to a
given date
dateToString - converts a date value to a string
decimal - returns a value as a decimal string
delenv - deletes an environment variable
deleteLogicalName - deletes a logical name
delimitedStringLength - returns the length of a string using delimiters
device - converts an ACNET device to a device index value
deviceAlarmGroupInfo - returns device alarm group information
deviceAlarmList - returns the device alarm list
deviceAtomicLength - returns the atomic length of a device property
in bytes
deviceBitField - extracts a bit field value from a device reading
deviceControlAttributes - returns the control attributes for a device
deviceControlledDevices - returns the devices controlled by a device
deviceCreator - returns the user who created a device
deviceDefaultLength - returns the default length of a device property
in bytes
deviceDepartment - returns the department responsible for a device
deviceDescriptionSearch - searches for all devices whose descriptions
match a string
deviceDownloadProperties - returns the download properties associated
with a device
deviceEmc - returns the EMC for a device property
deviceExpression - returns the expression for a device
deviceFamilyMembers - returns the members of a family device
deviceFullDescriptionSearch - searches for all devices whose full
descriptions match a string
deviceFullNameSearch - searches for all devices whose full names
match a string
deviceFullNameToName - returns the device name corresponding to a
full name
deviceInCompositeDevices - returns composite devices which use a
given device
deviceIndex - converts an ACNET device to a device index value
deviceInFamilies - returns families that a device is a member of
deviceIsDownloaded - determines if a device property is downloaded
upon front end reboot
deviceIsSettableByClass - determines if a device can be set by a
console class
deviceLastModifiedDate - returns the date when a device was last
modified
deviceLastModifier - returns the user who last modified a device
deviceListing - creates formatted device information strings
deviceListToDevices - retrieves the devices from a device list
deviceMaintainer - returns the person responsible for
maintaining a device
deviceMaximumLength - returns the maximum length of a device property
in bytes
deviceNameSearch - searches for all devices whose names match a string
deviceNameToFullName - returns the full device name corresponding
to a name
deviceNode - returns the source node for a device property
deviceNodeSearch - searches for all devices from a given node
deviceNodeType - returns the node type for a device property
deviceParameterPageMapping - returns device parameter page mapping
instances
devicePrimaryToScaled - scales a primary device value
devicePrimaryToScaledCustom - scale a primary device value using
caller-supplied scaling parameters
deviceProperties - returns the properties associated with a device
deviceProtectionMask - returns the device setting protection mask
deviceRawToControlText - scale a raw control value to a text string
deviceRawToEnumText - scale a raw enumerated reading value to a
text string
deviceRawToHistoricScaled - scale a raw device value using historic
scaling
deviceRawToScaled - scale a raw device value
deviceRawToScaledCustom - scale a raw device value using
caller-supplied scaling parameters
deviceRawToStatusText - scale a raw status value to a text string
deviceRawToStatusValue - scale a raw status value to a
boolean attribute value
deviceRawToValueText - scale a raw value to its corresponding string
deviceRawToValueTextCustom - scale a raw value to its corresponding
string using caller-supplied scaling
deviceReadSetExtScaling - return extended reading or setting scaling
information
deviceReadSetHistoricScaling - return reading or setting historic
scaling information
deviceReadSetScaling - return reading or setting scaling information
deviceScaledToPrimary - convert a scaled device value to
a primary value
deviceScaledToRaw - convert a scaled device value to a raw value
deviceScaledToRawCustom - reverse scale a scaled device value using
caller-supplied scaling parameters
deviceScalingLength - returns the scaling length of a device property
in bytes
deviceSpec - converts a value to a device specification
deviceSsdn - returns the SSDN for a device property
deviceSsdnSearch - searches for all devices whose SSDNs match
a pattern
deviceSsdr - returns the SSDR for a device
deviceState - returns the state of a device
(valid, obsolete, or invalid)
deviceStatusScaling - returns status scaling information for a device
deviceStatusScalingAll - returns all status scaling information for
a device
deviceStructureName - returns the structure name for a device property
deviceType - returns the type of a device property
deviceValue - returns a numeric device value
deviceValueText - returns a device value as a string
deviceVirtualMachine - returns device virtual machine information
digitalAlarmText - returns the digital alarm text for a device
digitalAlarmTextAll - returns all of the digital alarm text for
a device
digitalControlInfo - returns digital control info for a device
digitalControlInfoAll - returns all of the digital control info
for a device
dipoleFourBumpInfo - returns dipole four bump information
dipoleThreeBumpInfo - returns dipole three bump information
downloadDevices - returns front end download devices
duplicateSsdnProperties - returns any duplicate SSDN properties
to a given property on the same node
emcToString - converts an EMC value to a standard string
error - converts an ACNET error string to a value
errorToFacilityError - converts an ACNET error value to its component
facility and error number
escapeString - replaces characters in a string with their
corresponding escape characters
eventCount - returns the current count for an event
eventDate - returns the date in clinks when an event last occurred
eventOccurred - determines if a clock event has occurred
exists - determines if a device or variable/symbol exists
exp - base e exponentiation (e^n)
expandFileName - expands a file name starting with a tilde (~)
feClassInfo - returns front end device class information
feSsdnClassLocation - returns the byte index of the device class
in an SSDN
fileCopy - copies an existing file (requires file copy privilege)
fileDate - returns the date of a file
fileDelete - deletes an existing file (requires file delete privilege)
fileDevices - returns the devices specified in a file
fileDirectory - returns file names for a directory
fileExists - determines whether or not a file exists
fileFlush - flush any unwritten information to the file
fileGetString - reads a string from a file opened by openFile
fileHasPermission - returns a specific permission for a file
fileLength - returns the length of a file in bytes
fileNumLines - returns the number of lines (also characters and words)
in a file
fileOwner - returns the owner of a file
fileOwnerId - returns the owner ID for a file
filePermissions - returns the complete file permission set for a file
filePrintf - functions like fprintf with the additional functionality
of toString
fileRead - reads binary values from a file
fileRename - renames an existing file (requires file rename privilege)
fileRewind - rewinds a file to its beginning
fileWrite - writes binary values to a file
findChar - returns the first location of one of a set of characters
in a string
findConsoleWindowTitle - find console window titles matching a string
findFileInPath - determines whether a file name points to an
existing file
findInFile - searches for a text string in a file
findNotChar - returns the first location of a character which is not
a member of a set of characters in a string
findString - returns the position of one string within another
findTagString - finds and extracts delimited tags from a string
firstCharPos - find the first or last nonblank character position
floatToBinary - converts a single precision floating point value to
its equivalent binary value
floor - largest integer less than or equal to its argument
flushLogFile - flush any unwritten information to the log file
flushOutputFile - flush any unwritten information to an output file
fmod - remainder of the arguments
formatDateString - format a date string using the format specifiers
in strftime
fract - fractional component
fscanf - functions like fscanf with the additional functionality
of toNumeric
fshareFileInfo - returns information about a Filesharing file
ftpMaxFreq - returns the maximum fast time plot frequency for a
device or plot class
fullName - returns a device full name string
fullNameToConsoleUserName - converts a full name to a console user name
fullText - returns a device full descriptive text string
genericDeviceSearch - searches for devices matching various parameters
genericStructInfo - returns information about a generic structure
getenv - returns the string corresponding to an environment variable
getFirstChar - retrieve the first or last nonblank character
getLastChar - retrieve the last nonblank character in a string
getLogicalName - returns the string corresponding to a logical name
getTaggedValue - extracts a tag/value pair from a string
gifImageSize - determines the dimensions of a GIF image
hasAnalogAlarm - determines whether or not a device has an
analog alarm property
hasControl - determines whether or not a device has a control property
hasControlAttribute - determines whether or not a device has
a control attribute
hasDigitalAlarm - determines whether or not a device has a
digital alarm property
hasProperty - determines whether or not a device has a
specified property
hasReading - determines whether or not a device has a reading property
hasSetting - determines whether or not a device has a setting property
hasStatus - determines whether or not a device has a status property
hasStatusAttribute - determines whether or not a device has a
status attribute
head - returns the beginning of a string
hex - returns a value as a hexadecimal string
highestBit - returns the highest bit set in a value (or -1)
histogram - divides an array of values into buckets
hypot - square root of the sum of the squares of the arguments
identical - checks to see if all values in an array are identical
ifLevel - returns the current 'if' level of the script
insertString - inserts a string within another string
ipNameToNode - converts an IP name to an ACNET node value
isAcsysFefDevice - determines whether a device property is
sourced by an Acsys/FEF node
isAcsysFefNode - determines whether a node is an Acsys/FEF node
isAlphabeticString - determines whether or not a string is composed
entirely of alphabetic characters
(plus optional white space)
isAlphanumericString - determines whether or not a string is composed
entirely of alphanumeric characters
(plus optional white space)
isArrayDevice - determines whether or not a device/property is an array
isBlankString - determines whether or not a string is composed
entirely of white space
isBracketedString - determines whether or not a string is bracketed
isDateString - determines whether or not a string represents a date
isDeviceString - determines whether or not a string represents a
device specification
isErrorString - determines whether or not a string is an error name
isEventString - determines whether or not a string represents a
clock event
isFloatString - determines whether or not a string represents a
floating point number
isHexString - determines whether or not a string represents a
hexadecimal number
isInfinity - tests to see if a value is infinite
isIntegerString - determines whether or not a string represents
an integer number
isIrmDevice - determines whether a device property is
sourced by an IRM node
isIrmNode - determines whether a node is an IRM node
isLabviewDevice - determines whether a device property is
sourced by a LabView node
isLabviewNode - determines whether a node is a LabView node
isLowerCase - determines whether or not a string is in all
lower case characters
isMoocDevice - determines whether a device property is
sourced by a MOOC node
isMoocNode - determines whether a node is a MOOC node
isNaN - tests to see if a value is a NaN
isNodeString - determines whether or not a string is a node name
isOacDevice - determines whether a device property is
sourced by an OAC
isOacNode - determines whether a node is an OAC node
isObsoleteDevice - determines whether or not a device is obsolete
isPrintableString - determines whether or not a string is composed
entirely of printable characters
isPropertyString - determines whether or not a string is a
device property name
isQuotedString - determines whether or not a string is quoted
isRad50String - determines whether or not a string is
composed entirely of valid rad50 characters
isServerTask - determines whether or not an ACNET task is a server
isStringFilledWithChar - determines whether or not a string is
composed entirely of a single character
isStructureDevice - determines whether or not a device/property
is a structure
isUpperCase - determines whether or not a string is in all
upper case characters
isValidSdaCase - determines whether or not a value is a valid SDA
case (case instance actually exists)
isValidSdaFile - determines whether or not a value is a valid SDA
file number (file instance actually exists)
isValidSdaSet - determines whether or not a value is a valid SDA set
(set instance actually exists)
julianDate - converts a date value to a julian date
julianDateToDate - converts a julian date value to a date
justify - left justify, right justify, or center a string
land - logical and
lastCharPos - find the last nonblank character position in a string
leftJustify - left justify a string
leftShift - left shift a string
leftTrim - removes leading blanks from a string
lexSaDevices - returns devices in a Lex SA display
ln - natural log
localtime - break down a date value into its component values
log - base 10 log
loggerListDeviceStats - returns logger list device configuration stats
loggerListDevices - returns the devices in a data logger list
loggerListInfo - returns general logger list information
loggerListWrapTime - returns a logger list wrap time in hours
loggerNameToNode - converts a data logger name to its corresponding node
loggersOnNode - returns the data loggers running on an ACNET node
loopLevel - returns the current loop level of the script
lor - logical or
lowestBit - returns the lowest bit set in a value (or -1)
lshft - circular left shift
makePrintable - expand any tabs and remove or replace any
nonprintable characters in a string
max - maximum of two values
maximum - maximum of an array of values
mean - mean of an array of values
median - median of an array of values
millisecondsNow - returns the current time in milliseconds
since the Epoch
min - minimum of two values
minimum - minimum of an array of values
mode - returns the most commonly occurring value in an array
(If there are multiple mode values, the smallest value
is returned.)
myConsole - returns the caller's console number
myConsoleClass - returns the caller's console class
myConsoleInstance - returns the caller's console instance number
myConsoleSlot - returns the caller's console slot
myExecutableName - returns the caller's executable name
myGenericProcessName - returns the caller's generic process name
myHostName - returns the caller's host name
myNode - returns the caller's ACNET node
myProcessName - returns the caller's process name
mySystemInfo - returns basic system information
myUserName - returns the caller's user name
name - returns a device name string
networkServiceToPort - converts a network service name to a port
newestSrFile - returns the newest save/restore file number
nextSibling - returns the device's next sibling (or 0)
node - converts a node name to a value
nodeAcnetTasks - retrieves the ACNET tasks for a given node
nodeAttributeValue - returns ACNET node attribute values
nodeConsolidator - returns the consolidating node(s) for a node
nodeIs - determines whether or not the specified node has a
particular status or type
nodeIsUp - determines whether or not the specified node is up
nodeToLoggerName - convert a node value to a data logger name
nodeToTrunkNode - converts an ACNET node value to its component
trunk and node number
nonblankLength - returns the nonblank length of a string
numElements - returns the number of elements in a variable or a
device specification (dynamic)
numReadableProperties - returns the number of readable properties for
a device (optionally also returns the array
of properties)
numSettableProperties - returns the number of settable properties for
a device (optionally also returns the array
of properties)
oacsOnNode - returns the names of OACs running on an ACNET node
octal - returns a value as an octal string
oldestLoggerTime - returns the oldest timestamp for a logged device
oldestSrFile - returns the oldest save/restore file number
openFile - opens a file for reading and/or writing
or - bitwise or
pad - pads a string with a specified character to a specified length
pageTitle - returns the title for a page
parameterPageDevices - returns the devices on a parameter page
parseFileName - parses a file name into its component pieces
playBeep - plays a beep sound
playSound - plays an existing sound file
pos - pads with spaces/truncates a string to a specified length
prec - output precision (eg. prec(value,fraction_digits))
previousSibling - returns the device's previous sibling (or 0)
printf - functions like printf with the additional functionality
of toString
printfNoNewline - functions like printf with the additional
functionality of toString (no newline added)
processExists - determines if a process exists
processInfo - retrieves information about a process
programMapping - returns the pages that a program is mapped to
quoteString - adds beginning and ending quotes to a string
rad50ToString - converts a radix 50 value to a string
radix - returns a value as an arbitrary radix (2-36) string
random - returns pseudo random numbers from 0 to 2^31 - 1
randomSeed - sets the seed value for the random function
range - range of an array of values
readLock - retrieves information about a lock
readProgramLocks - retrieves the locks held by a program
regexpCompareString - compares a string to a pattern (case sensitive)
regexpCompareStringNocase - compares a string to a pattern
regexpFindString - returns the position of one string within another
using regular expressions for the search
regexpReplaceString - replaces one string with another string in a
string using regular expressions for the search
regexpSplit - splits up a string based upon finding a delimiter string
which is a regular expression
repeatString - repeats a substring a number of times
replaceBracketedString - replace a bracketed substring
replaceChar - replaces any of a set of characers with another character
replaceString - replaces one string with another string in a string
reverse - reverses a string
rightJustify - right justify a string
rightShift - right shift a string
rightTrim - removes trailing blanks from a string
rms - RMS of an array of values
round - round (to a specified number of digits)
rshft - circular right shift
saveFileInfo - returns information about a single save/restore file
scondif - returns the second argument as a string if the first has
a value of true or the third argument as a string if
it has a value of false
sdaFileDate - returns the starting or ending date for an SDA file
secant - secant
setBit - set a bit in a value
setBitField - sets a bit field value
setenv - sets an environment variable to a value
setLogicalName - sets a logical name to a value
settingsAreEnabled - determines if settings are enable
(supports optional device name argument)
setUserAlarmListStatus - sets the status of a user alarm list
sin - sine
sind - sine (argument in degrees)
sinh - hyperbolic sine
sizeof - returns the number of elements in a device, device list,
input, or variable
sizeofVariable - returns the number of elements in a variable
snapManagerDataDirectory - returns snapshot manager data file
information
snapshotMaxFreq - returns the maximum snapshot plot frequency for
a device or plot class and optionally the number
of points as well
split - splits up a string based upon finding a delimiter string
splitByCharSet - splits up a string based upon finding any of a set
of delimiter characters
sprintf - formats output strings like sprintf with the additional
functionality of toString
sqlQueryDevices - returns devices from a SQL query
sqrt - square root
sscanf - functions like sscanf with the additional functionality
of toNumeric
ssdnToString - converts an SSDN value to a standard string
stateText - returns the text for a state of a state device
stddev - standard deviation of an array of values
stepMotorIsMoving - determines whether or not a stepping motor
is currently moving
stringCompare - compares one string to another (case sensitive)
stringCompareNocase - compares one string to another (case insensitive)
stringConcatenate - concatenate two strings
stringCopy - copies one string to another
stringEndsWith - determines if a string ends with a substring
stringExtractLine - extract a line from a string
stringGetChar - retrieve a substring from a string
(similar to substring but with different defaults)
stringGetValue - returns the next token of the specified type from
a string and removes it from the original string
stringLength - returns the length of a string
stringLineInfo - determines how many lines are in a string
stringSetChar - overwrite a substring of one string with another
(similar to stringCopy)
stringStartsWith - determines if a string starts/ends with a substring
stringToColor - converts a string to a color value
stringToConsoleClassMask - converts a string to a console class mask value
stringToConvertType - converts a string to a convert type value
stringToDate - converts a string to a date value
stringToDeviceName - finds device names matching a search string
stringToDouble - converts a string to a double precision
floating point value
stringToEmc - converts a string to an EMC value
stringToInteger - converts a string to an integer
stringToken - returns the next token from a string and removes it
from the original string
stringToProperty - converts a string to a property value
stringToRad50 - convert a string to a radix 50 value
stringToSsdn - converts a string to an SSDN value
stringType - returns a string describing the argument string's type
stripBrackets - strips beginning and ending brackets from a string
stripCharacters - strips a requested set of characters from a string
stripEolCharacters - strips end of line characters from a string
stripHtml - strips HTML tags from a string
stripNonprintables - strips nonprintable characters from a string
stripQuotes - strips beginning and ending quotes from a string
stripSpaces - strips any whitespace from a string
strncmp - compares the first n characters of two strings
strShift - left or right shift a string
substring - returns a substring of a string
sum - sum of an array of values
synopticDevices - returns devices in a Synoptic display
systemTime - returns system time in milliseconds since ACL
was initialized
tail - returns the end of a string
tan - tangent
tand - tangent (argument in degrees)
tanh - hyperbolic tangent
taskExists - determines if an ACNET task exists
taskId - returns an ACNET task ID
taskIdToName - converts an ACNET task ID to a name
taskPid - returns an ACNET task process ID
taskPidToName - converts an ACNET task process ID to name(s)
text - returns a device descriptive text string
timeAgo - returns date which is some number of time units before a base time
timeFromDate - returns date which is some number of time units after
a base time
timer - returns the current value of a timer
timeSinceEvent - returns the elapsed time since an event has occurred
toLower - converts a string to lower case
toNumeric - converts a string to its numeric value
toString - converts a value to its corresponding string
totalNumberOfDevices - returns the total number of devices in the
control system
toTrimmedString - converts a value to a string with no spaces
toUpper - converts a string to upper case
trim - removes leading and trailing blanks from a string
trunc - truncate
trunkNodeToNode - converts a trunk and node number into a node value
unescapeString - replaces escape characters in a string with
their original characters
units - returns a device units string
userAlarmList - returns the state of a user alarm list
(enabled, bypassed, or empty)
userAlarmListDevices - returns the devices in a user alarm list
userSaveListDevices - returns the devices in a user save list
valueToLogicalArray - converts bit values into a logical array
valueType - returns the type of a value as a string
variableNumReadings - returns the number of times a variable
has been read
variableNumSettings - returns the number of times a variable
has been set
variableType - returns the type of a variable as a string
variance - variance of an array of values
virtualMachineDevices - returns the devices belonging to a
virtual machine
whereDeviceIsLogged - returns where a device is logged
whereDeviceWasLogged - returns where a device was logged in the past
wordCount - returns the number of words in a string
xor - bitwise exclusive or
-------------------------------------------------------------------------------
15hzCount : returns 15Hz count since the calling process started
count = 15hzCount([timeReference])
Arguments:
[timeReference] time reference
(delta -> return delta time since previous call,
scriptStart -> return delta time since start
of script)
(default is count since application started)
This function returns values as follows:
15 Hz count since the calling application started
Related functions:
millisecondsNow, currentTime, currentTimeInClinks, systemTime, cpuTime,
timer, timeSinceEvent, timeAgo, timeFromDate, stringToDate,
dateToString, convertSeconds, julianDate, julianDateToDate
-------------------------------------------------------------------------------
abs : absolute value
resultValue = abs(value)
Arguments:
value value to take the absolute value of
This function returns values as follows:
absolute value of the argument
Related functions:
round, prec, trunc
-------------------------------------------------------------------------------
acnetPing : performs an ACNET ping on a node
responded = acnetPing(node [,responseTime])
Arguments:
node node to check
[responseTime] response time in microseconds
This function returns values as follows:
TRUE node responded to ping
FALSE node did not respond to ping
Related functions:
nodeIsUp, nodeIs
-------------------------------------------------------------------------------
acos : arc cosine
resultValue = acos(value)
Arguments:
value value to take the arc cosine of
This function returns values as follows:
arc cosine value of the argument (in radians)
Related functions:
acosd, acosh, cos, cosd, cosh, sin, sind, asin, sinh
-------------------------------------------------------------------------------
acosd : arc cosine (result in degrees)
resultValue = acosd(value)
Arguments:
value value to take the arc cosine of
This function returns values as follows:
arc cosine value of the argument (in degrees)
Related functions:
acos, cosd, cosh, sin, sind, asin, sinh
-------------------------------------------------------------------------------
acosh : arc hyperbolic cosine
resultValue = acosh(value)
Arguments:
value value to take the arc hyperbolic cosine of
This function returns values as follows:
arc hyperbolic cosine value of the argument
Related functions:
acos, acosd, cos, cosd, cosh, sin, sind, asin, sinh
-------------------------------------------------------------------------------
alarmAcknowledgeMask : returns a device's alarm acknowledge mask
protectionMask = alarmAcknowledgeMask(device)
Arguments:
device device of interest
This function returns values as follows:
alarm acknowledge mask
Related functions:
name, fullName, deviceProtectionMask, alarmBlockFieldValue
-------------------------------------------------------------------------------
alarmBlockFieldValue : returns individual alarm block field values
value = alarmBlockFieldValue(device, fieldType [,property]
[,dataSource] [,arrayIndex]
[,wantNumeric])
Arguments:
device device of interest
fieldType field to return
(state -> alarm state,
enable -> alarm enable status,
postMethod -> alarm post method,
triesNeeded -> number of readings before changing
alarm state,
triesNow -> current number of readings in alarm state,
ftd -> alarm reading sample FTD,
isAbort -> flag indicating if alarm can generate
an abort,
abortEnable -> flag indicating if aborts are enabled,
limitLength -> alarm limit length
limitType -> analog alarm limit type
limitDataType -> analog alarm limit data type
minimum -> analog alarm minimum value,
maximum -> analog alarm maximum value,
highLow -> analog alarm high/low status,
primaryMinimum -> analog alarm minimum value
(primary units),
primaryMaximum -> analog alarm maximum value
(primary units),
rawMinimum -> analog alarm minimum value (raw units),
rawMaximum -> analog alarm maximum value (raw units),
nominal -> analog alarm nominal value,
tolerance -> analog alarm tolerance value,
digitalNominal -> digital alarm nominal value,
mask -> digital alarm mask value)
[property] desired property
(analogAlarm,
digitalAlarm)
(default is the implicit property from the device
argument)
[dataSource] data source
(default is live reading)
[arrayIndex] array index
(default is 0)
[wantNumeric] flag indicating whether or not to force the return
type to be numeric
(defaultFormat -> return default format (default),
wantNumeric -> return as a numeric value)
This function returns values as follows:
alarm block field value
Related functions:
deviceValue, deviceValueText, deviceDigitalStatus
-------------------------------------------------------------------------------
allLoggerNodes : returns the names of all data loggers
numDevices = allLoggerNodes([loggerNames])
Arguments:
[loggerNames] returned data logger names
This function returns values as follows:
number of data loggers
Related functions:
loggerListDevices, loggerListDeviceStats, loggerListInfo,
loggerListWrapTime, whereDeviceIsLogged, oldestLoggerTime,
loggerNameToNode, nodeToLoggerName, whereDeviceWasLogged
-------------------------------------------------------------------------------
analogAlarmPriority : returns the analog alarm priority for a device
status = analogAlarmPriority(device)
Arguments:
device device of interest
This function returns values as follows:
analog alarm priority value
Related functions:
analogAlarmText, digitalAlarmText
-------------------------------------------------------------------------------
analogAlarmText : returns the analog alarm text for a device
string = analogAlarmText(device)
Arguments:
device device of interest
This function returns values as follows:
analog alarm text
Related functions:
analogAlarmPriority, digitalAlarmText, digitalAlarmTextAll,
deviceCurrentAlarmText
-------------------------------------------------------------------------------
and : bitwise and
resultValue = and(value, value2)
Arguments:
value first value
value2 second value
This function returns values as follows:
bitwise and of the two arguments
Related functions:
or, xor
-------------------------------------------------------------------------------
appdsTableInfo : returns information about an APPDS table
recordSize = appdsTableInfo(tableName [,maxRecords] [,numFields]
[,dataTypes] [,dataLengths] [,numElements])
Arguments:
tableName APPDS table to check
[maxRecords] returned maximum number of records in the table
[numFields] returned number of fields
[dataTypes] returned array of field data types
(CNV_BYTE,
CNV_SHORT,
CNV_LONG,
CNV_FLOAT,
CNV_DOUBLE,
CNV_CHAR,
CNV_HEX_STRING)
[dataLengths] returned array of field data lengths in bytes
[numElements] returned array of field numbers of elements
This function returns values as follows:
size of each record in bytes
Related functions:
fshareFileInfo
-------------------------------------------------------------------------------
arrayAppend : append a new entry at the end of an array
status = arrayAppend(variable, value [,numElements])
Arguments:
variable array variable to append to
value value(s) to append
[numElements] number of elements to append
(default is 1)
This function returns status values as follows:
TRUE array modified
FALSE array not modified
Related functions:
arrayPrepend, arrayInsert, arrayDelete, arrayDeleteDuplicates,
arrayFill, arrayInvert
-------------------------------------------------------------------------------
arrayDelete : deletes an existing entry from an array
status = arrayDelete(variable, element [,numElements])
Arguments:
variable array variable to delete from
element deletion element position (starts at 1)
(A string having a value of "last" can
be used to indicate the last element(s).)
[numElements] number of elements to delete
(Note: You cannot delete all elements in
an array. You must leave at least one
element.)
(default is 1)
This function returns status values as follows:
TRUE array modified
FALSE array not modified
Related functions:
arrayDeleteDuplicates, arrayInsert, arrayAppend, arrayPrepend,
arrayFill, arrayInvert
-------------------------------------------------------------------------------
arrayDeleteDuplicates : deletes duplicate entries from an array
status = arrayDeleteDuplicates(variable)
Arguments:
variable array variable to delete duplicates from
This function returns status values as follows:
FALSE array not modified
otherwise number of elements deleted
Related functions:
arrayDelete, arrayInsert, arrayAppend, arrayPrepend, arrayFill,
arrayInvert
-------------------------------------------------------------------------------
arrayFill : fill an array with a value
status = arrayFill(variable, value [,startElement] [,endElement])
Arguments:
variable array variable to fill
value value to fill with
startElement start element position (starts at 1)
(default is 1)
endElement end element position (starts at 1)
(default is last element)
This function returns status values as follows:
TRUE array modified
FALSE array not modified
Related functions:
arrayInsert, arrayAppend, arrayPrepend, arrayDelete,
arrayDeleteDuplicates, arrayInvert
-------------------------------------------------------------------------------
arrayInsert : inserts a new element in an array
status = arrayInsert(variable, value, element [,numElements])
Arguments:
variable array variable to insert into
value value(s) to insert
element insertion element position (starts at 1)
(A string having a value of "last" can
be used to indicate the last element.)
[numElements] number of elements to insert
(default is 1)
This function returns status values as follows:
TRUE array modified
FALSE array not modified
Related functions:
arrayAppend, arrayPrepend, arrayDelete, arrayDeleteDuplicates,
arrayFill, arrayInvert
-------------------------------------------------------------------------------
arrayInvert : inverts the order of an array
status = arrayInvert(variable)
Arguments:
variable array variable to invert
This function returns status values as follows:
TRUE array modified
FALSE array not modified
Related functions:
arrayInsert, arrayAppend, arrayPrepend, arrayDelete,
arrayDeleteDuplicates, arrayFill
-------------------------------------------------------------------------------
arrayPrepend : insert a new entry at the beginning of an array
status = arrayPrepend(variable, value [,numElements])
Arguments:
variable array variable to prepend to
value value(s) to prepend
[numElements] number of elements to prepend
(default is 1)
This function returns status values as follows:
TRUE array modified
FALSE array not modified
Related functions:
arrayAppend, arrayInsert, arrayDelete, arrayDeleteDuplicates, arrayFill,
arrayInvert
-------------------------------------------------------------------------------
asin : arc sine
resultValue = asin(value)
Arguments:
value value to take the arc sine of
This function returns values as follows:
arc sine value of the argument (in radians)
Related functions:
asind, asinh, sin, sind, sinh, acos, acosd, acosh, cos, cosd, cosh
-------------------------------------------------------------------------------
asind : arc sine (result in degrees)
resultValue = asind(value)
Arguments:
value value to take the arc sine of
This function returns values as follows:
arc sine value of the argument (in degrees)
Related functions:
asin, asinh, sin, sind, sinh, acos, acosd, acosh, cos, cosd, cosh
-------------------------------------------------------------------------------
asinh : arc hyperbolic sine
resultValue = asinh(value)
Arguments:
value value to take the arc hyperbolic sine of
This function returns values as follows:
arc hyperbolic sine value of the argument
Related functions:
asin, asind, sin, sind, sinh, acos, acosd, acosh, cos, cosd, cosh
-------------------------------------------------------------------------------
atan : arc tangent
resultValue = atan(value)
Arguments:
value value to take the arc tangent of in radians
This function returns values as follows:
arc tangent value of the argument
Related functions:
tan, tand, tanh, atand, atan2, atan2d, atanh, cos, cosd, cosh,
sin, sind, sinh, acos, acosd, acosh, asin, asind, asinh
-------------------------------------------------------------------------------
atan2 : arc tangent of the quotient of the arguments
resultValue = atan2(y, x)
Arguments:
y y value
x x value
This function returns values as follows:
arc tangent value of the argument (-pi to pi)
Related functions:
tan, tand, tanh, atan, atand, atan2d, atanh, cos, cosd, cosh,
sin, sind, sinh, acos, acosd, acosh, asin, asind, asinh
-------------------------------------------------------------------------------
atan2d : arc tangent of the quotient of the arguments
(result in degrees)
resultValue = atan2d(y, x)
Arguments:
y y value
x x value
This function returns values as follows:
arc tangent value of the argument
Related functions:
tan, tand, tanh, atan, atand, atan2, atanh, cos, cosd, cosh,
sin, sind, sinh, acos, acosd, acosh, asin, asind, asinh
-------------------------------------------------------------------------------
atand : arc tangent (result in degrees)
resultValue = atand(value)
Arguments:
value value to take the arc tangent of in degrees
This function returns values as follows:
arc tangent value of the argument
Related functions:
tan, tand, tanh, atan, atan2, atan2d, atanh, cos, cosd, cosh,
sin, sind, sinh, acos, acosd, acosh, asin, asind, asinh
-------------------------------------------------------------------------------
atanh : arc hyperbolic tangent
resultValue = atanh(value)
Arguments:
value value to take the arc hyperbolic tangent of
This function returns values as follows:
arc hyperbolic tangent value of the argument
Related functions:
tan, tand, tanh, atan, atand, atan2, atan2d, cos, cosd, cosh,
sin, sind, sinh, acos, acosd, acosh, asin, asind, asinh
-------------------------------------------------------------------------------
bcdToDecimal : convert a BCD-encoded value into decimal integer
value = bcdToDecimal(value [,numCharacters])
Arguments:
value BCD encoded value to convert
[numCharacters] number of characters to convert
(default is twice the data length of the value in bytes)
This function returns values as follows:
corresponding integer value
Related functions:
bcdToString
-------------------------------------------------------------------------------
bcdToString : convert a BCD-encoded value into decimal string
string = bcdToString(value [,numCharacters])
Arguments:
value BCD encoded value to convert
[numCharacters] number of characters to convert
(default is twice the data length of the value in bytes)
This function returns values as follows:
corresponding string
Related functions:
bcdToDecimal
-------------------------------------------------------------------------------
binary : returns a value as a binary string
string = binary(value [,convertLength] [,fillChar] [,dataType])
Arguments:
value value to convert
[convertLength] converted string length
[fillChar] fill character
[dataType] data type
(integer,
float,
double)
(default is to use the native type of the value)
This function returns values as follows:
converted string value
Synonyms: toBinary
Related functions:
hex, octal, decimal, radix, toString, toTrimmedString, rad50ToString
-------------------------------------------------------------------------------
binaryToFloat : converts a binary value to its equivalent
single precision floating point value
floatValue = binaryToFloat(binaryValue)
Arguments:
binaryValue binary (integer) value to convert to a float
This function returns values as follows:
corresponding float value
Related functions:
floatToBinary
-------------------------------------------------------------------------------
bit : bit test
boolean = bit(value, bitNumber)
Arguments:
value value to test
bitNumber bit number (starts at 1)
This function returns values as follows:
TRUE bit is set
FALSE bit is clear
Synonyms: tstbit, testBit, isBitSet
Related functions:
bitCount, lowestBit, highestBit, bitField, deviceBitField, bitText,
bitDataText, valueToLogicalArray
-------------------------------------------------------------------------------
bitComplement : complement (invert) bits in a value
value = bitComplement(sourceValue [,numBits] [,startBit])
Arguments:
sourceValue value to modify
[numBits] number of bits to complement
(default is all)
[startBit] starting bit number (starts at 1)
(default is 1)
This function returns values as follows:
modified value with the requested bits complemented
Synonyms: bitNot
Related functions:
clearBit, setBit, bit, bitCount, bitField, circularShift
-------------------------------------------------------------------------------
bitCount : returns the number of bits set in a value
numSet = bitCount(value, startBit [,numBits])
Arguments:
value value to test
startBit starting bit number (starts at 1)
[numBits] number of bits (default is 1)
This function returns values as follows:
number of bits set
Related functions:
bit, bitField, deviceBitField, bitText, bitDataText
-------------------------------------------------------------------------------
bitDataText : returns the data text for a specified bit
string = bitDataText(device, bit [,bitValue])
Arguments:
device device/property of interest
bit bit number (starts at 1)
[bitValue] bit value to return text for
(0, 1, or 'default' (current bit reading))
(default is current bit reading)
This function returns values as follows:
bit data descriptive text string
Related functions:
bitText, deviceBitField, bitField
-------------------------------------------------------------------------------
bitField : extracts a bit field value
fieldValue = bitField(value, startBit [,numBits])
Arguments:
value value to extract bit field from
startBit starting bit number (starts at 1)
[numBits] number of bits (default is 1)
This function returns values as follows:
extracted bit field value
Related functions:
bit, bitCount, deviceBitField, bitText, bitDataText
-------------------------------------------------------------------------------
bitText : returns the descriptive text for a specified status bit
string = bitText(device, bit)
Arguments:
device device/property of interest
bit bit number (starts at 1)
This function returns values as follows:
bit descriptive text string
Related functions:
bitDataText, deviceBitField, bitField, bitTextAll
-------------------------------------------------------------------------------
bitTextAll : returns the bit information for a device
numBits = bitTextAll(device [,numbers] [,text] [,text_if_0] [,text_if_1]
[,color_if_0] [,color_if_1])
Arguments:
device device of interest
[numbers] returned bit numbers
[text] returned bit descriptive text
[text_if_0] returned data text if the bit value is 0
[text_if_1] returned data text if the bit value is 1
[color_if_0] returned text color if the bit value is 0
[color_if_1] returned text color if the bit value is 1
This function returns values as follows:
number of bit descriptions
Related functions:
bitText, bitDataText, deviceBitField, bitField
-------------------------------------------------------------------------------
byteCompare : performs a byte comparison of two values
value = byteCompare(firstValue, secondValue [,compareLength]
[,firstIndex] [,secondIndex])
Arguments:
firstValue first value to compare
secondValue second value to compare
[compareLength] number of bytes to compare
(default is to compare the entire values)
[firstIndex] byte index in the first value to start comparing
(starts at 1)
(default is 1)
[secondIndex] byte index in the second value to start comparing
(starts at 1)
(default is 1)
This function returns values as follows:
0 values match
otherwise values don't match
Related functions:
byteCopy, stringCompare, stringCopy
-------------------------------------------------------------------------------
byteCopy : performs a byte copy of one value to another
numBytes = byteCopy(destValue, copyValue [,copyLength]
[,destIndex] [,copyIndex])
Arguments:
destValue value to be copied to
copyValue value to copy
[copyLength] number of bytes to copy
(default is the length of the copy value)
[destIndex] index to start copying to (starts at 1)
(default is 1)
[copyIndex] index to start copying (starts at 1)
(default is 1)
This function returns values as follows:
number of bytes actually copied
Related functions:
stringCopy, byteCompare
-------------------------------------------------------------------------------
byteSizeof : returns the size of a device or variable in bytes (static)
byteSize = byteSizeof(value)
Arguments:
value value to determine the size in bytes of
(device property or variable)
This function returns values as follows:
size in bytes
Related functions:
byteSizeofVariable, sizeof, sizeofVariable
-------------------------------------------------------------------------------
byteSizeofVariable : returns the size of a variable in bytes (dynamic)
byteSize = byteSizeofVariable(variable)
Arguments:
variable variable to determine the size in bytes of
This function returns values as follows:
size in bytes
Related functions:
byteSizeof, sizeof, sizeofVariable, numElements, variableType
-------------------------------------------------------------------------------
cacheDeviceInfo : cache device database information for later retrieval
numCached = cacheDeviceInfo(devices [,numDevices] [,attribute1] ...)
Arguments:
devices devices to cache database information for
(either an array of device names or a
device list specifier (deviceList={list}))
[numDevices] number of devices (default is all devices specified)
[attribute1] first of a variable number of device attributes
to cache (some require a following property specifier - *)
(name,
fullName,
previousName,
description,
fullDescription,
requestInfo (*),
scalingInfo (*),
deviceType (*),
deviceClass (*),
saveInfo,
auditInfo,
siblings,
location,
dbAlarmInfo,
alarmList,
actualAlarmList,
alarmHandler (*),
alarmText (*),
alarmUrl,
maintainer,
department,
outOfService,
controlledSetting (*),
dataType (*),
expression,
foreignDeviceInfo (*),
structure,
emc,
virtualMachine,
controllingDevice,
etc.)
This function returns status values as follows:
number of devices cached
Related functions:
genericDeviceSearch, deviceNameSearch, deviceFullNameSearch,
deviceDescriptionSearch, deviceFullDescriptionSearch, deviceNodeSearch,
deviceSsdnSearch
-------------------------------------------------------------------------------
cacheNodeInfo : cache node database information for later retrieval
numCached = cacheNodeInfo(nodes [,numNodes])
Arguments:
nodes nodes to cache database information for
[numNodes] number of nodes (default is all nodes specified)
This function returns status values as follows:
number of nodes cached
Related functions:
nodeAttributeValue, node, nodeIs, isIrmNode, isLabviewNode,
isMoocNode, isOacNode, isAcsysFefNode
-------------------------------------------------------------------------------
capitalize : capitalizes the first character in each word of a string
string = capitalize(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
modified string
Related functions:
case, toUpper, toLower
-------------------------------------------------------------------------------
case : changes the case of a string
string = case(sourceString, caseType)
Arguments:
sourceString source string
caseType case desired
(upper -> upper case,
lower -> lower case,
capitalize -> capitalize the first character
of each word)
This function returns values as follows:
modified string
Related functions:
toLower, toUpper, capitalize
-------------------------------------------------------------------------------
cast : return the equivalent value to a value
newValue = cast(oldValue, desiredType)
Arguments:
oldValue value to convert
desiredType type to convert to
This function returns values as follows:
corresponding converted value
Related functions:
castDouble, castFloat, castInteger, castLogical, castLongLong,
castUnsignedInt, castUnsignedLongLong
-------------------------------------------------------------------------------
castDouble : return the equivalent double precision value to a value
doubleValue = castDouble(oldValue)
Arguments:
oldValue value to convert
This function returns values as follows:
corresponding converted double value
Synonyms: float
Related functions:
cast, castFloat, castInteger, castLogical, castLongLong,
castUnsignedInt, castUnsignedLongLong
-------------------------------------------------------------------------------
castFloat : return the equivalent single precision value to a value
floatValue = castFloat(oldValue)
Arguments:
oldValue value to convert
This function returns values as follows:
corresponding converted float value
Related functions:
cast, castDouble, castInteger, castLogical, castLongLong,
castUnsignedInt, castUnsignedLongLong
-------------------------------------------------------------------------------
castInteger : return the equivalent integer value to a value
integerValue = castInteger(oldValue)
Arguments:
oldValue value to convert
This function returns values as follows:
corresponding converted integer value
Synonyms: int, integer
Related functions:
cast, castDouble, castFloat, castLogical, castLongLong, castUnsignedInt,
castUnsignedLongLong
-------------------------------------------------------------------------------
castLogical : return the equivalent logical (boolean) value to a value
logicalValue = castLogical(oldValue)
Arguments:
oldValue value to convert
This function returns values as follows:
corresponding converted logical (boolean) value
Synonyms: bool, logical, boolean
Related functions:
cast, castDouble, castFloat, castInteger, castLongLong, castUnsignedInt,
castUnsignedLongLong
-------------------------------------------------------------------------------
castLongLong : return the equivalent long integer value to a value
longLongValue = castLongLong(oldValue)
Arguments:
oldValue value to convert
This function returns values as follows:
corresponding converted long integer value
Synonyms: longLong
Related functions:
cast, castDouble, castFloat, castInteger, castLogical, castUnsignedInt,
castUnsignedLongLong
-------------------------------------------------------------------------------
castUnsignedInt : return the equivalent unsigned integer value
to a value
unsignedIntValue = castUnsignedInt(oldValue)
Arguments:
oldValue value to convert
This function returns values as follows:
corresponding converted unsigned integer value
Related functions:
cast, castDouble, castFloat, castInteger, castLogical, castLongLong,
castUnsignedLongLong
-------------------------------------------------------------------------------
castUnsignedLongLong : return the equivalent unsigned long integer value
to a value
unsignedLongLongValue = castUnsignedLongLong(oldValue)
Arguments:
oldValue value to convert
This function returns values as follows:
corresponding converted unsigned long integer value
Related functions:
cast, castDouble, castFloat, castInteger, castLogical, castLongLong,
castUnsignedInt
-------------------------------------------------------------------------------
ceil : smallest integer greater than or equal to its argument
resultValue = ceil(value)
Arguments:
value original value
This function returns values as follows:
smallest integer greater than or equal to its argument
Related functions:
floor
-------------------------------------------------------------------------------
center : center a string
string = center(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
modified string
Related functions:
justify, leftJustify, rightJustify, leftShift, rightShift, strShift, pad
-------------------------------------------------------------------------------
characterCount : returns the number of characters in a string
count = characterCount(sourceString [,searchChar])
Arguments:
sourceString source string
[searchChar] character to count
(default is all nonwhite space characters)
This function returns values as follows:
number of characters found
Related functions:
wordCount, findChar, findNotChar, findString, regexpFindString
-------------------------------------------------------------------------------
circularShift : bit field circular shift
value = circularShift(sourceValue, startBit [,numBits] [,numShift])
Arguments:
sourceValue value to modify
startBit starting bit number (starts at 1)
[numBits] number of bits to shift
(default is 32)
[numShift] number of bits to shift by
(A positive number produces a left shift while a
negative number will produce a right shift.)
(default is 1)
This function returns values as follows:
modified value with the requested bits circularly shifted
Synonyms: bitFieldCircularShift
Related functions:
lshft, rshft, clearBit, setBit, bit, bitCount, bitField, bitComplement
-------------------------------------------------------------------------------
clearBit : clear a bit in a value
value = clearBit(sourceValue, bitNumber)
Arguments:
sourceValue value to modify
bitNumber bit number (starts at 1)
This function returns values as follows:
modified value with the requested bit cleared
Synonyms: rstbit
Related functions:
setBit, bit, bitCount, bitField, circularShift, bitComplement
-------------------------------------------------------------------------------
clearEventOccurred : clear the detection status for a clock event
boolean = clearEventOccurred(event [,eventType])
Arguments:
event clock event value
[eventType] type of clock event
(tclk -> TCLK event (default),
mibs -> MIBS clock event,
rrbs -> RRBS clock event,
tvbs -> TVBS clock event,
hins -> HINS clock event,
nml -> NML clock event,
test -> test clock event)
This function returns values as follows:
TRUE event has occurred
FALSE event has not occurred
Related functions:
eventOccurred, timeSinceEvent, eventDate, eventCount
-------------------------------------------------------------------------------
closeFile : closes a file opened by an earlier call to openFile
status = closeFile(fileId)
Arguments:
fileId file ID returned by openFile
This function returns values as follows:
status of close
Synonyms: fclose, fileClose
Related functions:
openFile, fileGetString, filePrintf, fscanf, fileRead, fileRewind,
fileWrite
-------------------------------------------------------------------------------
compareWithTolerance : compares one or more values with another
with a tolerance
mismatch = compareWithTolerance(value, compareValue, tolerance
[,numValues])
Arguments:
value value(s) to compare to comparison value
comparisonValue comparison value
tolerance comparison tolerance
[numValues] number of values from the first argument to compare
to the comparison value
(default is 1)
This function returns values as follows:
TRUE value(s) did not match
FALSE value(s) matched within the specified tolerance
Related functions:
none
-------------------------------------------------------------------------------
concatenateStringArguments : concatenate the script string arguments
string = concatenateStringArguments([startIndex] [,numStrings]
[,separatorString])
Arguments:
variable array variable to delete duplicates from
[startIndex] starting argument string index
(default is 0)
[numStrings] number of strings to concatenate
(default is all available strings)
[separatorString] string to insert between adjacent argument strings
(default is the null string)
This function returns status values as follows:
concatenated argument string
Related functions:
none
-------------------------------------------------------------------------------
condif : returns the second argument if the first has a value of true
or the third argument if it has a value of false
value = condif(booleanValue, trueValue, falseValue)
Arguments:
booleanValue boolean value to test
trueValue value to return if the first argument
has a value of TRUE
falseValue value to return if the first argument
has a value of FALSE
This function returns values as follows:
selected value
Related functions:
scondif
-------------------------------------------------------------------------------
consoleClassMaskToString : convert a console class mask to a string
string = consoleClassMaskToString([classMask] [,joinString])
Arguments:
[classMask] console class mask to convert
(default is the calling console's class mask)
[joinString] desired join string between successive names
(default is "+")
This function returns values as follows:
converted console class mask string
Related functions:
stringToConsoleClassMask, myConsoleClass
-------------------------------------------------------------------------------
consoleExists : determines whether or not a specified console exists
(is defined) (may not be running)
boolean = consoleExists(console)
Arguments:
console console number to check
This function returns values as follows:
TRUE console exists
FALSE console doesn't exist
Related functions:
consoleIsUp, consoleSlotExists, consoleToNode, consoleProcessName,
consoleTaskName, consoleSlotToWindow, consoleWindowToSlot
-------------------------------------------------------------------------------
consoleIsUp : determines whether or not a specified console is running
boolean = consoleIsUp(console)
Arguments:
console console number to check
This function returns values as follows:
TRUE console is up
FALSE console is not up
Related functions:
consoleExists, consoleSlotExists, consoleToNode, consoleProcessName,
consoleTaskName, consoleSlotToWindow, consoleWindowToSlot
-------------------------------------------------------------------------------
consoleProcessName : retrieves the name of a console process running
in a specified console and slot
name = consoleProcessName(console, slot [,nameType])
Arguments:
console console number
slot console slot
[nameType] name type to return
(actual -> actual process name (default),
generic -> corresponding generic process name)
This function returns values as follows:
process name string
Related functions:
consoleTaskName, consoleIsUp, consoleExists, consoleSlotExists,
consoleToNode, consoleSlotToWindow, consoleWindowToSlot
-------------------------------------------------------------------------------
consoleSlotExists : determines whether or not a console slot exists
boolean = consoleSlotExists(console, slot)
Arguments:
console console number to check
slot console slot to check
This function returns values as follows:
TRUE slot exists
FALSE slot doesn't exist
Related functions:
consoleExists, consoleIsUp, consoleToNode, consoleProcessName,
consoleTaskName, consoleSlotToWindow, consoleWindowToSlot
-------------------------------------------------------------------------------
consoleSlotToWindow : convert a console slot to a primary window ID
windowId = consoleSlotToWindow(slot)
Arguments:
slot console slot to translate
This function returns values as follows:
corresponding window ID
Related functions:
consoleWindowToSlot, consoleExists, consoleIsUp, consoleToNode,
consoleProcessName, consoleTaskName, consoleSlotExists
-------------------------------------------------------------------------------
consoleTaskName : returns a console slot specific task name
name = consoleTaskName(genericName, slot [,console])
Arguments:
genericName generic task name
slot console slot
[console] console number (default is the caller's console)
This function returns values as follows:
corresponding console task name
Related functions:
consoleProcessName, consoleToNode, consoleExists, consoleIsUp,
consoleSlotExists, consoleSlotToWindow, consoleWindowToSlot
-------------------------------------------------------------------------------
consoleToInstance : converts a console number to its corresponding
instance
node = consoleToInstance(console [,node])
Arguments:
console console number
[node] corresponding ACNET node
This function returns values as follows:
corresponding console instance
Related functions:
consoleToNode, consoleProcessName, consoleTaskName, consoleExists,
consoleIsUp, consoleSlotExists, consoleSlotToWindow,
consoleWindowToSlot
-------------------------------------------------------------------------------
consoleToNode : converts a console number to its corresponding
ACNET node
node = consoleToNode(console)
Arguments:
console console number
This function returns values as follows:
corresponding ACNET node
Related functions:
consoleToInstance, consoleProcessName, consoleTaskName, consoleExists,
consoleIsUp, consoleSlotExists, consoleSlotToWindow,
consoleWindowToSlot
-------------------------------------------------------------------------------
consoleUserNameToFullName : converts a console user name to a full name
fullName = consoleUserNameToFullName(userName)
Arguments:
userName console user name
This function returns values as follows:
corresponding full name
Related functions:
fullNameToConsoleUserName
-------------------------------------------------------------------------------
consoleWindowToSlot : convert a console window ID to a slot
slot = consoleWindowToSlot(windowId)
Arguments:
windowId console window ID to translate
This function returns values as follows:
corresponding slot number
Related functions:
consoleSlotToWindow, consoleExists, consoleIsUp, consoleToNode,
consoleProcessName, consoleTaskName, consoleSlotExists
-------------------------------------------------------------------------------
controllingDevice : returns the device's controlling device (or 0)
controlDevice = controllingDevice(device)
Arguments:
device device of interest
This function returns values as follows:
controlling device
Related functions:
previousSibling, nextSibling
-------------------------------------------------------------------------------
convertSeconds : converts dates in seconds between date types
seconds = convertSeconds(dateTypeFrom, dateTypeTo [,baseDate])
Arguments:
dateTypeFrom date type to convert from
(utc -> original time is in UTC,
localCtime -> original time is local time since
January 1, 1970,
clinks -> original time is in clinks
(seconds since January 1, 1972 local time),
labview -> original date is in LabView time,
dbDateDiff -> original date is the result of an
SQL datediff function performed on
dates stored as local time)
dateTypeTo date type to convert to
(utc -> convert to UTC time,
localCtime -> convert to local time since
January 1, 1970,
clinks -> convert to clinks
(seconds since January 1, 1972 local time),
labview -> convert to LabView time,
dbDateDiff -> convert to the equivalent of an
SQL datediff function performed on
dates stored as local time)
[baseDate] base date
(default is now)
This function returns values as follows:
seconds in the new date type
Related functions:
timeAgo, timeFromDate, stringToDate, dateToString, timeSinceEvent,
cpuTime, systemTime, 15HzCount, timer, julianDate, julianDateToDate,
currentTimeInClinks, currentTime, localtime
-------------------------------------------------------------------------------
convertTypeToString : converts a convert type value to a string
string = convertTypeToString(convertTypeValue)
Arguments:
convertTypeValue convert type value to convert
This function returns values as follows:
converted string
Related functions:
stringToConvertType, rad50ToString, stringToRad50, stringToColor,
stringToProperty
-------------------------------------------------------------------------------
coresidentNodes : returns the coresident nodes on an ACNET node
numNodes = coresidentNodes([node] [,nodeNames])
Arguments:
[node] node of interest
(default is local node)
[nodeNames] returned coresident node names
This function returns values as follows:
number of coresident nodes found
Related functions:
loggersOnNode, oacsOnNode, nodeAcnetTasks, node, nodeIs, nodeIsUp
-------------------------------------------------------------------------------
cos : cosine
resultValue = cos(value)
Arguments:
value value to take the cosine of in radians
This function returns values as follows:
cosine value of the argument
Related functions:
cosd, cosh, sin, sind, sinh, acos, acosd, acosh, asin, asind, asinh
-------------------------------------------------------------------------------
cosd : cosine (argument in degrees)
resultValue = cosd(value)
Arguments:
value value to take the cosine of in degrees
This function returns values as follows:
cosine value of the argument
Related functions:
cos, cosh, sin, sind, sinh, acos, acosd, acosh, asin, asind, asinh
-------------------------------------------------------------------------------
cosecant : cosecant
resultValue = cosecant(value)
Arguments:
value value to take the cosecant of in radians
This function returns values as follows:
cosecant value of the argument
Related functions:
secant, cotan, cotand, tan, tand, tanh, atan, atand, atan2, atan2d,
atanh, cos, cosd, cosh, sin, sind, sinh, acos, acosd, acosh, asin,
asind, asinh
-------------------------------------------------------------------------------
cosh : hyperbolic cosine
resultValue = cosh(value)
Arguments:
value value to take the hyperbolic cosine of
This function returns values as follows:
hyperbolic cosine value of the argument
Related functions:
cos, cosd, sin, sind, sinh, acos, acosd, acosh, asin, asind, asinh
-------------------------------------------------------------------------------
cotan : cotangent
resultValue = cotan(value)
Arguments:
value value to take the cotangent of in radians
This function returns values as follows:
cotangent value of the argument
Related functions:
cotand, tan, tand, tanh, atan, atand, atan2, atan2d, atanh, cos, cosd,
cosh, sin, sind, sinh, acos, acosd, acosh, asin, asind, asinh
-------------------------------------------------------------------------------
cotand : cotangent (argument in degrees)
resultValue = cotand(value)
Arguments:
value value to take the cotangent of in degrees
This function returns values as follows:
cotangent value of the argument
Related functions:
cotan, tan, tand, tanh, atan, atand, atan2, atan2d, atanh, cos, cosd,
cosh, sin, sind, sinh, acos, acosd, acosh, asin, asind, asinh
-------------------------------------------------------------------------------
cpuTime : returns CPU time in milliseconds since ACL was initialized
elapsedTime = cpuTime([prevCpuTime])
Arguments:
[prevCpuTime] reference time
(delta -> CPU time in milliseconds since last call,
scriptStart -> CPU time in milliseconds since the
start of the script
otherwise -> previous CPU time in milliseconds)
(default is 0)
This function returns values as follows:
elapsed time in milliseconds since ACL was initialized
Related functions:
systemTime, 15HzCount, timer, timeAgo, timeFromDate, timeSinceEvent,
stringToDate, dateToString, convertSeconds, julianDate, julianDateToDate
-------------------------------------------------------------------------------
currentSdaFile : returns the current SDA file number for a given usage
fileNumber = currentSdaFile([sdaUsage])
Arguments:
[sdaUsage] desired SDA usage string
(default is "Collider")
This function returns values as follows:
current SDA file number for the requested usage
Related functions:
dateToSdaFile, sdaFileDate, isValidSdaFile, isValidSdaCase,
isValidSdaSet
-------------------------------------------------------------------------------
currentTime : current time in seconds and milliseconds since the Epoch
seconds = currentTime(milliseconds [,timeReference])
Arguments:
milliseconds milliseconds since the start of second
[timeReference] time reference
(delta -> return delta time since previous call,
scriptStart -> return delta time since start
of script)
(default is the beginning of the Epoch)
This function returns values as follows:
seconds since the Epoch
Related functions:
currentTimeInClinks, millisecondsNow, 15hzCount, systemTime, cpuTime,
timer, timeSinceEvent, timeAgo, timeFromDate, stringToDate,
dateToString, convertSeconds, julianDate, julianDateToDate,
localtime
-------------------------------------------------------------------------------
currentTimeInClinks : current time in seconds and milliseconds
since January 1, 1972 00:00 CST
seconds = currentTimeInClinks(milliseconds [,timeReference])
Arguments:
milliseconds milliseconds since the start of second
[timeReference] time reference
(delta -> return delta time since previous call,
scriptStart -> return delta time since start
of script)
(default is the beginning of the Epoch)
This function returns values as follows:
seconds since January 1, 1972 00:00 CST
Synonyms: timeNow
Related functions:
currentTime, millisecondsNow, 15hzCount, systemTime, cpuTime,
timer, timeSinceEvent, timeAgo, timeFromDate, stringToDate,
dateToString, convertSeconds, julianDate, julianDateToDate,
localtime
-------------------------------------------------------------------------------
dateToSdaFile : returns the SDA file number corresponding to a
given date
fileNumber = dateToSdaFile([date] [,sdaUsage])
Arguments:
[date] date value
(default is current time)
[sdaUsage] desired SDA usage string
(default is "Collider")
This function returns values as follows:
corresponding SDA file number
Related functions:
currentSdaFile, sdaFileDate, isValidSdaFile, isValidSdaCase,
isValidSdaSet
-------------------------------------------------------------------------------
dateToString : converts a date value to a string
string = dateToString([formatString] [,date] [,locale])
Arguments:
[formatString] desired format
(standard -> "dd-Mmm-yyyy hh:mm:ss" format (default),
ctime -> "Www Mmm dd hh:mm:ss yyyy" format,
ctime+ -> "Www Mmm dd hh:mm:ss yyyy zzz" format,
compare -> "yyyy-mm-dd hh:mm:ss" format,
timeOfDay -> "hh:mm:ss" format,
otherwise -> format string suitable for use
with strftime)
[date] date value to convert
(default is now)
[locale] time locale
(local -> local time (default),
utc -> UTC time)
This function returns values as follows:
converted date string
Related functions:
stringtoDate, convertSeconds, timeAgo, timeFromDate, timeSinceEvent,
cpuTime, systemTime, 15HzCount, timer, julianDate, julianDateToDate,
currentTimeInClinks, currentTime, localtime
-------------------------------------------------------------------------------
decimal : returns a value as a decimal string
string = decimal(value [,convertLength] [,fillChar] [,dataType])
Arguments:
value value to convert
[convertLength] converted string length
[fillChar] fill character
[dataType] data type
(integer,
float,
double)
(default is to use the native type of the value)
This function returns values as follows:
converted string value
Synonyms: dec, toDec, toDecimal
Related functions:
hex, binary, octal, radix, toString, toTrimmedString, rad50ToString
-------------------------------------------------------------------------------
delenv : deletes an environment variable
status = delenv(envVariable)
Arguments:
envVariable environment variable name
This function returns values as follows:
OK
Related functions:
getenv, setenv, getLogicalName, setLogicalName, deleteLogicalName
-------------------------------------------------------------------------------
deleteLogicalName : deletes a logical name
status = deleteLogicalName(logicalName [,nameType])
Arguments:
logicalName logical name
[nameType] type of logical name
(group (default),
process)
This function returns values as follows:
OK
Related functions:
getLogicalName, setLogicalName, getenv, setenv, delenv
-------------------------------------------------------------------------------
delimitedStringLength : returns the length of a string using delimiters
length = delimitedStringLength(string, delimiters [,maxLength]
[,option])
Arguments:
string string to determine the length of
delimiters string delimiter characters
[maxLength] maximum length to return
(default is infinite)
[option] options
(handleQuotes -> observe quoted strings when searching
for delimiter characters)
This function returns values as follows:
string length
Related functions:
stringLength, nonblankLength, sizeof, sizeofVariable
-------------------------------------------------------------------------------
device : converts an ACNET device to a device index value
deviceIndex = device(device)
Arguments:
device device of interest
This function returns values as follows:
device index value
Related functions:
deviceIndex, name, fullName, text, fullText, deviceSpec
-------------------------------------------------------------------------------
deviceAlarmGroupInfo : returns device alarm group information
alarmGroup = deviceAlarmGroupInfo(device [,isConsolidator] [,dataType])
Arguments:
device device of interest
[isConsolidator] returned boolean indicating whether or not the
requested device is an alarm group consolidator
(TRUE -> device is an alarm group consolidator,
FALSE -> device is not an alarm group consolidator)
[dataType] data type to return
(number -> return alarm group number (default),
name -> return alarm group name)
This function returns values as follows:
device alarm group
Related functions:
deviceAlarmList
-------------------------------------------------------------------------------
deviceAlarmList : returns the device alarm list
alarmList = deviceAlarmList(device [,option] [,dataType])
Arguments:
device device of interest
[option] handling of default alarm list values
(resolveDefault -> resolve a default alarm list
(default),
dontResolveDefault -> don't resolve a default
alarm list)
[dataType] data type to return
(number -> return alarm list number (default),
name -> return alarm list name)
This function returns values as follows:
device alarm list
Related functions:
deviceAlarmGroupInfo, name, fullName, text, fullText,
deviceAtomicLength, deviceDefaultLength, deviceMaximumLength
-------------------------------------------------------------------------------
deviceAtomicLength : returns the atomic length of a device property
in bytes
length = deviceAtomicLength(device [,property])
Arguments:
device device/property of interest
[property] desired property
(reading,
setting,
status,
control,
analogAlarm,
digitalAlarm)
(default is the implicit property from the device
argument)
This function returns values as follows:
atomic length of the device/property in bytes
Related functions:
deviceDefaultLength, deviceMaximumLength, deviceScalingLength,
isArrayDevice, device
-------------------------------------------------------------------------------
deviceBitField : extracts a bit field value from a device reading
fieldValue = deviceBitField(device, startBit [,numBits])
Arguments:
device device/property of interest
startBit starting bit number (starts at 1)
numBits number of bits (default is 1)
This function returns values as follows:
extracted bit field value
Related functions:
device, bitField, bitText, bitDataText
-------------------------------------------------------------------------------
deviceControlAttributes : returns the control attributes for a device
numAttrs = deviceControlAttributes(device [,attributes] [,setValues])
Arguments:
device device of interest
[attributes] returned attribute names
[setValues] returned setting values
This function returns values as follows:
number of control attributes
Related functions:
hasControlAttribute, digitalControlInfoAll, digitalControlInfo,
deviceStatusScalingAll, deviceStatusScaling, hasStatusAttribute
-------------------------------------------------------------------------------
deviceControlledDevices : returns the devices controlled by a device
numControlled = deviceControlledDevices(device [,controlledDevices])
Arguments:
device device of interest
[controlledDevices] returned devices which are controlled by
this device
This function returns values as follows:
number of devices which are controlled by this device
Related functions:
controllingDevice, virtualMachineDevices, deviceInCompositeDevices,
deviceInFamilies
-------------------------------------------------------------------------------
deviceCreator : returns the user who created a device
creator = deviceCreator(device)
Arguments:
device device of interest
This function returns values as follows:
user who created a device
Related functions:
deviceLastModifier, deviceLastModifiedDate, device
-------------------------------------------------------------------------------
deviceCurrentAlarmText : returns the current alarm text for a device
numEntries = deviceCurrentAlarmText(device [,textType] [,alarmText]
[,returnTypes] [,timestamps]
[,rawData] [,masks])
Arguments:
device device of interest
[textType] desired alarm text type
(analog,
digital,
both (default))
[alarmText] returned alarm text strings
[returnTypes] returned alarm text types
(analog,
digital)
[timestamps] returned alarm timestamps
[rawData] returned raw data values
[masks] returned mask values
(only meaningful for digital alarms)
This function returns values as follows:
number of current alarm text entries
Related functions:
analogAlarmText, analogAlarmPriority, digitalAlarmText,
digitalAlarmTextAll
-------------------------------------------------------------------------------
deviceDefaultLength : returns the default length of a device property
in bytes
length = deviceDefaultLength(device [,property])
Arguments:
device device/property of interest
[property] desired property
(reading,
setting,
status,
control,
analogAlarm,
digitalAlarm)
(default is the implicit property from the device
argument)
This function returns values as follows:
default length of the device/property in bytes
Related functions:
deviceAtomicLength, deviceMaximumLength, deviceScalingLength,
isArrayDevice, device
-------------------------------------------------------------------------------
deviceDepartment : returns the department responsible for a device
department = deviceDepartment(device)
Arguments:
device device of interest
This function returns values as follows:
department responsible for a device
Related functions:
deviceMaintainer, device
-------------------------------------------------------------------------------
deviceDescriptionSearch : searches for all devices whose text match
a string
numDevices = deviceDescriptionSearch(string [,deviceNames])
Arguments:
string string to match to device descriptive text
[deviceNames] returned matching device names
This function returns values as follows:
number of matching device names
Related functions:
deviceFullDescriptionSearch, genericDeviceSearch, deviceNameSearch,
deviceFullNameSearch, deviceNodeSearch, deviceSsdnSearch
-------------------------------------------------------------------------------
deviceDigitalStatus : returns a device digital status value
status = deviceDigitalStatus(device [,onOffStatus] [,readyTripStatus]
[,remoteLocalStatus] [,polarityStatus]
[,rampDcStatus] [,statusType] [,arrayIndex]
[,dataEvent] [,dataSource])
Arguments:
device device of interest
[onOffStatus] returned on/off status
[readyTripStatus] returned ready/tripped status
[remoteLocalStatus] returned remote/local status
[polarityStatus] returned polarity status
[rampDcStatus] returned ramp/DC status
[statusType] type of status to return
(logicals -> logical value (default),
shortStrings -> short strings,
longStrings -> long strings)
[arrayIndex] device array index (default is 0)
[dataEvent] device reading data event
(default is database default)
[dataSource] device data source (default is accelerator)
This function returns values as follows:
composite status string
Related functions:
deviceValue, deviceValueText, deviceStatusScaling,
deviceStatusScalingAll, hasStatusAttribute
-------------------------------------------------------------------------------
deviceDownloadProperties : returns the download properties associated
with a device
numProperties = deviceDownloadProperties(device [,properties]
[,filterProps])
Arguments:
device device of interest
[properties] returned array of properties found
[filterProps] property or properties to match
(If you want to match multiple properties,
separate property strings with an '|'
or ',' character.)
(default is all properties)
This function returns values as follows:
number of download properties found for the requested device
Related functions:
deviceIsDownloaded, deviceProperties, numReadableProperties,
numSettableProperties, hasProperty, hasReading, hasSetting,
hasStatus, hasControl, hasAnalogAlarm, hasDigitalAlarm, device
-------------------------------------------------------------------------------
deviceEmc : returns the EMC for a device property
emcLongword = deviceEmc(device, emc [,property])
Arguments:
device device/property of interest
emc returned EMC value
(If this argument has a data type of short,
the EMC value is returned as 4 shorts.
If this argument has a data type of integer,
the EMC value is returned as 2 integers.
Otherwise, the EMC is returned as 8 bytes.)
[property] desired property
(analogAlarm,
digitalAlarm)
(default is the implicit property from the device
argument)
This function returns values as follows:
first 4 bytes of the EMC
Related functions:
deviceSsdn
-------------------------------------------------------------------------------
deviceExpression : returns the expression for a device
expression = deviceExpression(device)
Arguments:
device device of interest
This function returns values as follows:
device expression
Related functions:
name
-------------------------------------------------------------------------------
deviceFamilyMembers : returns the members of a family device
numMembers = deviceFamilyMembers(device [,members] [,fullNames])
Arguments:
device device of interest (should be a family device)
[members] returned family member devices
[fullNames] flag indicating whether or not to return
full device names
(fullNames -> want full device names,
normalNames -> want normal device names (default))
This function returns values as follows:
number of family members
Related functions:
deviceInFamilies, deviceInCompositeDevices, deviceControlledDevices,
virtualMachineDevices
-------------------------------------------------------------------------------
deviceFullDescriptionSearch : searches for all devices whose full
descriptions match a string
numDevices = deviceFullDescriptionSearch(string [,deviceNames])
Arguments:
string string to match to device full descriptions
[deviceNames] returned matching device full names
This function returns values as follows:
number of matching device names
Related functions:
deviceDescriptionSearch, genericDeviceSearch, deviceFullNameSearch,
deviceNameSearch, deviceNodeSearch, deviceSsdnSearch
-------------------------------------------------------------------------------
deviceFullNameSearch : searches for all devices whose full names
match a string
numDevices = deviceFullNameSearch(string [,deviceNames])
Arguments:
string string to match to device full names
[deviceNames] returned matching device full names
This function returns values as follows:
number of matching device names
Related functions:
deviceNameSearch, genericDeviceSearch, deviceDescriptionSearch,
deviceFullDescriptionSearch, deviceNodeSearch, deviceSsdnSearch
-------------------------------------------------------------------------------
deviceFullNameToName : returns the device name corresponding to a
full name
name = deviceFullNameToName(fullName)
Arguments:
fullName full name to convert
This function returns values as follows:
corresponding normal device name
Related functions:
deviceNameToFullName, stringToDeviceName
-------------------------------------------------------------------------------
deviceInCompositeDevices : returns composite devices which use a
given device
numComposites = deviceInCompositeDevices(device [,composites])
Arguments:
device device of interest
[composites] returned composite devices which use this device
This function returns values as follows:
number of composite devices which use this device
Related functions:
deviceInFamilies
-------------------------------------------------------------------------------
deviceIndex : converts an ACNET device to a device index value
deviceIndex = deviceIndex(device)
Arguments:
device device of interest
This function returns values as follows:
device index value
Related functions:
device, name, fullName, text, fullText, deviceSpec
-------------------------------------------------------------------------------
deviceInFamilies : returns families that a device is a member of
numFamilies = deviceInFamilies(device [,families])
Arguments:
device device of interest
[families] returned families that the device is a membe of
This function returns values as follows:
number of families that the device is a membe of
Related functions:
deviceFamilyMembers, deviceInCompositeDevices
-------------------------------------------------------------------------------
deviceIsDownloaded : determines if a device property is downloaded
upon front end reboot
isDownloaded = deviceIsDownloaded(device [,property])
Arguments:
device device to check
[property] desired property
(setting,
basicControl,
analogAlarm,
digitalAlarm)
(default is the implicit property from the
device argument)
This function returns values as follows:
TRUE device property is downloaded upon reboot
FALSE device property is not downloaded upon reboot
Related functions:
deviceDownloadProperties
-------------------------------------------------------------------------------
deviceIsSettableByClass : determines if a device can be set by a
console class
isSettable = deviceIsSettableByClass(device, console_class)
Arguments:
device device of interest
console_class class(es) to test for
This function returns values as follows:
logical value which indicates whether or not the device can be set
Related functions:
settingsAreEnabled
-------------------------------------------------------------------------------
deviceLastModifiedDate : returns the date when a device was last
modified
date = deviceLastModifiedDate(device)
Arguments:
device device of interest
This function returns values as follows:
date when the device was last modified
Related functions:
deviceLastModifier, deviceCreator, device
-------------------------------------------------------------------------------
deviceLastModifier : returns the user who last modified a device
modifier = deviceLastModifier(device)
Arguments:
device device of interest
This function returns values as follows:
user who last modified a device
Related functions:
deviceLastModifiedDate, deviceCreator, device
-------------------------------------------------------------------------------
deviceListing : creates formatted device information strings
numLines = deviceListing(devices [,numDevices] [,formatString]
[,strings] [,dataSource] [,headerFlag]
[,filters])
Arguments:
devices devices to cache database information for
(either an array of device names or a
device list specifier (deviceList={list}))
[numDevices] number of devices (default is all devices specified)
[formatString] output format string
(%nm -> output device name,
%tx -> output device description,
etc.)
(See the ACL list command help for more format
specifier options. You can also see the help
for the CLIB routine device_listing_c.)
[strings] returned output strings (one per device)
[dataSource] data source for reading output fields
(accelerator -> live readings (default),
db -> database,
sr:{file} -> save/restore file,
sda:{file}:{case}:{set}:usage} -> SDA data set,
dl:{date}:{node} -> data logger)
[headerFlag] header line flag
{noHeaders (default),
allowHeaders)
[filters] comma separated device filters
(hasReading -> only include devices having a reading,
hasSetting -> only include devices having a setting,
hasStatus -> only include devices having status,
hasControl -> only include devices having control,
hasAnalogAlarm -> only include devices having an
analog alarm,
hasDigitalAlarm -> only include devices having a
digital alarm,
analogAlarm -> only include devices in analog alarm,
analogBypassed -> only include devices with their
analog alarm bypassed,
digitalAlarm -> only include devices in digital alarm,
digitalBypassed -> only include devices with their
digital alarm bypassed,
broken/oos -> only include devices that are marked as
broken/out of service,
readingArray -> only include devices whose reading
property is an array,
settingArray -> only include devices whose setting
property is an array,
statusArray -> only include devices whose status
property is an array,
readSizeMismatch -> only include devices whose
default reading property length
does not match its scaling length,
setSizeMismatch -> only include devices whose
default setting property length
does not match its scaling length)
This function returns status values as follows:
number of strings returned
Related functions:
genericDeviceSearch, deviceNameSearch, deviceFullNameSearch,
deviceDescriptionSearch, deviceFullDescriptionSearch, deviceNodeSearch,
deviceSsdnSearch, cacheDeviceInfo
-------------------------------------------------------------------------------
deviceListToDevices : retrieves the devices from a device list
numDevices = deviceListToDevices(listName [,deviceNames] [,properties]
[,filterProps] [,fullNames])
Arguments:
listName device list name
[deviceNames] returned device names
[properties] returned array of properties found
[filterProps] property or properties to match
(If you want to match multiple properties,
separate property strings with an '|'
or ',' character.)
(default is all properties)
[fullNames] flag indicating whether or not to return
full device names
(fullNames -> want full device names,
normalNames -> want normal device names (default))
This function returns values as follows:
number of devices
Related functions:
genericDeviceSearch, deviceNameSearch, deviceFullNameSearch,
deviceDescriptionSearch, deviceFullDescriptionSearch,
deviceNodeSearch, deviceSsdnSearch
-------------------------------------------------------------------------------
deviceMaintainer : returns the person responsible for
maintaining a device
maintainer = deviceMaintainer(device)
Arguments:
device device of interest
This function returns values as follows:
person responsible for maintaining a device
Related functions:
deviceDepartment, device
-------------------------------------------------------------------------------
deviceMaximumLength : returns the maximum length of a device property
in bytes
length = deviceMaximumLength(device [,property])
Arguments:
device device/property of interest
[property] desired property
(reading,
setting,
status,
control,
analogAlarm,
digitalAlarm)
(default is the implicit property from the device
argument)
This function returns values as follows:
maximum length of the device/property in bytes
Related functions:
deviceDefaultLength, deviceAtomicLength, deviceScalingLength,
isArrayDevice, device
-------------------------------------------------------------------------------
deviceNameSearch : searches for all devices whose names match a string
numDevices = deviceNameSearch(string [,deviceNames])
Arguments:
string string to match to device names
[deviceNames] returned matching device names
This function returns values as follows:
number of matching device names
Related functions:
deviceFullNameSearch, genericDeviceSearch, deviceDescriptionSearch,
deviceFullDescriptionSearch, deviceNodeSearch, deviceSsdnSearch
-------------------------------------------------------------------------------
deviceNameToFullName : returns the full device name corresponding
to a name
fullName = deviceNameToFullName(name)
Arguments:
name device name to convert
This function returns values as follows:
corresponding full device name
Related functions:
deviceFullNameToName, stringToDeviceName
-------------------------------------------------------------------------------
deviceNode : returns the source node for a device property
node = deviceNode(device [,property])
Arguments:
device device/property of interest
[property] desired property
(global -> overall device node,
reading,
setting,
status,
control,
analogAlarm,
digitalAlarm)
(default is the implicit property from the device
argument)
This function returns values as follows:
device node
Related functions:
deviceNodeType, isMoocDevice, isIrmDevice, isOacDevice, isLabviewDevice,
isAcsysFefDevice, name, fullName, text, fullText, deviceAtomicLength,
deviceDefaultLength, deviceMaximumLength
-------------------------------------------------------------------------------
deviceNodeSearch : searches for all devices from a given node
numDevices = deviceNodeSearch(node [,deviceNames] [,property])
Arguments:
node node to match
[deviceNames] returned matching device names
[property] property or properties to match
(If you want to match multiple properties,
separate property strings with an '|'
or ',' character.)
(default is all properties)
This function returns values as follows:
number of matching device names
Related functions:
genericDeviceSearch, deviceNameSearch, deviceFullNameSearch,
deviceDescriptionSearch, deviceFullDescriptionSearch, deviceSsdnSearch
-------------------------------------------------------------------------------
deviceNodeType : returns the node type for a device property
nodeType = deviceNodeType(device [,property])
Arguments:
device device/property of interest
[property] desired property
(global -> overall device node,
reading,
setting,
status,
control,
analogAlarm,
digitalAlarm)
(default is the implicit property from the device
argument)
This function returns values as follows:
string indicating the device node type
Related functions:
deviceNode, isMoocDevice, isIrmDevice, isOacDevice, isLabviewDevice,
isAcsysFefDevice
-------------------------------------------------------------------------------
deviceParameterPageMapping : returns device parameter page mapping
instances
numSubpages = deviceParameterPageMapping(device [,pages] [,subpageText]
[,subpages] [,rows]
[,arrayIndices])
Arguments:
device device to search for
[pages] returned matching parameter pages
[subpageText] returned subpage text including page title
[subpages] returned matching subpages (integer)
[rows] returned matching subpage rows
[arrayIndices] returned matching device array indices
This function returns values as follows:
number of matching parameter page subpages
Related functions:
none
-------------------------------------------------------------------------------
devicePrimaryToScaled : scales a primary device value
value = devicePrimaryToScaled(device, primaryValue [,property]
[,unitsText])
Arguments:
device device to use for scaling
primaryValue primary data value
[property] desired property
(reading,
setting)
(default is the implicit property from the
device argument)
[unitsText] common scaling units text
This function returns values as follows:
value corresponding to the requested primary data
Related functions:
deviceScaledToPrimary, devicePrimaryToScaledCustom, deviceRawToScaled,
deviceRawToValueText, deviceRawToValueTextCustom,
deviceRawToScaledCustom, deviceScaledToRaw, deviceScaledToRawCustom,
deviceRawToStatusText, deviceRawToStatusValue, deviceRawToControlText,
deviceRawToEnumText, deviceRawToHistoricScaled
-------------------------------------------------------------------------------
devicePrimaryToScaledCustom : scale a primary device value using
caller-supplied scaling parameters
value = devicePrimaryToScaledCustom(primaryValue commonTrans
[,constant1..6])
Arguments:
primaryValue primary data value
commonTrans common transform number
[constant1..6] up to 6 scaling constants for the common transform
This function returns values as follows:
value corresponding to the requested primary data
Related functions:
devicePrimaryToScaled, deviceScaledToPrimary, deviceRawToScaled,
deviceRawToValueText, deviceRawToValueTextCustom,
deviceRawToScaledCustom, deviceScaledToRaw, deviceScaledToRawCustom,
deviceRawToStatusText, deviceRawToStatusValue, deviceRawToControlText,
deviceRawToEnumText, deviceRawToHistoricScaled
-------------------------------------------------------------------------------
deviceProperties : returns the properties associated with a device
numProperties = deviceProperties(device [,properties] [,filterProps])
Arguments:
device device of interest
[properties] returned array of properties found
[filterProps] property or properties to match
(If you want to match multiple properties,
separate property strings with an '|'
or ',' character.)
(default is all properties)
This function returns values as follows:
number of properties found for the requested device
Related functions:
numReadableProperties, numSettableProperties, hasProperty, hasReading,
hasSetting, hasStatus, hasControl, hasAnalogAlarm, hasDigitalAlarm,
deviceDownloadProperties, device
-------------------------------------------------------------------------------
deviceProtectionMask : returns the device setting protection mask
protectionMask = deviceProtectionMask(device)
Arguments:
device device of interest
This function returns values as follows:
device protection mask
Related functions:
consoleClassMaskToString, stringToConsoleClassMask, name, fullName,
text, fullText, deviceAtomicLength, deviceDefaultLength,
deviceMaximumLength
-------------------------------------------------------------------------------
deviceRawToControlText : scale a raw control value to a text string
string = deviceRawToControlText(device, rawValue [,stringType])
Arguments:
device device to use for scaling
rawValue raw control value
[stringType] string type
(short -> short text (default),
long -> long text)
This function returns values as follows:
string corresponding to the requested control value
Related functions:
deviceRawToStatusText, deviceRawToStatusValue, deviceRawToEnumText,
deviceRawToScaled, deviceRawToValueText, deviceRawToValueTextCustom,
deviceRawToScaledCustom, deviceScaledToRaw, deviceScaledToRawCustom
-------------------------------------------------------------------------------
deviceRawToEnumText : scale a raw enumerated reading value to a
text string
string = deviceRawToEnumText(device, rawValue [,stringType])
Arguments:
device device to use for scaling
rawValue raw data value
[stringType] string type
(short -> short text (default),
long -> long text)
This function returns values as follows:
string corresponding to the requested data value
Related functions:
deviceRawToStatusText, deviceRawToStatusValue, deviceRawToControlText,
deviceRawToScaled, deviceRawToValueText, deviceRawToValueTextCustom,
deviceRawToScaledCustom, deviceScaledToRaw, deviceScaledToRawCustom
-------------------------------------------------------------------------------
deviceRawToHistoricScaled : scale a raw device value using historic
scaling
value = deviceRawToHistoricScaled(device, rawValue, date
[,statusAttr])
Arguments:
device device to use for scaling
rawValue raw data value
date date of scaling information
[statusAttr] status attribute for basic status request
(onOff -> on/off status,
readyTripped -> ready/tripped status,
remoteLocal -> remote/local status,
polarity -> positive/negative status,
rampDC -> ramp/DC status)
This function returns values as follows:
value corresponding to the requested raw data
Related functions:
deviceRawToScaled, deviceRawToScaledCustom, deviceRawToValueText,
deviceRawToValueTextCustom, deviceScaledToRaw, deviceScaledToRawCustom,
deviceRawToStatusText, deviceRawToStatusValue, deviceRawToControlText,
deviceRawToEnumText
-------------------------------------------------------------------------------
deviceRawToScaled : scale a raw device value
value = deviceRawToScaled(device, rawValue [,statusAttr])
Arguments:
device device to use for scaling
rawValue raw data value
[statusAttr] status attribute for basic status request
(onOff -> on/off status,
readyTripped -> ready/tripped status,
remoteLocal -> remote/local status,
polarity -> positive/negative status,
rampDC -> ramp/DC status)
This function returns values as follows:
value corresponding to the requested raw data
Related functions:
deviceRawToValueText, deviceRawToScaledCustom,
deviceRawToValueTextCustom, deviceScaledToRaw, deviceScaledToRawCustom,
deviceRawToStatusText, deviceRawToStatusValue, deviceRawToControlText,
deviceRawToEnumText, deviceRawToHistoricScaled
-------------------------------------------------------------------------------
deviceRawToScaledCustom : scale a raw device value using
caller-supplied scaling parameters
value = deviceRawToScaledCustom(device, rawValue, primaryTrans,
commonTrans [,constant1..6])
Arguments:
device device to use for scaling
rawValue raw data value
primaryTrans primary transform number
commonTrans common transform number
[constant1..6] up to 6 scaling constants for the common transform
This function returns values as follows:
value corresponding to the requested raw data
Related functions:
deviceRawToScaled, deviceRawToValueText, deviceRawToValueTextCustom,
deviceScaledToRaw, deviceScaledToRawCustom, deviceRawToStatusText,
deviceRawToStatusValue, deviceRawToControlText, deviceRawToEnumText
-------------------------------------------------------------------------------
deviceRawToStatusText : scale a raw status value to a text string
string = deviceRawToStatusText(device, rawValue, statusAttr)
Arguments:
device device to use for scaling
rawValue raw status value
statusAttr string indicating which status attribute is desired
(onOff -> on/off status,
readyTripped -> ready/tripped status,
remoteLocal -> remote/local status,
polarity -> positive/negative status,
rampDC -> ramp/DC status)
This function returns values as follows:
string corresponding to the requested status attribute
Related functions:
deviceRawToStatusValue, deviceRawToControlText, deviceRawToEnumText,
deviceRawToScaled, deviceRawToValueText, deviceRawToValueTextCustom,
deviceRawToScaledCustom, deviceScaledToRaw, deviceScaledToRawCustom
-------------------------------------------------------------------------------
deviceRawToStatusValue : scale a raw status value to a boolean
attribute value
status = deviceRawToStatusValue(device, rawValue, statusAttr)
Arguments:
device device to use for scaling
rawValue raw status value
statusAttr string indicating which status attribute is desired
(onOff -> on/off status,
readyTripped -> ready/tripped status,
remoteLocal -> remote/local status,
polarity -> positive/negative status,
rampDC -> ramp/DC status)
This function returns values as follows:
TRUE "first" status asserted
FALSE "second" status asserted
Related functions:
deviceRawToStatusText, deviceRawToControlText, deviceRawToEnumText,
deviceRawToScaled, deviceRawToValueText, deviceRawToValueTextCustom,
deviceRawToScaledCustom, deviceScaledToRaw, deviceScaledToRawCustom
-------------------------------------------------------------------------------
deviceRawToValueText : scale a raw value to its corresponding string
string = deviceRawToValueText(device, rawValue [,statusAttr])
Arguments:
device device to use for scaling
rawValue raw data value
[statusAttr] status attribute for basic status request
(composite -> composite text (default),
onOff -> on/off status,
readyTripped -> ready/tripped status,
remoteLocal -> remote/local status,
polarity -> positive/negative status,
rampDC -> ramp/DC status)
This function returns values as follows:
string corresponding to the requested raw data
Related functions:
deviceRawToValueTextCustom, deviceRawToScaled, deviceRawToScaledCustom,
deviceScaledToRaw, deviceScaledToRawCustom, deviceRawToStatusText,
deviceRawToStatusValue, deviceRawToControlText, deviceRawToEnumText,
deviceRawToHistoricScaled
-------------------------------------------------------------------------------
deviceRawToValueTextCustom : scale a raw value to its corresponding
string using caller-supplied scaling
string = deviceRawToValueTextCustom(device, rawValue [,stringLength]
[,stringFormat] [,primaryTrans]
[,commonTrans] [,constant1...6])
Arguments:
device device to use for scaling
rawValue raw data value
[stringLength] desired string length
(default is the default length for the scaling type)
[stringFormat] desired string format
(noSpaces - simple trimmed string (default),
spacePadded - blank padded to the requested length,
uniformLength - blank padded to 10 characters)
[primaryTrans] primary transform number
(default is the device's current primary transform)
[commonTrans] common transform number
(default is the device's current common transform)
[constant1...6] up to 6 scaling constants for the common transform
This function returns values as follows:
value corresponding to the requested raw data
Related functions:
deviceRawToValueText, deviceRawToScaledCustom, deviceRawToScaled,
deviceScaledToRaw, deviceScaledToRawCustom, deviceRawToStatusText,
deviceRawToStatusValue, deviceRawToControlText, deviceRawToEnumText
-------------------------------------------------------------------------------
deviceReadSetExtScaling : return extended reading or setting scaling
information
commonTransform = deviceReadSetExtScaling(device [,property]
[,primaryTransform]
[,commonTransform]
[,numConstants] [,constants]
[,primaryUnits] [,commonUnits]
[,scalingLength]
[,displayLength]
[,displayType])
Arguments:
device device/property of interest
[property] desired property
(reading,
setting)
(default is the implicit property from the
device argument)
[primaryTransform] primary transform number
[commonTransform] common transform number
[numConstants] number of scaling constants
[constants] array of scaling constants
(numConstants values)
[primaryUnits] primary scaling units text
[commonUnits] common scaling units text
[scalingLength] scaling data length in bytes
[displayLength] default number of characters to display
[displayType] display value conversion type
This function returns values as follows:
common transform number
Related functions:
deviceReadSetScaling, deviceScalingLength, units, deviceRawToScaled,
deviceRawToScaledCustom, deviceScaledToRaw, deviceScaledToRawCustom,
deviceValue, deviceValueText, deviceReadSetHistoricScaling
-------------------------------------------------------------------------------
deviceReadSetHistoricScaling : return reading or setting historic
scaling information
commonTransform = deviceReadSetHistoricScaling(device, date [,property]
[,primaryTransform]
[,commonTransform]
[,numConstants]
[,constants]
[,primaryUnits]
[,commonUnits]
[,scalingLength]
[,displayLength]
[,displayType])
Arguments:
device device/property of interest
date date of scaling information
[property] desired property
(reading,
setting)
(default is the implicit property from the
device argument)
[primaryTransform] primary transform number
[commonTransform] common transform number
[numConstants] number of scaling constants
[constants] array of scaling constants
(numConstants values)
[primaryUnits] primary scaling units text
[commonUnits] common scaling units text
[scalingLength] scaling data length in bytes
[displayLength] default number of characters to display
[displayType] display value conversion type
This function returns values as follows:
common transform number
Related functions:
deviceReadSetScaling, deviceReadSetExtScaling, deviceScalingLength,
units, deviceRawToScaled, deviceRawToScaledCustom, deviceScaledToRaw,
deviceScaledToRawCustom, deviceValue, deviceValueText
-------------------------------------------------------------------------------
deviceReadSetScaling : return reading or setting scaling information
commonTransform = deviceReadSetScaling(device [,property]
[,primaryTransform]
[,commonTransform]
[,numConstants] [,constants]
[,primaryUnits] [,commonUnits]
[,scalingLength] [,displayLength]
[,displayType])
Arguments:
device device/property of interest
[property] desired property
(reading,
setting)
(default is the implicit property from the
device argument)
[primaryTransform] returned primary transform number
[commonTransform] returned common transform number
[numConstants] returned number of scaling constants
[constants] returned array of scaling constants
(numConstants values)
[primaryUnits] returned primary scaling units text
[commonUnits] returned common scaling units text
[scalingLength] returned scaling data length in bytes
[displayLength] returned default number of characters to display
[displayType] returned display value conversion type
This function returns values as follows:
common transform number
Related functions:
deviceReadSetExtScaling, deviceScalingLength, units, deviceRawToScaled,
deviceRawToScaledCustom, deviceScaledToRaw, deviceScaledToRawCustom,
deviceValue, deviceValueText, deviceReadSetHistoricScaling
-------------------------------------------------------------------------------
deviceScaledToPrimary : convert a scaled device value to a primary value
value = deviceScaledToPrimary(device, scaledValue [,property]
[,unitsText])
Arguments:
device device to use for scaling
scaledValue scaled data value
[property] desired property
(reading,
setting)
(default is the implicit property from the
device argument)
[unitsText] primary scaling units text
This function returns values as follows:
primary value corresponding to the requested scaled data
Related functions:
devicePrimaryToScaled, devicePrimaryToScaledCustom, deviceScaledToRaw,
deviceScaledToRawCustom, deviceRawToScaled, deviceRawToScaledCustom,
deviceRawToStatusText, deviceRawToStatusValue, deviceRawToControlText,
deviceRawToEnumText
-------------------------------------------------------------------------------
deviceScaledToRaw : convert a scaled device value to a raw value
value = deviceScaledToRaw(device, scaledValue [,scalingType])
Arguments:
device device to use for scaling
scaledValue scaled data value
(This will be treated as a floating point value
for reading or setting and as a string for
basic control values.)
[scalingType] scaling type for a reading or setting request
(common -> engineering units (default),
primary -> primary units)
This function returns values as follows:
raw value corresponding to the requested scaled data
Related functions:
deviceScaledToRawCustom, deviceRawToScaled, deviceRawToScaledCustom,
deviceScaledToPrimary, deviceRawToStatusText, deviceRawToStatusValue,
deviceRawToControlText, deviceRawToEnumText,
-------------------------------------------------------------------------------
deviceScaledToRawCustom : reverse scale a scaled device value using
caller-supplied scaling parameters
rawValue = deviceScaledToRawCustom(device, scaledValue, primaryTrans,
commonTrans [,constant1..6])
Arguments:
device device to use for scaling
scaledValue scaled data value
primaryTrans primary transform number
commonTrans common transform number
[constant1..6] up to 6 scaling constants for the common transform
This function returns values as follows:
raw value corresponding to the requested scaled value
Related functions:
deviceScaledToRaw, deviceRawToScaledCustom, deviceRawToScaled,
deviceRawToValueText, deviceRawToValueTextCustom,
deviceRawToStatusText, deviceRawToStatusValue,
deviceRawToControlText, deviceRawToEnumText
-------------------------------------------------------------------------------
deviceScalingLength : returns the scaling length of a device property
in bytes
length = deviceScalingLength(device [,property])
Arguments:
device device/property of interest
[property] desired property
(reading,
setting,
status,
control,
analogAlarm,
digitalAlarm)
(default is the implicit property from the device
argument)
This function returns values as follows:
scaled data length of the device/property in bytes
Related functions:
deviceDefaultLength, deviceAtomicLength, deviceMaximumLength, device,
deviceReadSetScaling
-------------------------------------------------------------------------------
deviceSpec : converts a value to a device specification
deviceIndex = deviceSpec(value, device [,allowObsolete])
Arguments:
value value to convert
device output device specification
(variable or changeable device)
[allowObsolete] flag indicating whether or not to allow obsolete devices
(obsolete -> allow obsolete devices,
noObsolete -> don't allow obsolete devices (default))
This function returns values as follows:
device index value
Related functions:
device
-------------------------------------------------------------------------------
deviceSsdn : returns the SSDN for a device property
ssdnLongword = deviceSsdn(device, ssdn [,property])
Arguments:
device device/property of interest
ssdn returned SSDN value
(If this argument has a data type of short,
the SSDN value is returned as 4 shorts.
If this argument has a data type of integer,
the SSDN value is returned as 2 integers.
Otherwise, the SSDN is returned as 8 bytes.)
[property] desired property
(reading,
setting,
status,
control,
analogAlarm,
digitalAlarm)
(default is the implicit property from the device
argument)
This function returns values as follows:
first 4 bytes of the SSDN
Related functions:
ssdnToString, stringToSsdn, name, fullName, text, fullText,
deviceAtomicLength, deviceDefaultLength, deviceMaximumLength,
deviceEmc, deviceSsdr
-------------------------------------------------------------------------------
deviceSsdnSearch : searches for all devices whose SSDNs match a pattern
numDevices = deviceSsdnSearch(ssdn [,compareFlags] [,deviceNames]
[,node] [,fullNames])
Arguments:
ssdn SSDN values to match (8 bytes) or SSDN match string
having the form of 'xxxx/nnnn/xxxx/xxxx' where bytes
indicated by 'xx' are not compared
[compareFlags] array of 8 logicals indicating which bytes to compare
(default is to compare all bytes)
(This argument is ignored if the first argument is
an SSDN match string.)
[deviceNames] returned matching device names
[node] node to match (default is all nodes)
[fullNames] flag indicating whether or not to return
full device names
(fullNames -> want full device names,
normalNames -> want normal device names (default))
This function returns values as follows:
number of matching device names
Related functions:
genericDeviceSearch, deviceNameSearch, deviceFullNameSearch,
deviceDescriptionSearch, deviceFullDescriptionSearch, deviceNodeSearch
-------------------------------------------------------------------------------
deviceSsdr : returns the SSDR for a device property
ssdrLength = deviceSsdr(device, ssdr)
Arguments:
device device of interest
ssdr returned SSDR value
(If this argument has a data type of short,
the SSDR value is returned as an array of shorts.
If this argument has a data type of integer,
the SSDR value is returned as an array of integers.
Otherwise, the SSDR is returned as an array of bytes.)
This function returns values as follows:
length of the SSDR in bytes
Related functions:
deviceSsdn, deviceEmc
-------------------------------------------------------------------------------
deviceState : returns the state of a device
(valid, obsolete, or invalid)
stateString = deviceState(device)
Arguments:
device device of interest
This function returns values as follows:
valid valid/normal device
obsolete obsolete device
invalid invalid device
Related functions:
isObsoleteDevice, device, deviceIndex, name, fullName, text,
fullText, deviceSpec
-------------------------------------------------------------------------------
deviceStatusScaling : returns status scaling information for a device
attrExists = deviceStatusScaling(device, attribute [,attrMask]
[,invertFlag] [,matchChar]
[,nonmatchChar] [,matchColor]
[,nonmatchColor] [,altCharFlag])
Arguments:
device device of interest
attribute desired status attribute
(onOff,
readyTripped,
remoteLocal,
positiveNegative,
rampDC)
[attrMask] returned status attribute mask
[invertFlag] returned status data invert flag
[matchChar] returned character to display if the data
matches the mask
[nonmatchChar] returned character to display if the data
does not match the mask
[matchColor] returned color to display if the data
matches the mask
[nonmatchColor] returned color to display if the data
does not match the mask
[altCharFlag] returned alternate character definition flag
This function returns values as follows:
TRUE status attribute exists
FALSE status attribute does not exist
Related functions:
deviceStatusScalingAll, hasStatusAttribute, hasControlAttribute,
deviceControlAttributes, digitalControlInfo, digitalControlInfoAll,
deviceScalingLength, deviceReadSetScaling, deviceReadSetExtScaling
-------------------------------------------------------------------------------
deviceStatusScalingAll : returns all status scaling information for
a device
numAttrs = deviceStatusScalingAll(device [,attrDefFlags]
[,attrMasks] [,invertFlags]
[,matchChars] [,nonmatchChars]
[,matchColors] [,nonmatchColors]
[,altCharFlags] [,attrNames])
Arguments:
device device of interest
[attrDefFlags] returned status attribute definition flags
[attrMasks] returned status attribute masks
[invertFlags] returned status data invert flags
[matchChars] returned characters to display if the data
matches the mask
[nonmatchChars] returned characters to display if the data
does not match the mask
[matchColors] returned colors to display if the data
matches the mask
[nonmatchColors] returned colors to display if the data
does not match the mask
[altCharFlags] returned alternate character definition flags
[attrNames] returned attribute names
This function returns values as follows:
number of attribute values returned
Related functions:
deviceStatusScaling, hasStatusAttribute, digitalControlInfoAll,
digitalControlInfo, deviceControlAttributes, hasControlAttribute,
deviceScalingLength, deviceReadSetScaling, deviceReadSetExtScaling
-------------------------------------------------------------------------------
deviceStructureName : returns the structure name for a device property
structureName = deviceStructureName(device [,property])
Arguments:
device device/property of interest
[property] desired property
(reading,
setting)
(default is the implicit property from the device
argument)
This function returns values as follows:
device structure name
Related functions:
deviceAtomicLength, deviceDefaultLength, deviceMaximumLength
-------------------------------------------------------------------------------
deviceType : returns the type of a device property
type = deviceType(device [,property] [,class] [,source] [,returnType])
Arguments:
device device/property of interest
[property] desired property
(reading,
setting,
status,
control,
analogAlarm,
digitalAlarm)
(default is the implicit property from the device
argument)
[class] returned device class string
[source] source of device type information
(live -> determine the type at the time of the call
(default),
db -> return the device type stored in the database)
[returnType] type of returned data
(text -> return short text (default),
longText -> return long text,
numeric -> return numeric values (ids))
This function returns values as follows:
device type string
Related functions:
device
-------------------------------------------------------------------------------
deviceValue : returns a numeric device value
value = deviceValue(device [,property] [,arrayIndex] [,dataEvent]
[,dataSource] [,scalingType])
Arguments:
device device of interest
[property] desired property
(reading,
setting)
(default is the implicit property from the device
argument)
[arrayIndex] array index
(default is 0)
*[dataEvent] data event string
(default is a one shot reading)
*[dataSource] data source
(default is live reading)
*[scalingType] scaling type
(common -> engineering units (default),
primary -> primary units,
raw -> raw units)
* - denotes arguments that can come in any relative order
This function returns values as follows:
numeric device reading
Related functions:
deviceValueText, deviceDigitalStatus, alarmBlockFieldValue,
device, name, fullName, text, fullText,
-------------------------------------------------------------------------------
deviceValueText : returns a device value as a string
string = deviceValueText(device [,property] [,arrayIndex] [,dataEvent]
[,dataSource] [,scalingType])
Arguments:
device device of interest
[property] desired property
(reading,
setting)
(default is the implicit property from the device
argument)
[arrayIndex] array index
(default is 0)
*[dataEvent] data event string
(default is a one shot reading)
*[dataSource] data source
(default is live reading)
*[scalingType] scaling type
(common -> engineering units (default),
primary -> primary units,
raw -> raw units)
* - denotes arguments that can come in any relative order
This function returns values as follows:
device reading string
Synonyms: deviceValueString
Related functions:
deviceValue, deviceDigitalStatus, alarmBlockFieldValue,
deviceRawToValueText, deviceRawToValueTextCustom,
device, name, fullName, text, fullText
-------------------------------------------------------------------------------
deviceVirtualMachine : returns device virtual machine information
virtualDevice = deviceVirtualMachine(device [,numProps] [,properties])
Arguments:
device device of interest
[numProps] returned number of properties affected by the
virtual machine device
[properties] returned properties affected by the
virtual machine device
This function returns values as follows:
virtual machine device
Related functions:
controllingDevice
-------------------------------------------------------------------------------
digitalAlarmText : returns the digital alarm text for a device
string = digitalAlarmText(device [,maskValue])
Arguments:
device device of interest
[maskValue] digital mask value
(default is the raw reading of the basic status)
This function returns values as follows:
digital alarm text
Related functions:
digitalAlarmTextAll, analogAlarmText, analogAlarmPriority,
deviceCurrentAlarmText
-------------------------------------------------------------------------------
digitalAlarmTextAll : returns all of the digital alarm text for
a device
numEntries = digitalAlarmTextAll(device [,maskValues] [,text]
[,priorities])
Arguments:
device device of interest
[maskValues] returned mask values
[text] returned text strings
[priorities] returned alarm priorities
This function returns values as follows:
number of digital alarm text entries
Related functions:
digitalAlarmText, analogAlarmText, analogAlarmPriority,
deviceCurrentAlarmText
-------------------------------------------------------------------------------
digitalControlInfo : returns digital control info for a device
wasFound = digitalControlInfo(device, searchValue [,searchType]
[,orderNumber] [,value] [,text]
[,longText])
Arguments:
device device of interest
searchValue search value (ex: 'Reset', 0xA)
[searchType] search type
(text -> search text followed by long text (default),
longText -> search long text only,
value -> search setting values)
[orderNumber] returned order number value
[value] returned setting value
[text] returned text value
[longText] returned long text value
This function returns values as follows:
TRUE control entry was found
FALSE control entry was not found
Related functions:
digitalControlInfoAll, hasControlAttribute, deviceControlAttributes,
deviceStatusScaling, deviceStatusScalingAll, hasStatusAttribute
-------------------------------------------------------------------------------
digitalControlInfoAll : returns all of the digital control info
for a device
numEntries = digitalControlInfoAll(device [,orderNumbers] [,values]
[,text] [,longText])
Arguments:
device device of interest
[orderNumbers] returned order number values
[values] returned setting values
[text] returned text values
[longText] returned long text values
This function returns values as follows:
number of digital control entries
Related functions:
digitalControlInfo, deviceControlAttributes, hasControlAttribute,
deviceStatusScalingAll, deviceStatusScaling, hasStatusAttribute
-------------------------------------------------------------------------------
dipoleFourBumpInfo : returns dipole four bump information
numEntries = dipoleFourBumpInfo(location [,multipliers] [,deviceNames])
Arguments:
location location of bump
[multipliers] returned bump multiplier values
[deviceNames] returned bump device names
This function returns values as follows:
number of bump entries (4)
Related functions:
dipoleThreeBumpInfo
-------------------------------------------------------------------------------
dipoleThreeBumpInfo : returns dipole three bump information
numEntries = dipoleThreerBumpInfo(location [,multipliers]
[,deviceNames])
Arguments:
location location of bump
[multipliers] returned bump multiplier values
[deviceNames] returned bump device names
This function returns values as follows:
number of bump entries (3)
Related functions:
dipoleFourBumpInfo
-------------------------------------------------------------------------------
downloadDevices : returns front end download devices
numDevices = downloadDevices(node, [,crate] [,deviceNames]
[,properties] [,fullNames])
Arguments:
node desired ACNET front end node
[crate] desired crate (CAMAC only)
(default is 0)
[deviceNames] returned device names
[properties] returned device properties
[fullNames] flag indicating whether or not to return
full device names
(fullNames -> want full device names,
normalNames -> want normal device names (default))
This function returns values as follows:
number of devices found in the node's download list
Related functions:
fileDevices, sqlQueryDevices, loggerListDevices, userAlarmListDevices,
userSaveListDevices, parameterPageDevices, lexSaDevices, synopticDevices
-------------------------------------------------------------------------------
duplicateSsdnProperties : returns any duplicate SSDN properties
to a given property on the same node
numDuplicates = duplicateSsdnProperties(device [,property]
[,deviceNames] [,properties]
[,fullNames])
Arguments:
device device of interest
[property] desired property
(null -> all readable/settable properties,
reading,
setting,
status,
control,
analogAlarm,
digitalAlarm)
(default is the implicit property from the device
argument)
[deviceNames] returned duplicate property device names
[properties] returned duplicate property values
[fullNames] flag indicating whether or not to return
full device names
(fullNames -> want full device names,
normalNames -> want normal device names (default))
This function returns values as follows:
number of duplicate device properties
Related functions:
deviceSsdn, deviceSsdnSearch, deviceProperties
-------------------------------------------------------------------------------
emcToString : converts an EMC value to a standard string
string = emcToString(emc)
Arguments:
emc EMC to convert
This function returns values as follows:
converted string
Related functions:
stringToEmc, ssdnToString, stringToSsdn, deviceEmc
-------------------------------------------------------------------------------
error : converts an ACNET error string to a value
errorValue = error(value [,outputType)
Arguments:
value value to convert
[outputType] output type
(numeric -> integer value (default),
name -> error symbolic name string,
facilityError -> facility/error string,
hex -> hex string)
This function returns values as follows:
error value
Related functions:
isErrorString, errorToFacilityError, node, isNodeString, device,
name, fullName, text, fullText
-------------------------------------------------------------------------------
errorToFacilityError : converts an ACNET error value to its component
facility and error number
isValidError = errorToFacilityError(error [,facility] [,errorNumber])
Arguments:
error ACNET error value
[facility] returned error facility number
[errorNumber] returned error number
This function returns values as follows:
TRUE is valid ACNET error value
FALSE is not a valid ACNET error value
Related functions:
error, isErrorString, nodeToTrunkNode, trunkNodeToNode
-------------------------------------------------------------------------------
escapeString : replaces characters in a string with their
corresponding escape characters
string = escapeString(sourceString, escapeType [,handleQuotes]
[,escapeChars])
Arguments:
sourceString original string
escapeType type of escape characters
(C,
URL,
HTML)
[handleQuotes] preserve characters enclosed in a quoted string
[escapeChars] list of characters to escape
(default is to escape all appropriate characters)
This function returns values as follows:
modified string
Related functions:
unescapeString
-------------------------------------------------------------------------------
eventCount : returns the current count for an event
count = eventCount(event [,eventType] [,count0F] [,count02]
[,usecOffset])
Arguments:
event clock event value
[eventType] type of clock event
(tclk -> TCLK event (default),
mibs -> MIBS clock event,
rrbs -> RRBS clock event,
tvbs -> TVBS clock event,
hins -> HINS clock event,
nml -> NML clock event,
test -> test clock event)
[count0F] event 0F occurrence count when the requested
event occurred
[count02] event 02 occurrence count when the requested
event occurred
[usecOffset] number of microseconds past the previous event 02
when the requested event last occurred
This function returns values as follows:
current count for the requested event
Related functions:
eventDate, timeSinceEvent, eventOccurred, clearEventOccurred
-------------------------------------------------------------------------------
eventDate : returns the date in clinks when an event last occurred
date = eventDate(event [,eventType])
Arguments:
event clock event value
[eventType] type of clock event
(tclk -> TCLK event (default),
mibs -> MIBS clock event,
rrbs -> RRBS clock event,
tvbs -> TVBS clock event,
hins -> HINS clock event,
nml -> NML clock event,
test -> test clock event)
This function returns values as follows:
date when the clock event last occurred
Related functions:
timeSinceEvent, eventCount, eventOccurred, clearEventOccurred
-------------------------------------------------------------------------------
eventOccurred : determines if a clock event has occurred
boolean = eventOccurred(event [,eventType])
Arguments:
event clock event value
[eventType] type of clock event
(tclk -> TCLK event (default),
mibs -> MIBS clock event,
rrbs -> RRBS clock event,
tvbs -> TVBS clock event,
hins -> HINS clock event,
nml -> NML clock event,
test -> test clock event)
This function returns values as follows:
TRUE event has occurred
FALSE event has not occurred
Related functions:
clearEventOccurred, timeSinceEvent, eventDate, eventCount
-------------------------------------------------------------------------------
exists : determines if a device or variable/symbol exists
boolean = exists(object)
Arguments:
object object (device or variable) to check for the
existence of
This function returns values as follows:
TRUE object exists
FALSE object does not exist
Related functions:
sizeof, sizeofVariable, byteSizeof, byteSizeofVariable, numElements
-------------------------------------------------------------------------------
exp : base e exponentiation (e^n)
resultValue = exp(value)
Arguments:
value exponent value
This function returns values as follows:
e raised to the power of the argument
Related functions:
ln
-------------------------------------------------------------------------------
expandFileName : expands a file name starting with a tilde (~)
expandedFileName = expandFileName(fileName)
Arguments:
fileName file name to expand
This function returns values as follows:
expanded file name
Related functions:
parseFileName, openFile, closeFile, fileGetString, filePrintf, fscanf,
fileRead, fileRewind, fileWrite, findFileInPath, findInFile
-------------------------------------------------------------------------------
feClassInfo : returns front end device class information
numClases = feClassInfo(node [,classNames] [,classNumbers])
Arguments:
node front end node
[classNames] returned array of class names
[classNumbers] returned array of class numbers
This function returns values as follows:
number of classes
Related functions:
feSsdnClassLocation
-------------------------------------------------------------------------------
feSsdnClassLocation : returns the byte index of the device class
in an SSDN
byteIndex = feSsdnClassLocation(node)
Arguments:
node front end node
This function returns values as follows:
byte index of class number in SSDN
Related functions:
feClassInfo
-------------------------------------------------------------------------------
fileCopy : copies an existing file (requires file copy privilege)
status = fileCopy(sourceFile [,destFile])
Arguments:
sourceFile file to copy
[destFile] destination file name
(default is to copy to current directory)
This function returns values as follows:
OK success
CLIB_NO_SUCH source file not found
CLIB_NOPRIV no permission for the copy
CLIB_GENERR other error during copy
Related functions:
fileRename, fileDate, fileDelete, fileExists, fileHasPermission,
fileLength, fileOwner, fileOwnerId, filePermissions
-------------------------------------------------------------------------------
fileDate : returns the date of a file
date = fileDate(fileName [,dateType])
Arguments:
fileName file to check
[dateType] date type to return
(modify (default),
change,
access)
This function returns values as follows:
corresponding file date
Related functions:
fileLength, fileOwner, fileOwnerId, fileHasPermission, filePermissions,
fileExists, fileRename, fileCopy, fileDelete
-------------------------------------------------------------------------------
fileDelete : deletes an existing file (requires file delete privilege)
status = fileDelete(fileName)
Arguments:
fileName file to delete
This function returns values as follows:
OK success
CLIB_NO_SUCH file not found
CLIB_NOPRIV no permission for the delete
CLIB_GENERR other error during delete
Related functions:
fileRename, fileCopy, fileDate, fileExists, fileHasPermission,
fileLength, fileOwner, fileOwnerId, filePermissions
-------------------------------------------------------------------------------
fileDevices : returns the devices specified in a file
numDevices = fileDevices(fileName, [,deviceNames] [,properties]
[,arrayIndices] [,fullNames])
Arguments:
fileName file name
[deviceNames] returned device names
[properties] returned device properties
[arrayIndices] returned device array indices
[fullNames] flag indicating whether or not to return
full device names
(fullNames -> want full device names,
normalNames -> want normal device names (default))
This function returns values as follows:
number of devices found in the file
Related functions:
sqlQueryDevices, loggerListDevices, userAlarmListDevices,
userSaveListDevices, parameterPageDevices
-------------------------------------------------------------------------------
fileDirectory : returns file names for a directory
numFiles = fileDirectory(fileSpec [,fileNames])
Arguments:
fileSpec file specification to search for
[fileNames] returned matching file names
This function returns values as follows:
number of matching files found
Synonyms: dir, directory
Related functions:
fileNumLines, filePermissions, fileExists, fileRename, fileCopy,
fileDelete, fileDate, fileLength, fileOwner, fileOwnerId
-------------------------------------------------------------------------------
fileExists : determines whether or not a file exists
status = fileExists(fileName)
Arguments:
fileName file to check
This function returns values as follows:
TRUE file exists
FALSE file does not exist
Related functions:
fileRename, fileCopy, fileDelete, fileDate, fileHasPermission,
fileLength, fileOwner, fileOwnerId, filePermissions
-------------------------------------------------------------------------------
fileFlush : flush any unwritten information to the file
wasFlushed = fileFlush(fileId)
Arguments:
fileId file ID returned by openFile
This function returns values as follows:
TRUE file was flushed
FALSE file was not flushed
Synonyms: flushFile, fflush
Related functions:
openFile, closeFile, filePrintf, fileWrite, flushOutputFile,
flushLogFile
-------------------------------------------------------------------------------
fileGetString : reads a string from a file opened by openFile
string = closeFile(fileId)
Arguments:
fileId file ID returned by openFile
This function returns values as follows:
string read from file (without newline terminator)
Synonyms: fgets
Related functions:
openFile, closeFile, filePrintf, fileRead, fscanf, fileRewind,
fileWrite
-------------------------------------------------------------------------------
fileHasPermission : returns a specific permission for a file
boolean = fileHasPermission(fileName [,permission] [,userType])
Arguments:
fileName file to check
[permission] permission to check
(read -> read access (default),
write -> write access,
execute -> execute status)
[userType] user type to check
(owner (default),
group,
all)
This function returns values as follows:
TRUE file has permission
FALSE file does not have permission
Related functions:
filePermissions, fileExists, fileRename, fileCopy, fileDelete, fileDate,
fileLength, fileOwner, fileOwnerId
-------------------------------------------------------------------------------
fileLength : returns the length of a file in bytes
length = fileLength(fileName)
Arguments:
fileName file to check
This function returns values as follows:
file length in bytes
Related functions:
fileDate, fileOwner, fileOwnerId, fileHasPermission, filePermissions,
fileExists, fileRename, fileCopy, fileDelete
-------------------------------------------------------------------------------
fileNumLines : returns the number of lines (also characters and words)
in a file
numLines = fileNumLines(fileName [,numChars] [,numWords]
[,searchString] [,startString] [,termString])
Arguments:
fileName file to check
[numChars] returned number of characters in the file
[numWords] returned number of words in the file
[searchString] only count lines containing this string
[startString] only start counting strings after the line in
which this string is found
[termString] stop counting lines when a line containing
this string is found
This function returns values as follows:
number of lines in the file
Related functions:
fileDirectory, filePermissions, fileExists, fileRename, fileCopy,
fileDelete, fileDate, fileLength, fileOwner, fileOwnerId
-------------------------------------------------------------------------------
fileOwner : returns the owner of a file
ownerName = fileOwner(fileName [,groupName])
Arguments:
fileName file to check
[groupName] returned group name
This function returns values as follows:
file owner name
Related functions:
fileOwnerId, fileLength, fileDate, fileHasPermission, filePermissions,
fileExists, fileRename, fileCopy, fileDelete
-------------------------------------------------------------------------------
fileOwnerId : returns the owner ID for a file
ownerId = fileOwnerId(fileName [,groupId])
Arguments:
fileName file to check
[groupId] returned group ID
This function returns values as follows:
file owner ID
Related functions:
fileOwner, fileLength, fileDate, fileHasPermission, filePermissions,
fileExists, fileRename, fileCopy, fileDelete
-------------------------------------------------------------------------------
filePermissions : returns the complete file permission set for a file
permissionSet = filePermissions(fileName [,userType])
Arguments:
fileName file to check
[userType] user type to check
(owner (default),
group,
all)
This function returns values as follows:
file permission set
Related functions:
fileHasPermission, fileExists, fileRename, fileCopy, fileDelete,
fileDate, fileLength, fileOwner, fileOwnerId
-------------------------------------------------------------------------------
filePrintf : functions like fprintf with the additional
functionality of toString
numChars = filePrintf(fileId, formatString [,arg1] ...)
Arguments:
fileId file ID returned by openFile
formatString format string
[arg1] first value to format
This function returns values as follows:
number of characters output
Synonyms: fprintf
Related functions:
openFile, closeFile, fileWrite, fileFlush, fscanf, fileGetString,
fileRead, fileRewind, sprintf, printf, toString, toTrimmedString,
formatDateString, stringCopy, toNumeric
-------------------------------------------------------------------------------
fileRead : reads binary values from a file
numRead = fileRead(fileId, value [,numElements] [,dataType]
[stringLength])
Arguments:
fileId file ID returned by openFile
value returned file values
[numElements] number of elements to read (default is 1)
[dataType] data type of file data
(default is type of value argument)
[stringLength] length of each string if the data type is string
(Passing a value of 0 for this argument will
result in reading one line of the file per string.)
(default is 1)
This function returns values as follows:
number of values read
Synonyms: fread, readFile, file_read, read_file
Related functions:
openFile, closeFile, fileGetString, fileRewind, fileWrite, fscanf,
filePrintf
-------------------------------------------------------------------------------
fileRename : renames an existing file (requires file rename privilege)
status = fileRename(sourceFile [,destFile])
Arguments:
sourceFile file to rename
[destFile] destination file name
(default is to rename to current directory)
This function returns values as follows:
OK success
CLIB_NO_SUCH source file not found
CLIB_NOPRIV no permission for the rename
CLIB_GENERR other error during rename
Related functions:
fileCopy, fileDate, fileDelete, fileExists, fileHasPermission,
fileLength, fileOwner, fileOwnerId, filePermissions
-------------------------------------------------------------------------------
fileRewind : rewinds a file to its beginning
status = fileRewind(fileId)
Arguments:
fileId file ID returned by openFile
This function returns values as follows:
status of rewind
Synonyms: rewindFile, file_rewind, rewind_file
Related functions:
openFile, closeFile, fileRead, fileGetString, fscanf, fileWrite,
filePrintf
-------------------------------------------------------------------------------
fileWrite : writes binary values to a file
numWritten = fileWrite(fileId, value [,numElements] [,dataType])
Arguments:
fileId file ID returned by openFile
value values to write to the file
[numElements] number of elements to write (default is 1)
[dataType] data type of data to write to file
(default is type of value argument)
This function returns values as follows:
number of values written
Synonyms: fwrite, writeFile, file_write, write_file
Related functions:
openFile, closeFile, filePrintf, fileFlush, fileRead, fileGetString,
fileRewind, fscanf
-------------------------------------------------------------------------------
findChar : returns the first location of one of a set of characters
in a string
position = findChar(searchChars, sourceString [,direction])
Arguments:
searchChars character(s) to search for
sourceString source string
[direction] search direction
(first -> find first occurrence,
last -> find last occurrence,
n -> find the nth occurrence)
This function returns values as follows:
0 character(s) were not found
otherwise character position (starts at 1)
Related functions:
findNotChar, findString, regexpFindString, stringStartsWith
-------------------------------------------------------------------------------
findConsoleWindowTitle : find console window titles matching a string
numWindows = findConsoleWindowTitle(title, [,console] [,windowIds]
[,slots] [,processNames])
Arguments:
title title string to search for
[console] console to search (default is the local console)
[windowIds] returned matching window IDs
[slots] returned matching console slots
[processNames] returned matching process names
This function returns values as follows:
number of matching windows found
Synonyms: findWindowTitle
Related functions:
consoleWindowToSlot, consoleSlotToWindow, consoleProcessName,
consoleExists, consoleIsUp, consoleSlotExists
-------------------------------------------------------------------------------
findFileInPath : determines whether a file name points to an
existing file
foundFileName = findFileInPath(fileName, path [,pathType]
[,pathSeparator])
Arguments:
fileName file name to find
path file path string
[pathType] type of path provided
(literal -> literal path string (default),
environmentVariable -> treat the path as an environment
variable)
[pathSeparator] path entry separator character (default is ':')
This function returns values as follows:
returned matching file name or null string
Related functions:
findInFile, parseFileName, expandFileName, openFile, closeFile,
fileGetString, filePrintf, fscanf, fileRead, fileRewind, fileWrite
-------------------------------------------------------------------------------
findInFile : searches for a text string in a file
numMatches = findInFile(fileName, searchString [,matchLimit]
[,caseSensitive] [,lineNumbers]
[,lineText])
Arguments:
fileName name of file to search
searchString text to search for (supports regular expressions)
[matchLimit] maximum number of matches to look for
(all -> search for all occurrences (default),
otherwise -> maximum number of matches to search for)
[caseSensitive] search case sensitivity
(caseSensitive -> case sensitive search,
caseInsensitive -> case insensitive search (default))
[lineNumbers] returned matching line numbers
[lineText] returned text for matching lines
This function returns values as follows:
number of matches found
Related functions:
findFileInPath, parseFileName, expandFileName, openFile, closeFile,
fileGetString, filePrintf, fscanf, fileRead, fileRewind, fileWrite
-------------------------------------------------------------------------------
findNotChar : returns the first location of a character which is not
a member of a set of characters in a string
position = findNotChar(searchChars, sourceString [,direction])
Arguments:
searchChars character(s) to search for
sourceString source string
[direction] search direction
(first -> find first occurrence,
last -> find last occurrence,
n -> find the nth occurrence)
This function returns values as follows:
0 character(s) were not found
otherwise character position (starts at 1)
Related functions:
findChar, findString, regexpFindString, stringStartsWith
-------------------------------------------------------------------------------
findString : returns the position of one string within another
position = findString(searchString, sourceString [,option1]
[,option2] [,option3])
Arguments:
searchString search string
sourceString source string
[option1...3] optional argument strings
(caseSensitive -> case sensitive,
caseInsensitive -> case insensitive (default),
ignoreSpaces -> ignore spaces while matching,
wildcard=c -> specify a wildcard character)
This function returns values as follows:
0 search string was not found
otherwise match position (starts at 1)
Related functions:
regexpFindString, findChar, findNotChar, findTagString, stringStartsWith
-------------------------------------------------------------------------------
findTagString : finds and extracts delimited tags from a string
tagString = findTagString(sourceString [,tagType] [,isEndTag])
Arguments:
sourceString original string
(If a tag is found, this string will be modified
with the tag removed,)
tagType type of tag
(HTML)
[isEndTag] returned boolean indicating if the found tag is
an end tag
This function returns values as follows:
tag string
Related functions:
getTaggedValue, findString, regexpFindString
-------------------------------------------------------------------------------
firstCharPos : find the first or last nonblank character position
position = firstCharPos(sourceString [,direction])
Arguments:
sourceString source string
[direction] search direction
(first -> find first nonblank character position,
last -> find last nonblank character position)
This function returns values as follows:
0 no nonblank characters were not found
otherwise character position (starts at 1)
Related functions:
lastCharPos, getFirstChar, stringStartsWith, findChar, findNotChar
-------------------------------------------------------------------------------
floatToBinary : converts a single precision floating point value to
its equivalent binary value
binaryValue = floatToBinary(floatValue)
Arguments:
floatValue float value to convert to binary (integer)
This function returns values as follows:
corresponding binary (integer) value
Related functions:
binaryToFloat
-------------------------------------------------------------------------------
floor : largest integer less than or equal to its argument
resultValue = floor(value)
Arguments:
value original value
This function returns values as follows:
largest integer less than or equal to its argument
Related functions:
ceil
-------------------------------------------------------------------------------
flushLogFile : flush any unwritten information to the log file
wasFlushed = flushLogFile()
This function returns values as follows:
TRUE log file established
FALSE no log file established
Related functions:
flushOutputFile, fileFlush
-------------------------------------------------------------------------------
flushOutputFile : flush any unwritten information to an output file
wasFlushed = flushOutputFile([fileName])
Arguments:
[fileName] output file name to flush
(default is the last output file written to)
This function returns values as follows:
TRUE output file was flushed
FALSE output file was not flushed
Related functions:
flushLogFile, fileFlush
-------------------------------------------------------------------------------
fmod : remainder of the arguments
remainder = floor(numerator, denominator)
Arguments:
numerator numerator value
denominator denominator value
This function returns values as follows:
remainder of the arguments
Related functions:
fract
-------------------------------------------------------------------------------
formatDateString : format a date string using the format specifiers
in strftime
string = formatDateString([formatString] [,date] [,locale])
Arguments:
[formatString] desired format
(standard -> "dd-Mmm-yyyy hh:mm:ss" format (default),
ctime -> "Www Mmm dd hh:mm:ss yyyy" format,
ctime+ -> "Www Mmm dd hh:mm:ss yyyy zzz" format,
compare -> "yyyy-mm-dd hh:mm:ss" format,
otherwise -> format string suitable for use
with strftime)
[date] date value to convert
(default is now)
[locale] time locale
(local -> local time (default),
utc -> UTC time)
This function returns values as follows:
converted date string
Related functions:
dateToString, stringtoDate, convertSeconds, timeAgo, timeFromDate,
timeSinceEvent, cpuTime, systemTime, 15HzCount, timer, julianDate,
julianDateToDate, currentTimeInClinks, currentTime, localtime
-------------------------------------------------------------------------------
fract : fractional component
fraction = fract(value)
Arguments:
value original value
This function returns values as follows:
fractional component of argument
Related functions:
fmod
-------------------------------------------------------------------------------
fscanf : functions like fscanf with the additional functionality
of toNumeric
numConverted = fscanf(fileId, formatString [,arg1] ...)
Arguments:
fileId file ID returned by openFile
formatString format string
[arg1] first value to convert or conversion type
This function returns values as follows:
number of values converted
Synonyms: fileScanf
Related functions:
sscanf, openFile, closeFile, fileGetString, filePrintf, sprintf,
printf, toNumeric, toString, toTrimmedString, formatDateString,
stringCopy
-------------------------------------------------------------------------------
fshareFileInfo : returns information about a Filesharing file
recordSize = fshareFileInfo(fileName [,numRecords] [,fileType])
Arguments:
fileName Filesharing file to check
[numRecords] returned number of records in the file
[fileType] returned file organization type
(Sequential,
Relative,
Indexed)
This function returns values as follows:
size of each record in bytes
Related functions:
appdsTableInfo
-------------------------------------------------------------------------------
ftpMaxFreq : returns the maximum fast time plot frequency for a
device or plot class
maxFreq = ftpMaxFreq(device)
Arguments:
device device of interest
This function returns values as follows:
maximum fast time plot frequency
Related functions:
snapshotMaxFreq
-------------------------------------------------------------------------------
fullName : returns a device full name string
string = fullName(device)
Arguments:
device device of interest
This function returns values as follows:
device full name string
Related functions:
name, fullText, text
-------------------------------------------------------------------------------
fullNameToConsoleUserName : converts a full name to a console user name
userName = fullNameToConsoleUserName(fullName)
Arguments:
fullName full user name
This function returns values as follows:
corresponding console user name
Related functions:
consoleUserNameToFullName
-------------------------------------------------------------------------------
fullText : returns a device full descriptive text string
string = fullText(device)
Arguments:
device device of interest
This function returns values as follows:
device full descriptive text string
Related functions:
text, fullName, name
-------------------------------------------------------------------------------
genericDeviceSearch : searches for devices matching various parameters
numDevices = genericDeviceSearch(deviceNames [,properties]
[,duplicateFlag]
[,type1] [,value1] ...)
Arguments:
deviceNames returned matching device names
[properties] returned matching device properties
[duplicateFlag] duplicate device flag
(allowDuplicates -> allow duplicate devices (default),
noDuplicates -> don't allow duplicate devices)
[type1] first search type
(name,
fullName,
text,
fullText,
nodeString,
node,
nodeSystem,
nodeSoftware,
nodeArea,
nodeStatus,
deviceClass,
deviceType,
properties,
alarmList,
actualAlarmList,
analogAlarmHandler,
digitalAlarmHandler,
saveList,
restoreCode,
restoreSubcode,
displayCode,
consoleClassMask,
defaultFtd,
ssdn,
virtualMachine,
dataType,
commonTransform,
commonUnits,
primaryTransform,
primaryUnits,
department,
maintainer,
structureClass,
structureName,
foreignSystem,
foreignName,
crate,
slot,
madc)
[value1] first value
This function returns values as follows:
number of matching device names
Related functions:
deviceNameSearch, deviceFullNameSearch, deviceDescriptionSearch,
deviceFullDescriptionSearch, deviceNodeSearch, deviceSsdnSearch
-------------------------------------------------------------------------------
genericStructInfo : returns information about a generic structure
structSize = genericStructInfo(structureName [,numFields] [,fieldNames]
[,dataTypes] [,numElements]
[,dataLengths])
Arguments:
structureName structure to check
[numFields] returned number of fields
[fieldNames] returned array of field names
[dataTypes] returned array of field data types
(CNV_xxx)
[numElements] returned array of field numbers of elements
[dataLengths] returned array of field data lengths in bytes
This function returns values as follows:
size of structure in bytes
Related functions:
appdsTableInfo
-------------------------------------------------------------------------------
getenv : returns the string corresponding to an environment variable
value = getenv(envVariable)
Arguments:
envVariable environment variable name
This function returns values as follows:
value of the requested environment variable
Related functions:
setenv, delenv, getLogicalName, setLogicalName, deleteLogicalName
-------------------------------------------------------------------------------
getFirstChar : retrieve the first or last nonblank character
string = getFirstChar(sourceString [,direction] [,position])
Arguments:
sourceString source string
[direction] search direction
(first -> get first nonblank character,
last -> get last nonblank character)
[position] returned position of nonblank character (starts at 1)
(A value of 0 means that no nonblank characters
were found.)
This function returns values as follows:
null string no nonblank characters were found
otherwise string containing first or last character
Related functions:
getLastChar, firstCharPos, stringStartsWith, findChar, findNotChar,
stringGetChar
-------------------------------------------------------------------------------
getLastChar : retrieve the last nonblank character in a string
string = getLastChar(sourceString [,position])
Arguments:
sourceString source string
[position] returned position of nonblank character (starts at 1)
(A value of 0 means that no nonblank characters
were found.)
This function returns values as follows:
null string no nonblank characters were found
otherwise string containing last character
Related functions:
getFirstChar, lastCharPos, firstCharPos, stringEndsWith,
stringStartsWith, findChar, findNotChar, stringGetChar
-------------------------------------------------------------------------------
getLogicalName : returns the string corresponding to a logical name
value = getLogicalName(logicalName)
Arguments:
logicalName logical name
This function returns values as follows:
value of the requested logical name
Related functions:
setLogicalName, deleteLogicalName, getenv, setenv, delenv
-------------------------------------------------------------------------------
getTaggedValue : extracts a tag/value pair from a string
boolean = getTaggedValue(sourceString, tagString, valueString,
[,termChars])
Arguments:
sourceString original string
(If a tag is found, this string will be modified
with the tag/value pair removed.)
tagString returned tag string
valueString returned value string
[termChars] tag/value terminator characters
This function returns values as follows:
TRUE tag/value pair found
FALSE tag/value pair not found
Related functions:
findTagString, findString, regexpFindString
-------------------------------------------------------------------------------
gifImageSize : determines the dimensions of a GIF image
numPixels = gifImageSize(fileName [,width] [,height])
Arguments:
fileName GIF file name
[width] returned width of image in pixels
[height] returned height of image in pixels
This function returns values as follows:
size of image in pixels
Related functions:
<none>
-------------------------------------------------------------------------------
hasAnalogAlarm : determines whether or not a device has an analog alarm property
boolean = hasAnalogAlarm(device)
Arguments:
device device of interest
This function returns values as follows:
TRUE device has an analog alarm
FALSE device does not have an analog alarm
Related functions:
hasProperty, hasReading, hasSetting, hasStatus, hasControl,
hasDigitalAlarm, device, name, fullName, text, fullText, deviceValue,
deviceValueText, alarmBlockFieldValue
-------------------------------------------------------------------------------
hasControl : determines whether or not a device has a control property
boolean = hasControl(device)
Arguments:
device device of interest
This function returns values as follows:
TRUE device has a control property
FALSE device does not have a control property
Related functions:
hasProperty, hasReading, hasSetting, hasStatus, hasAnalogAlarm,
hasDigitalAlarm, device
-------------------------------------------------------------------------------
hasControlAttribute : determines whether or not a device has
a control attribute
attrExists = hasControlAttribute(device, attribute [,setValue])
Arguments:
device device of interest
attribute desired control attribute
(reset,
on,
off,
positive,
negative,
ramp,
dc)
[setValue] returned corresponding setting value
This function returns values as follows:
TRUE control attribute exists
FALSE control attribute does not exist
Related functions:
deviceControlAttributes, digitalControlInfo, digitalControlInfoAll,
hasStatusAttribute, deviceStatusScaling, deviceStatusScalingAll,
deviceScalingLength, deviceReadSetScaling, deviceReadSetExtScaling
-------------------------------------------------------------------------------
hasDigitalAlarm : determines whether or not a device has a
digital alarm property
boolean = hasDigitalAlarm(device)
Arguments:
device device of interest
This function returns values as follows:
TRUE device has a digital alarm
FALSE device does not have a digital alarm
Related functions:
hasProperty, hasReading, hasSetting, hasStatus, hasControl,
hasAnalogAlarm, device
-------------------------------------------------------------------------------
hasProperty : determines whether or not a device has a
specified property
boolean = hasProperty(device [,property])
Arguments:
device device of interest
[property] desired property
(reading,
setting,
status,
control,
analogAlarm,
digitalAlarm)
(default is the implicit property from the device
argument)
This function returns values as follows:
TRUE device has the requested property
FALSE device does not have the requested property
Related functions:
hasReading, hasSetting, hasStatus, hasControl, hasAnalogAlarm,
hasDigitalAlarm, device, name, fullName, text, fullText, deviceValue,
deviceValueText, deviceDigitalStatus, alarmBlockFieldValue
-------------------------------------------------------------------------------
hasReading : determines whether or not a device has a reading property
boolean = hasReading(device)
Arguments:
device device of interest
This function returns values as follows:
TRUE device has a reading property
FALSE device does not have a reading property
Related functions:
hasProperty, hasSetting, hasStatus, hasControl, hasAnalogAlarm,
hasDigitalAlarm, device
-------------------------------------------------------------------------------
hasSetting : determines whether or not a device has a setting property
boolean = hasSetting(device)
Arguments:
device device of interest
This function returns values as follows:
TRUE device has a setting property
FALSE device does not have a setting property
Related functions:
hasProperty, hasReading, hasStatus, hasControl, hasAnalogAlarm,
hasDigitalAlarm, device
-------------------------------------------------------------------------------
hasStatus : determines whether or not a device has a status property
boolean = hasStatus(device)
Arguments:
device device of interest
This function returns values as follows:
TRUE device has a status property
FALSE device does not have a status property
Related functions:
hasProperty, hasReading, hasSetting, hasControl, hasAnalogAlarm,
hasDigitalAlarm, hasStatusAttribute, device
-------------------------------------------------------------------------------
hasStatusAttribute : determines whether or not a device has a
status attribute
attrExists = hasStatusAttribute(device, attribute [,attrMask]
[,invertFlag] [,trueString]
[,falseString] [,wantLongText]
[,trueColor] [,falseColor])
Arguments:
device device of interest
attribute desired status attribute
(onOff,
readyTripped,
remoteLocal,
positiveNegative,
rampDC)
[attrMask] returned status attribute mask
[invertFlag] returned status data invert flag
[trueString] returned string to display if the data
matches the mask
[falseChar] returned string to display if the data
does not match the mask
[wantLongText] flag indicating whether or not to return
long text strings
[trueColor] returned color to display if the data
matches the mask
[falseColor] returned color to display if the data
does not match the mask
This function returns values as follows:
TRUE status attribute exists
FALSE status attribute does not exist
Related functions:
deviceStatusScaling, deviceStatusScalingAll, hasControlAttribute,
deviceControlAttributes, digitalControlInfo, digitalControlInfoAll,
deviceScalingLength, deviceReadSetScaling, deviceReadSetExtScaling
-------------------------------------------------------------------------------
head : returns the beginning of a string
string = head(sourceString, numChars)
Arguments:
sourceString source string
numChars length of string to return
This function returns values as follows:
beginning of source string
Related functions:
tail
-------------------------------------------------------------------------------
hex : returns a value as a hexadecimal string
string = hex(value [,convertLength] [,fillChar] [,dataType])
Arguments:
value value to convert
[convertLength] converted string length
[fillChar] fill character
[dataType] data type
(integer,
float,
double)
(default is to use the native type of the value)
This function returns values as follows:
converted string value
Synonyms: toHex
Related functions:
binary, octal, decimal, radix, toString, toTrimmedString, rad50ToString
-------------------------------------------------------------------------------
highestBit : returns the highest bit set in a value (or -1)
bitNumber = highestBit(sourceValue [,startBit] [,numBits])
Arguments:
sourceValue value to check
[startBit] starting bit number (starts at 1)
(default is 1)
[numBits] number of bits to check
(default is 32)
This function returns values as follows:
-1 no bits were set
otherwise highest set bit number starting at 1
Related functions:
lowestBit, bit, bitCount, clearBit, setBit, bitField, bitComplement,
circularShift
-------------------------------------------------------------------------------
histogram : divides an array of values into buckets
numFilled = histogram(values, numBuckets, bucketCounts [,minimum]
[,maximum])
Arguments:
values values to histogram
numBuckets number of buckets
bucketCounts returned array of bucket counts
[minimum] minimum of range of histogram
(default is the minimum input value)
[maximum] maximum of range of histogram
(default is the maximum input value)
This function returns values as follows:
number of filled buckets
Related functions:
mean, median, mode, minimum, maximum, sum, range, rms, stddev, variance,
identical, min, max
-------------------------------------------------------------------------------
hypot : square root of the sum of the squares of the arguments
hypotValue = hypot(value, value2)
Arguments:
value first value
value2 second value
This function returns values as follows:
square root of the sum of the squares of the arguments
Related functions:
none
-------------------------------------------------------------------------------
identical : checks to see if all values in an array are identical
boolean = identical(value [,value2...])
Arguments:
value first value (This argument can be an array value.
To indicate a range of array values, use the
value[m:n] notation. To indicate the entire
array, use the value[] notation.)
[value2...] subsequent values (These must be single values.)
This function returns values as follows:
TRUE all of the values are identical
FALSE not all of the values are the same
Related functions:
mean, median, mode, minimum, maximum, sum, range, rms, stddev, variance,
min, max, histogram
-------------------------------------------------------------------------------
ifLevel : returns the current 'if' level of the script (debugging)
level = ifLevel()
This function returns values as follows:
'if' level of the script (for debugging purposes)
Related functions:
loopLevel, variableType, valueType
-------------------------------------------------------------------------------
insertString : inserts a string within another string
string = insertString(insertString, sourceString [,insertIndex])
Arguments:
insertString string to insert
sourceString source string
[insertIndex] index at which to insert the string (starts at 1)
(default is 1)
This function returns values as follows:
modified string
Related functions:
stringCopy, stringSetChar, replaceString, regexpReplaceString
-------------------------------------------------------------------------------
ipNameToNode : converts an IP name to an ACNET node value
nodeValue = ipNameToNode(ipName)
Arguments:
ipName IP name to convert
This function returns values as follows:
node value
Related functions:
node, trunkNodeToNode, nodeToTrunkNode, isNodeString, nodeIs, nodeIsUp
-------------------------------------------------------------------------------
isAcsysFefDevice : determines whether a device property is
sourced by an Acsys/FEF node
boolean = isAcsysFefDevice(device [,property])
Arguments:
device device/property of interest
[property] desired property
(global -> overall device node,
reading,
setting,
status,
control,
analogAlarm,
digitalAlarm)
(default is the implicit property from the device
argument)
This function returns values as follows:
TRUE device is sourced by a Acsys/FEF front end
FALSE device is not sourced by a Acsys/FEF front end
Related functions:
isAcsysFefNode, deviceNode, deviceNodeType, isMoocDevice, isOacDevice,
isIrmDevice, isLabviewDevice
-------------------------------------------------------------------------------
isAcsysFefNode : determines whether a node is an Acsys/FEF node
boolean = isAcsysFefNode(node)
Arguments:
node node to check
This function returns values as follows:
TRUE node is an Acsys/FEF front end
FALSE node is not an Acsys/FEF front end
Related functions:
isAcsysFefDevice, isMoocNode, isIrmNode, isOacNode, isLabviewNode,
nodeAttributeValue, cacheNodeInfo
-------------------------------------------------------------------------------
isAlphabeticString : determines whether or not a string is composed
entirely of alphabetic characters (plus optional
white space)
boolean = isAlphabeticString(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
TRUE is an alphabetic string
FALSE is not an alphabetic string
Related functions:
isLowerCase, isUpperCase, isQuotedString, isAlphanumericString,
isBlankString, isFloatString, isIntegerString, isHexString,
isPrintableString, isStringFilledWithChar, isDeviceString,
isPropertyString, isNodeString, isErrorString, isEventString,
isDateString, isRad50String
-------------------------------------------------------------------------------
isAlphanumericString : determines whether or not a string is composed
entirely of alphanumeric characters (plus
optional white space)
boolean = isAlphanumericString(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
TRUE is an alphanumeric string
FALSE is not an alphanumeric string
Related functions:
isLowerCase, isUpperCase, isQuotedString, isAlphabeticString,
isBlankString, isFloatString, isIntegerString, isHexString,
isPrintableString, isStringFilledWithChar, isDeviceString,
isPropertyString, isNodeString, isErrorString, isEventString,
isDateString, isRad50String
-------------------------------------------------------------------------------
isArrayDevice : determines whether or not a device/property is an array
boolean = isArrayDevice(device [,property] [,numElements])
Arguments:
device device/property of interest
[property] desired property
(reading,
setting,
status,
control)
(default is the implicit property from the device
argument)
[numElements] returned number of elements
This function returns values as follows:
TRUE device/property is an array
FALSE device/property is not an array
Related functions:
isStructureDevice, deviceDefaultLength, deviceAtomicLength,
deviceMaximumLength, deviceisOacDevice, isMoocDevice, isIrmDevice,
isLabviewDevice, isAcsysFefDevice
-------------------------------------------------------------------------------
isBlankString : determines whether or not a string is composed
entirely of white space
boolean = isBlankString(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
TRUE is a blank string
FALSE is not a blank string
Related functions:
isLowerCase, isUpperCase, isQuotedString, isAlphabeticString,
isAlphanumericString, isFloatString, isIntegerString, isHexString,
isPrintableString, isStringFilledWithChar, isDeviceString,
isPropertyString, isNodeString, isErrorString, isEventString,
isDateString, isRad50String
-------------------------------------------------------------------------------
isBracketedString : determines whether or not a string is bracketed
boolean = isBracketedString(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
TRUE is a bracketed string
FALSE is not a bracketed string
Related functions:
stripBrackets, isQuotedString, quoteString, stripQuotes, isLowerCase,
isUpperCase, isAlphabeticString, isAlphanumericString, isBlankString,
isFloatString, isIntegerString, isHexString, isPrintableString,
isStringFilledWithChar, isDeviceString, isPropertyString, isNodeString,
isErrorString, isEventString, isDateString, isRad50String
-------------------------------------------------------------------------------
isDateString : determines whether or not a string represents a date
boolean = isDateString(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
TRUE is a date string
FALSE is not a date string
Related functions:
makePrintable, isLowerCase, isUpperCase, isQuotedString,
isAlphabeticString, isAlphanumericString, isFloatString,
isIntegerString, isHexString, isBlankString, isPrintableString,
isStringFilledWithChar, isDeviceString, isPropertyString, isNodeString,
isErrorString, isEventString, isRad50String
-------------------------------------------------------------------------------
isDeviceString : determines whether or not a string represents a
device specification
boolean = isDeviceString(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
TRUE is a device string
FALSE is not a device string
Related functions:
makePrintable, isLowerCase, isUpperCase, isQuotedString,
isAlphabeticString, isAlphanumericString, isFloatString,
isIntegerString, isHexString, isBlankString, isPrintableString,
isStringFilledWithChar, isPropertyString, isNodeString, isErrorString,
isEventString, isDateString, isRad50String
-------------------------------------------------------------------------------
isErrorString : determines whether or not a string is an error name
boolean = isErrorString(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
TRUE is an error string
FALSE is not an error string
Related functions:
makePrintable, isLowerCase, isUpperCase, isQuotedString,
isAlphabeticString, isAlphanumericString, isFloatString,
isIntegerString, isHexString, isBlankString, isPrintableString,
isStringFilledWithChar, isDeviceString, isPropertyString, isNodeString,
isEventString, isDateString, isRad50String
-------------------------------------------------------------------------------
isEventString : determines whether or not a string represents a
clock event
boolean = isEventString(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
TRUE is a clock event string
FALSE is not a clock event string
Related functions:
makePrintable, isLowerCase, isUpperCase, isQuotedString,
isAlphabeticString, isAlphanumericString, isFloatString,
isIntegerString, isHexString, isBlankString, isPrintableString,
isStringFilledWithChar, isDeviceString, isPropertyString, isNodeString,
isErrorString, isDateString, isRad50String
-------------------------------------------------------------------------------
isFloatString : determines whether or not a string represents a
floating point number
boolean = isFloatString(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
TRUE is a floating point string
FALSE is not a floating point string
Related functions:
isLowerCase, isUpperCase, isQuotedString, isAlphabeticString,
isAlphanumericString, isBlankString, isIntegerString, isHexString,
isPrintableString, isStringFilledWithChar, isDeviceString,
isPropertyString, isNodeString, isErrorString, isEventString,
isDateString, isRad50String
-------------------------------------------------------------------------------
isHexString : determines whether or not a string represents a
hexadecimal number
boolean = isHexString(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
TRUE is a hex string
FALSE is not a hex string
Related functions:
isLowerCase, isUpperCase, isQuotedString, isAlphabeticString,
isAlphanumericString, isBlankString, isFloatString, isHexString,
isPrintableString, isStringFilledWithChar, isDeviceString,
isPropertyString, isNodeString, isErrorString, isEventString,
isDateString, isRad50String
-------------------------------------------------------------------------------
isInfinity : tests to see if a value is infinite
boolean = isInfinity(value)
Arguments:
value value to test
This function returns values as follows:
TRUE value is infinite
FALSE value is not infinite
Related functions:
isNaN
-------------------------------------------------------------------------------
isIntegerString : determines whether or not a string represents an
integer number
boolean = isIntegerString(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
TRUE is an integer string
FALSE is not an integer string
Related functions:
isLowerCase, isUpperCase, isQuotedString, isAlphabeticString,
isAlphanumericString, isBlankString, isFloatString, isHexString,
isPrintableString, isStringFilledWithChar, isDeviceString,
isPropertyString, isNodeString, isErrorString, isEventString,
isDateString, isRad50String
-------------------------------------------------------------------------------
isIrmDevice : determines whether a device property is
sourced by an IRM node
boolean = isIrmDevice(device [,property])
Arguments:
device device/property of interest
[property] desired property
(global -> overall device node,
reading,
setting,
status,
control,
analogAlarm,
digitalAlarm)
(default is the implicit property from the device
argument)
This function returns values as follows:
TRUE device is sourced by an IRM front end
FALSE device is not sourced by an IRM front end
Related functions:
isIrmNode, deviceNode, deviceNodeType, isMoocDevice, isOacDevice,
isLabviewDevice, isAcsysFefDevice
-------------------------------------------------------------------------------
isIrmNode : determines whether a node is an IRM node
boolean = isIrmNode(node)
Arguments:
node node to check
This function returns values as follows:
TRUE node is an IRM front end
FALSE node is not an IRM front end
Related functions:
isIrmDevice, isMoocNode, isOacNode, isLabviewNode, isAcsysFefNode,
nodeAttributeValue, cacheNodeInfo
-------------------------------------------------------------------------------
isLabviewDevice : determines whether a device property is
sourced by a LabView node
boolean = isLabviewDevice(device [,property])
Arguments:
device device/property of interest
[property] desired property
(global -> overall device node,
reading,
setting,
status,
control,
analogAlarm,
digitalAlarm)
(default is the implicit property from the device
argument)
This function returns values as follows:
TRUE device is sourced by a LabView front end
FALSE device is not sourced by a LabView front end
Related functions:
isLabviewNode, deviceNode, deviceNodeType, isMoocDevice, isOacDevice,
isIrmDevice, isAcsysFefDevice
-------------------------------------------------------------------------------
isLabviewNode : determines whether a node is a LabView node
boolean = isLabviewNode(node)
Arguments:
node node to check
This function returns values as follows:
TRUE node is a Labview front end
FALSE node is not a Labview front end
Related functions:
isLabviewDevice, isMoocNode, isIrmNode, isOacNode, isAcsysFefNode,
nodeAttributeValue, cacheNodeInfo
-------------------------------------------------------------------------------
isLowerCase : determines whether or not a string is in all lower case
characters
boolean = isLowerCase(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
TRUE string is lower case
FALSE string is not lower case
Related functions:
isUpperCase, isQuotedString, isAlphabeticString, isAlphanumericString,
isBlankString, isFloatString, isIntegerString, isHexString,
isPrintableString, isStringFilledWithChar, isDeviceString,
isPropertyString, isNodeString, isErrorString, isEventString,
isDateString, isRad50String
-------------------------------------------------------------------------------
isMoocDevice : determines whether a device property is
sourced by a MOOC node
boolean = isMoocDevice(device [,property])
Arguments:
device device/property of interest
[property] desired property
(global -> overall device node,
reading,
setting,
status,
control,
analogAlarm,
digitalAlarm)
(default is the implicit property from the device
argument)
This function returns values as follows:
TRUE device is sourced by a MOOC front end
FALSE device is not sourced by a MOOC front end
Related functions:
isMoocNode, deviceNode, deviceNodeType, isOacDevice, isIrmDevice,
isLabviewDevice, isAcsysFefDevice
-------------------------------------------------------------------------------
isMoocNode : determines whether a node is a MOOC node
boolean = isMoocNode(node)
Arguments:
node node to check
This function returns values as follows:
TRUE node is a MOOC front end
FALSE node is not a MOOC front end
Related functions:
isMoocDevice, isIrmNode, isOacNode, isLabviewNode, isAcsysFefNode,
nodeAttributeValue, cacheNodeInfo
-------------------------------------------------------------------------------
isNaN : tests to see if a value is a NaN
boolean = isNaN(value)
Arguments:
value value to test
This function returns values as follows:
TRUE value is not a number (NaN)
FALSE value is a number (not a NaN)
Related functions:
isInfinity
-------------------------------------------------------------------------------
isNodeString : determines whether or not a string is a node name
boolean = isNodeString(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
TRUE is a node string
FALSE is not a node string
Related functions:
node, makePrintable, isLowerCase, isUpperCase, isQuotedString,
isAlphabeticString, isAlphanumericString, isFloatString,
isIntegerString, isHexString, isBlankString, isPrintableString,
isStringFilledWithChar, isDeviceString, isPropertyString, isErrorString,
isEventString, isDateString, isRad50String
-------------------------------------------------------------------------------
isOacDevice : determines whether a device property is
sourced by an OAC
boolean = isOacDevice(device [,property])
Arguments:
device device/property of interest
[property] desired property
(global -> overall device node,
reading,
setting,
status,
control,
analogAlarm,
digitalAlarm)
(default is the implicit property from the device
argument)
This function returns values as follows:
TRUE device is sourced by an OAC
FALSE device is not sourced by an OAC
Related functions:
isOacNode, deviceNode, deviceNodeType, isMoocDevice, isIrmDevice,
isLabviewDevice, isAcsysFefDevice
-------------------------------------------------------------------------------
isOacNode : determines whether a node is an OAC node
boolean = isOacNode(node)
Arguments:
node node to check
This function returns values as follows:
TRUE node is an OAC front end
FALSE node is not an OAC front end
Related functions:
isOacDevice, isMoocNode, isIrmNode, isLabviewNode, isAcsysFefNode,
nodeAttributeValue, cacheNodeInfo
-------------------------------------------------------------------------------
isObsoleteDevice : determines whether or not a device is obsolete
isObsolete = isObsoleteDevice(device)
Arguments:
device device of interest
This function returns values as follows:
TRUE device is obsolete
FALSE device is not obsolete
Related functions:
deviceState, device, deviceIndex, name, fullName, text,
fullText, deviceSpec
-------------------------------------------------------------------------------
isPrintableString : determines whether or not a string is composed
entirely of printable characters
boolean = isPrintableString(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
TRUE is a printable string
FALSE is not a printable string
Related functions:
makePrintable, stripNonprintables, isLowerCase, isUpperCase,
isQuotedString, isAlphabeticString, isAlphanumericString, isFloatString,
isIntegerString, isHexString, isBlankString, isStringFilledWithChar,
isDeviceString, isPropertyString, isNodeString, isErrorString,
isEventString, isDateString, isRad50String
-------------------------------------------------------------------------------
isPropertyString : determines whether or not a string is a
device property name
boolean = isPropertyString(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
TRUE is a property string
FALSE is not a property string
Related functions:
makePrintable, isLowerCase, isUpperCase, isQuotedString,
isAlphabeticString, isAlphanumericString, isFloatString,
isIntegerString, isHexString, isBlankString, isPrintableString,
isStringFilledWithChar, isDeviceString, isNodeString, isErrorString,
isEventString, isDateString, isRad50String
-------------------------------------------------------------------------------
isQuotedString : determines whether or not a string is quoted
boolean = isQuotedString(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
TRUE is a quoted string
FALSE is not a quoted string
Related functions:
quoteString, stripQuotes, isBracketedString, isLowerCase, isUpperCase,
isAlphabeticString, isAlphanumericString, isBlankString, isFloatString,
isIntegerString, isHexString, isPrintableString, isStringFilledWithChar,
isDeviceString, isPropertyString, isNodeString, isErrorString,
isEventString, isDateString, isRad50String
-------------------------------------------------------------------------------
isRad50String : determines whether or not a string is
composed entirely of valid rad50 characters
boolean = isRad50String(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
TRUE is a rad50 string
FALSE is not a rad50 string
Related functions:
isLowerCase, isUpperCase, isQuotedString, isAlphabeticString,
isAlphanumericString, isFloatString, isIntegerString, isHexString,
isBlankString, isStringFilledWithChar, isDeviceString,
isPropertyString, isNodeString, isErrorString, isEventString,
isDateString, isPrintableString
-------------------------------------------------------------------------------
isServerTask : determines whether or not an ACNET task is a server
boolean = isServerTask(taskName [,node])
Arguments:
taskName task name
[node] task node
(default is local machine)
This function returns values as follows:
TRUE task is a server task
FALSE task is not a server task
Related functions:
taskExists, taskId, taskPid, taskIdToName, taskPidToName
-------------------------------------------------------------------------------
isStringFilledWithChar : determines whether or not a string is composed
entirely of a single character
boolean = isStringFilledWithChar(sourceString, character)
Arguments:
sourceString source string
character character to check for
This function returns values as follows:
TRUE string is filled with the character
FALSE string is not filled with the character
Related functions:
isLowerCase, isUpperCase, isQuotedString, isAlphabeticString,
isAlphanumericString, isFloatString, isIntegerString, isHexString,
isBlankString, isPrintableString, isDeviceString,
isPropertyString, isNodeString, isErrorString, isEventString,
isDateString
-------------------------------------------------------------------------------
isStructureDevice : determines whether or not a device/property
is a structure
boolean = isStructureDevice(device [,property] [,structureName])
Arguments:
device device/property of interest
[property] desired property
(reading,
setting)
(default is the implicit property from the device
argument)
[structureName] returned structure name (if one exists)
This function returns values as follows:
TRUE device/property is a structure
FALSE device/property is not a structure
Related functions:
isArrayDevice, isOacDevice, isMoocDevice, isIrmDevice,
isLabviewDevice, isAcsysFefDevice
-------------------------------------------------------------------------------
isUpperCase : determines whether or not a string is in all upper case
characters
boolean = isUpperCase(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
TRUE string is upper case
FALSE string is not upper case
Related functions:
isLowerCase, isQuotedString, isAlphabeticString, isAlphanumericString,
isBlankString, isFloatString, isIntegerString, isHexString,
isPrintableString, isStringFilledWithChar, isDeviceString,
isPropertyString, isNodeString, isErrorString, isEventString,
isDateString
-------------------------------------------------------------------------------
isValidSdaCase : determines whether or not a value is a valid SDA case
(case instance actually exists)
boolean = isValidSdaCase(fileNumber, caseValue [,sdaUsage])
Arguments:
fileNumber file number to test
caseValue case value to test (number or name)
[sdaUsage] desired SDA usage string
(default is "Collider")
This function returns values as follows:
TRUE is a valid SDA case
FALSE is not a valid SDA case
Related functions:
isValidSdaFile, isValidSdaSet, dateToSdaFile, sdaFileDate,
currentSdaFile
-------------------------------------------------------------------------------
isValidSdaFile : determines whether or not a value is a valid SDA file
number (file instance actually exists)
boolean = isValidSdaFile([fileNumber] [,sdaUsage])
Arguments:
[fileNumber] file number to test
(default is current SDA file number)
[sdaUsage] desired SDA usage string
(default is "Collider")
This function returns values as follows:
TRUE is a valid SDA file number
FALSE is not a valid SDA file number
Related functions:
isValidSdaCase, isValidSdaSet, dateToSdaFile, sdaFileDate,
currentSdaFile
-------------------------------------------------------------------------------
isValidSdaSet : determines whether or not a value is a valid SDA set
(set instance actually exists)
boolean = isValidSdaSet(fileNumber, caseValue [,setNumber] [,sdaUsage])
Arguments:
fileNumber file number to test
caseValue case value to test (number or name)
[setNumber] set number to test
(default is 0)
[sdaUsage] desired SDA usage string
(default is "Collider")
This function returns values as follows:
TRUE is a valid SDA set
FALSE is not a valid SDA set
Related functions:
isValidSdaFile, isValidSdaCase, dateToSdaFile, sdaFileDate,
currentSdaFile
-------------------------------------------------------------------------------
julianDate : converts a date value to a julian date
julianDate = julianDate([date])
Arguments:
[date] date value to convert
(default is now)
This function returns values as follows:
converted Julian date
Related functions:
julianDateToDate, dateToString, stringtoDate, convertSeconds, timeAgo,
timeFromDate, timeSinceEvent, cpuTime, systemTime, 15HzCount, timer,
currentTimeInClinks, currentTime, localtime
-------------------------------------------------------------------------------
julianDateToDate : converts a julian date value to a date
date = julianDateToDate([julianDate])
Arguments:
[julianDate] Julian date value to convert
(default is now)
This function returns values as follows:
converted date
Related functions:
julianDate, dateToString, stringtoDate, convertSeconds, timeAgo,
timeFromDate, timeSinceEvent, cpuTime, systemTime, 15HzCount, timer,
currentTimeInClinks, currentTime, localtime
-------------------------------------------------------------------------------
justify : left justify, right justify, or center a string
string = justify(sourceString [,justifyType])
Arguments:
sourceString source string
[justifyType] justification type
(none -> leave string as is (default),
left -> left justify,
right -> right justify,
center -> center string)
This function returns values as follows:
modified string
Related functions:
leftJustify, rightJustify, center, leftShift, rightShift, strShift, pad
-------------------------------------------------------------------------------
land : logical and
boolean = land(value, value2)
Arguments:
value first value
value2 second value
This function returns values as follows:
TRUE
FALSE
Related functions:
lor
-------------------------------------------------------------------------------
lastCharPos : find the last nonblank character position in a string
position = lastCharPos(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
0 no nonblank characters were not found
otherwise character position (starts at 1)
Related functions:
firstCharPos, getLastChar, getFirstChar, stringEndsWith,
stringStartsWith, findChar, findNotChar
-------------------------------------------------------------------------------
leftJustify : left justify a string
string = leftJustify(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
modified string
Related functions:
justify, rightJustify, center, leftShift, rightShift, strShift, pad
-------------------------------------------------------------------------------
leftShift : left shift a string
string = leftShift(sourceString [,numChars])
Arguments:
sourceString source string
[numChars] number of characters to shift
(default is 1)
This function returns values as follows:
modified string
Related functions:
strShift, rightShift, justify, leftJustify, rightJustify, center, pad
-------------------------------------------------------------------------------
leftTrim : removes leading blanks from a string
string = leftTrim(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
modified string
Related functions:
trim, rightTrim, toTrimmedString, pad
-------------------------------------------------------------------------------
lexSaDevices : returns devices in a Lex SA display
numDevices = lexSaDevices(lexSaName, [,deviceNames] [,properties]
[,arrayIndices] [,fullNames])
Arguments:
lexSaName Lex SA name
[deviceNames] returned device names
[properties] returned device properties
[arrayIndices] returned device array indices
[fullNames] flag indicating whether or not to return
full device names
(fullNames -> want full device names,
normalNames -> want normal device names (default))
This function returns values as follows:
number of devices found in the Lex SA display
Related functions:
fileDevices, sqlQueryDevices, loggerListDevices, userAlarmListDevices,
userSaveListDevices, parameterPageDevices, synopticDevices
-------------------------------------------------------------------------------
ln : natural log (base e)
logValue = ln(value)
Arguments:
value original value
This function returns values as follows:
natural (base e) logarithm of argument
Synonyms: loge
Related functions:
log, exp
-------------------------------------------------------------------------------
localtime : breaks down a date value into its component values
date = localtime([date] [,year] [,month] [,day] [,hour] [,minute]
[,second] [,yearDay] [,weekDay] [,isDst]
[,monthIndex] [,dayIndex])
Arguments:
[date] date to break down
(default is the present time)
[year] returned year value
[month] returned month string value
[day] returned day of the month value
[hour] returned hour value
[minute] returned minute value
[second] returned second value
[yearDay] returned day of the year value
[weekDay] returned day of the week string value
[isDst] returned DST boolean value
[monthIndex] returned month index value
[dayIndex] returned day of the week index value
This function returns values as follows:
date value in seconds
Synonyms: brokenDownTime
Related functions:
stringToDate, dateToString, currentTimeInClinks, currentTime,
millisecondsNow, convertSeconds, timeAgo, timeFromDate, timeSinceEvent,
cpuTime, systemTime, 15HzCount, timer, julianDate, julianDateToDate
-------------------------------------------------------------------------------
log : base 10 log
logValue = log(value)
Arguments:
value original value
This function returns values as follows:
base 10 logarithm of argument
Synonyms: log10
Related functions:
ln
-------------------------------------------------------------------------------
loggerListDevices : returns the devices in a data logger list
numDevices = loggerListDevices(loggerNode, list [,devices] [,fullNames])
Arguments:
loggerNode logger node
list logger list number (0-17)
[devices] returned logger list device names
[fullNames] flag indicating whether or not to return
full device names
(fullNames -> want full device names,
normalNames -> want normal device names (default))
This function returns values as follows:
number of devices being logged in the requested list
Related functions:
allLoggerNodes, loggerListDeviceStats, loggerListInfo,
loggerListWrapTime, whereDeviceIsLogged, oldestLoggerTime,
loggerNameToNode, nodeToLoggerName, whereDeviceWasLogged
-------------------------------------------------------------------------------
loggerListDeviceStats : returns logger list device configuration stats
numDevices = loggerListDeviceStats(loggerNode, list [,numElements]
[,maxElesPerDev] [,minArrayIndex]
[,maxArrayIndex] [,hasReading]
[,hasSetting] [,hasStatus])
Arguments:
loggerNode logger node
list logger list number (0-17)
[numElements] returned total number of elements logged
[maxElesPerDev] returned maximum number of elements per device
[minArrayIndex] returned minimum device array index
[maxArrayIndex] returned maximum device array index
[hasReading] returned flag indicating the presence of
reading properties
[hasSetting] returned flag indicating the presence of
setting properties
[hasStatus] returned flag indicating the presence of
status properties
This function returns values as follows:
number of devices being logged
Related functions:
loggerListInfo, loggerListWrapTime, whereDeviceIsLogged,
oldestLoggerTime, loggerNameToNode, nodeToLoggerName,
whereDeviceWasLogged
-------------------------------------------------------------------------------
loggerListInfo : returns general logger list information
numDevices = loggerListInfo(loggerNode, list [,name] [,numEvents]
[,events] [,maxElements] [,numElements]
[,maxElesPerDev] [,minArrayIndex]
[,maxArrayIndex] [,hasReading]
[,hasSetting] [,hasStatus])
Arguments:
loggerNode logger node
list logger list number (0-17)
[name] returned list name
[numEvents] returned number of supported data events
[events] returned data event(s)
[maxElements] returned maximum number of elements that list can hold
[numElements] returned total number of elements logged
[maxElesPerDev] returned maximum number of elements per device
[minArrayIndex] returned minimum device array index
[maxArrayIndex] returned maximum device array index
[hasReading] returned flag indicating the presence of
reading properties
[hasSetting] returned flag indicating the presence of
setting properties
[hasStatus] returned flag indicating the presence of
status properties
This function returns values as follows:
number of devices being logged
Related functions:
loggerListDeviceStats, loggerListWrapTime, whereDeviceIsLogged,
oldestLoggerTime, loggerNameToNode, nodeToLoggerName,
whereDeviceWasLogged
-------------------------------------------------------------------------------
loggerListWrapTime : returns a logger list wrap time in hours
wrapTime = loggerListWrapTime(loggerNode, list)
Arguments:
loggerNode logger node
list logger list number (0-17)
This function returns values as follows:
list wrap time in hours
Related functions:
loggerListInfo, loggerListDeviceStats, whereDeviceIsLogged,
oldestLoggerTime, loggerNameToNode, nodeToLoggerName,
whereDeviceWasLogged
-------------------------------------------------------------------------------
loggerNameToNode : converts a data logger name to its corresponding node
node = loggerNameToNode(loggerName)
Arguments:
loggerName logger name to convert
This function returns values as follows:
corresponding node
Related functions:
nodeToLoggerName, oldestLoggerTime, whereDeviceIsLogged,
loggerListInfo, loggerListDeviceStats, loggerListWrapTime,
whereDeviceWasLogged
-------------------------------------------------------------------------------
loggersOnNode : returns the data loggers running on an ACNET node
numLoggers = loggersOnNode([node] [,loggerNames])
Arguments:
[node] node of interest
(default is local node)
[loggerNames] returned data logger names
This function returns values as follows:
number of data loggers found
Related functions:
oacsOnNode, coresidentNodes, nodeAcnetTasks, node, nodeIs, nodeIsUp
-------------------------------------------------------------------------------
loopLevel : returns the current loop level of the script (debugging)
level = loopLevel()
This function returns values as follows:
loop level of the script (for debugging purposes)
Related functions:
ifLevel, variableType, valueType
-------------------------------------------------------------------------------
lor : logical or
boolean = lor(value, value2)
Arguments:
value first value
value2 second value
This function returns values as follows:
TRUE
FALSE
Related functions:
land
-------------------------------------------------------------------------------
lowestBit : returns the lowest bit set in a value (or -1)
bitNumber = lowestBit(sourceValue [,startBit] [,numBits])
Arguments:
sourceValue value to check
[startBit] starting bit number (starts at 1)
(default is 1)
[numBits] number of bits to check
(default is 32)
This function returns values as follows:
-1 no bits were set
otherwise lowest set bit number starting at 1
Related functions:
highestBit, bit, bitCount, clearBit, setBit, bitField, bitComplement,
circularShift
-------------------------------------------------------------------------------
lshft : circular left shift
value = lshft(sourceValue, numShift)
Arguments:
sourceValue value to modify
numShift number of bits to shift by
This function returns values as follows:
modified value with the bits circularly shifted to the left
Related functions:
circularShift, rshft, clearBit, setBit, bit, bitCount, bitField,
bitComplement
-------------------------------------------------------------------------------
makePrintable : expand any tabs and remove or replace any nonprintable
characters in a string
string = makePrintable(sourceString [,modifyType])
Arguments:
sourceString source string
[modifyType] string modification type
(remove -> remove nonprintable characters (default),
replace -> replace nonprintable characters with
blanks)
This function returns values as follows:
modified string
Related functions:
stripNonprintables, isPrintableString
-------------------------------------------------------------------------------
max : maximum of two values
maximumValue = max(value, value2)
Arguments:
value first value
value2 second value
This function returns values as follows:
maximum value
Related functions:
min, mean, median, mode, minimum, maximum, sum, range, rms, stddev,
variance, identical
-------------------------------------------------------------------------------
maximum : maximum of an array of values
maxValue = maximum(value [,value2...])
Arguments:
value first value (This argument can be an array value.
To indicate a range of array values, use the
value[m:n] notation. To indicate the entire
array, use the value[] notation.)
[value2...] subsequent values (These must be single values.)
This function returns values as follows:
maximum value
Related functions:
minimum, mean, median, mode, sum, range, rms, stddev, variance,
identical, min, max
-------------------------------------------------------------------------------
mean : mean of an array of values
meanValue = mean(value [,value2...])
Arguments:
value first value (This argument can be an array value.
To indicate a range of array values, use the
value[m:n] notation. To indicate the entire
array, use the value[] notation.)
[value2...] subsequent values (These must be single values.)
This function returns values as follows:
mean value
Related functions:
median, mode, minimum, maximum, sum, range, rms, stddev, variance,
identical, min, max, histogram
-------------------------------------------------------------------------------
median : median of an array of values
medianValue = median(value [,value2...])
Arguments:
value first value (This argument can be an array value.
To indicate a range of array values, use the
value[m:n] notation. To indicate the entire
array, use the value[] notation.)
[value2...] subsequent values (These must be single values.)
This function returns values as follows:
median value
Related functions:
mean, mode, minimum, maximum, sum, range, rms, stddev, variance,
identical, min, max, histogram
-------------------------------------------------------------------------------
millisecondsNow : returns the current time in milliseconds
since the Epoch
milliseconds = millisecondsNow([timeReference])
Arguments:
[timeReference] time reference
(delta -> return delta time since previous call,
scriptStart -> return delta time since start
of script)
(default is the beginning of the Epoch)
This function returns values as follows:
milliseconds since the Epoch
Related functions:
15hzCount, currentTime, currentTimeInClinks, systemTime, cpuTime,
timer, timeSinceEvent, timeAgo, timeFromDate, stringToDate,
dateToString, convertSeconds, julianDate, julianDateToDate, localtime
-------------------------------------------------------------------------------
min : minimum of two values
minimumValue = min(value, value2)
Arguments:
value first value
value2 second value
This function returns values as follows:
minimum value
Related functions:
max, mean, median, mode, minimum, maximum, sum, range, rms, stddev,
variance, identical, histogram
-------------------------------------------------------------------------------
minimum : minimum of an array of values
minValue = minimum(value [,value2...])
Arguments:
value first value (This argument can be an array value.
To indicate a range of array values, use the
value[m:n] notation. To indicate the entire
array, use the value[] notation.)
[value2...] subsequent values (These must be single values.)
This function returns values as follows:
minimum value
Related functions:
maximum, mean, median, mode, sum, range, rms, stddev, variance,
identical, min, max, histogram
-------------------------------------------------------------------------------
mode : returns the most commonly occurring value in an array
(If there are multiple mode values, the smallest value
is returned.)
modeValue = mode(value [,value2...])
Arguments:
value first value (This argument can be an array value.
To indicate a range of array values, use the
value[m:n] notation. To indicate the entire
array, use the value[] notation.)
[value2...] subsequent values (These must be single values.)
This function returns values as follows:
smallest mode value
Related functions:
median, mean, minimum, maximum, sum, range, rms, stddev, variance,
identical, min, max, histogram
-------------------------------------------------------------------------------
myConsole : returns the caller's console number
consoleNumber = myConsole()
Arguments:
<none>
This function returns values as follows:
console number
Related functions:
myConsoleClass, myConsoleInstance, myConsoleSlot, myExecutableName,
myHostName, myNode, myProcessName, myGenericProcessName, myUserName
-------------------------------------------------------------------------------
myConsoleClass : returns the caller's console class
classMask = myConsoleClass()
Arguments:
<none>
This function returns values as follows:
console class mask
Related functions:
myConsole, myConsoleInstance, myConsoleSlot, myExecutableName,
myHostName, myNode, myProcessName, myGenericProcessName, myUserName,
consoleClassMaskToString, stringToConsoleClassMask
-------------------------------------------------------------------------------
myConsoleInstance : returns the caller's console instance number
instanceNumber = myConsoleInstance()
Arguments:
<none>
This function returns values as follows:
console instance number
Related functions:
myConsole, myConsoleClass, myConsoleSlot, myExecutableName,
myHostName, myNode, myProcessName, myGenericProcessName, myUserName
-------------------------------------------------------------------------------
myConsoleSlot : returns the caller's console slot
consoleSlot = myConsoleSlot()
Arguments:
<none>
This function returns values as follows:
console slot
Related functions:
myConsole, myConsoleClass, myConsoleInstance, myExecutableName,
myHostName, myNode, myProcessName, myGenericProcessName, myUserName
-------------------------------------------------------------------------------
myExecutableName : returns the caller's executable name
name = myExecutableName([nameType])
Arguments:
[nameType] name type
(fullPath -> return the full path (default),
rootOnly -> return the root of the name)
This function returns values as follows:
executable name
Related functions:
myConsole, myConsoleClass, myConsoleInstance, myConsoleSlot,
myHostName, myNode, myProcessName, myGenericProcessName, myUserName
-------------------------------------------------------------------------------
myGenericProcessName : returns the caller's generic process name
name = myGenericProcessName()
Arguments:
<none>
This function returns values as follows:
generic process name
Related functions:
myProcessName, myConsole, myConsoleClass, myConsoleInstance,
myConsoleSlot, myExecutableName, myHostName, myNode, myUserName
-------------------------------------------------------------------------------
myHostName : returns the caller's host name
name = myHostName()
Arguments:
<none>
This function returns values as follows:
host name
Related functions:
myConsole, myConsoleClass, myConsoleInstance, myConsoleSlot,
myExecutableName, myNode, myProcessName, myGenericProcessName,
myUserName
-------------------------------------------------------------------------------
myNode : returns the caller's ACNET node
node = myNode()
Arguments:
<none>
This function returns values as follows:
ACNET node
Related functions:
myConsole, myConsoleClass, myConsoleInstance, myConsoleSlot,
myExecutableName, myHostName, myProcessName, myGenericProcessName,
myUserName
-------------------------------------------------------------------------------
myProcessName : returns the caller's process name
name = myProcessName([nameType])
Arguments:
[nameType] name type
(generic -> generic process name (default),
current -> current process name,
full -> full process name)
This function returns values as follows:
process name
Related functions:
myGenericProcessName, myConsole, myConsoleClass, myConsoleInstance,
myConsoleSlot, myExecutableName, myHostName, myNode, myUserName
-------------------------------------------------------------------------------
mySystemInfo : returns basic system information
hostName = mySystemInfo([domainName] [,opSystem] [,opRelease]
[,opVersion] [,machine])
Arguments:
[domainName] returned domain name
[opSystem] returned operating system
[opRelease] returned operating system release
[opVersion] returned operating system version
[machineType] returned machine type
This function returns values as follows:
host name
Related functions:
myConsole, myConsoleClass, myConsoleInstance, myConsoleSlot,
myExecutableName, myHostName, myNode, myProcessName,
myGenericProcessName, myUserName
-------------------------------------------------------------------------------
myUserName : returns the caller's user name
userName = myUserName()
Arguments:
<none>
This function returns values as follows:
user name
Related functions:
myConsole, myConsoleClass, myConsoleInstance, myConsoleSlot,
myExecutableName, myHostName, myNode, myProcessName,
myGenericProcessName
-------------------------------------------------------------------------------
name : returns a device name string
string = name(device)
Arguments:
device device of interest
This function returns values as follows:
device name string
Related functions:
fullName, text, fullText
-------------------------------------------------------------------------------
networkServiceToPort : converts a network service name to a port
port = networkServiceToPort(serviceName)
Arguments:
serviceName service name to convert
This function returns values as follows:
port number
Related functions:
<none>
-------------------------------------------------------------------------------
newestSrFile : returns the newest save/restore file number
fileNumber = newestSrFile([category])
Arguments:
[category] desired save/restore category
(all -> all categories (default),
global,
linac,
booster,
mainInjector,
externalBeams,
tevatron,
pbar,
frig (cryo),
electronCooling,
archive,
recycler,
shots,
circular,
miniboone,
numi,
hins,
nml)
This function returns values as follows:
newest save/restore file number for the requested category
Related functions:
oldestSrFile, saveFileInfo, currentSdaFile, dateToSdaFile, sdaFileDate
-------------------------------------------------------------------------------
nextSibling : returns the device's next sibling (or 0)
siblingDevice = nextSibling(device)
Arguments:
device device of interest
This function returns values as follows:
device's next sibling
Related functions:
previousSibling, controllingDevice
-------------------------------------------------------------------------------
node : converts a node name to a value
nodeValue = node(value [,outputType])
Arguments:
value value to convert (device, string, or node value)
(If the value is a device value, the node for that
device will be used.)
[outputType] output type
(numeric -> integer value (default),
name -> node symbolic name string,
trunkNode -> trunk/node string,
hex -> hex string,
ipName -> IP name string,
ipAddress -> IP address string,
device -> treat value as a device index and
return the corresponding node value)
This function returns values as follows:
node value
Related functions:
isNodeString, nodeIs, nodeIsUp, nodeAcnetTasks, error, isErrorString,
device, name, fullName, text, fullText
-------------------------------------------------------------------------------
nodeAcnetTasks : retrieves the ACNET tasks for a given node
numTasks = nodeAcnetTasks([node] [,taskNames] [,isRum] [,taskIds]
[,pids])
Arguments:
[node] node of interest
(default is local node)
[taskNames] returned ACNET task names
[isRum] returned flags indicating whether or not the
corresponding tasks are RUM connected (server)
[taskIds] returned ACNET task IDs
[pids] returned process IDs
This function returns values as follows:
number of ACNET tasks found
Related functions:
taskExists, taskPidToName, taskIdToName, node, nodeIs, nodeIsUp
-------------------------------------------------------------------------------
nodeAttributeValue : returns ACNET node attribute values
value = nodeAttributeValue(node, attribute)
Arguments:
node node to retrieve value for
attribute node attribute type
(name -> node name,
description -> node description,
location -> node location,
keeper -> node keeper,
keeperEmail -> node keeper email,
backupKeeper -> node backup keeper,
backupKeeperEmail -> node backup keeper email,
status -> node status,
system -> node system type,
software -> node software type,
hardware -> node hardware type,
opsys -> node operating system,
area -> node area,
readDevice -> node guaranteed readable device,
setDevice -> node guaranteed settable device,
todDevice -> node time of day device,
uptimeDevice -> node uptime device,
downloadDevice -> node download device,
rebootDevice -> node reboot device,
versionDevice -> node version device,
ipName -> node IP name,
url -> node help URL)
This function returns values as follows:
node attribute value
Related functions:
cacheNodeInfo, nodeIs, nodeIsUp, isIrmNode, isLabviewNode,
isMoocNode, isOacNode, isAcsysFefNode
-------------------------------------------------------------------------------
nodeConsolidator : returns the consolidating node(s) for a node
primaryNode = nodeConsolidator(node [,secondaryNode])
Arguments:
node node to retrieve consolidator node(s) for
[secondaryNode] returned secondary consolidator node value
This function returns values as follows:
primary consolidator node value
Related functions:
nodeAttributeValue, cacheNodeInfo, nodeIs, nodeIsUp, isIrmNode,
isLabviewNode, isMoocNode, isOacNode, isAcsysFefNode
-------------------------------------------------------------------------------
nodeIs : determines whether or not the specified node has a particular
status or type
boolean = nodeIs(node, attrType, attrValue)
Arguments:
node node to check
attrType node attribute type
(status -> node status,
system -> node system type,
software -> node software type,
hardware -> node hardware type,
opsys -> node operating system,
area -> node area)
attrValue node attribute value
This function returns values as follows:
TRUE node matches the requested attribute value
FALSE node doesn't match the requested attribute value
Related functions:
nodeIsUp
-------------------------------------------------------------------------------
nodeIsUp : determines whether or not the specified node is up
boolean = nodeIsUp(node)
Arguments:
node node to check
This function returns values as follows:
TRUE node is up
FALSE node is down
Related functions:
nodeIs, acnetPing
-------------------------------------------------------------------------------
nodeToLoggerName : convert a node value to a data logger name
loggerName = nodeToLoggerName(node)
Arguments:
node node to convert
This function returns values as follows:
corresponding logger name
Related functions:
loggerNameToNode, whereDeviceIsLogged, oldestLoggerTime,
loggerListInfo, loggerListDeviceStats, loggerListWrapTime,
whereDeviceWasLogged
-------------------------------------------------------------------------------
nodeToTrunkNode : converts an ACNET node value to its component
trunk and node number
isValidNode = nodeToTrunkNode(node [,trunk] [,nodeNumber])
Arguments:
node ACNET node value
[trunk] returned trunk number
[nodeNumber] returned node number
This function returns values as follows:
TRUE is valid ACNET node value
FALSE is not a valid ACNET node value
Related functions:
trunkNodeToNode, node, ipNameToNode, isNodeString, nodeIs, nodeIsUp
-------------------------------------------------------------------------------
nonblankLength : returns the nonblank length of a string
length = nonblankLength(string [,maxLength])
Arguments:
string string to determine the length of
[maxLength] maximum length to return
(default is infinite)
This function returns values as follows:
nonblank string length
Related functions:
stringLength, delimitedStringLength, sizeof, sizeofVariable
-------------------------------------------------------------------------------
numElements : returns the number of elements in a variable or a
device specification (dynamic)
numberOfElements = numElements(object)
Arguments:
object object (device or variable) to determine the number
of elements of
This function returns values as follows:
number of elements
Related functions:
sizeof, byteSizeof, sizeofVariable, byteSizeofVariable, variableType
-------------------------------------------------------------------------------
numReadableProperties : returns the number of readable properties
for a device (optionally also returns the
array of properties)
numProperties = numReadableProperties(device [,properties])
Arguments:
device device of interest
[property] returned array of properties found
This function returns values as follows:
number of readable properties found for the requested device
Related functions:
numSettableProperties, deviceProperties, hasProperty, hasReading,
hasSetting, hasStatus, hasControl, hasAnalogAlarm, hasDigitalAlarm,
deviceDownloadProperties, device
-------------------------------------------------------------------------------
numSettableProperties : returns the number of settable properties
for a device (optionally also returns the
array of properties)
numProperties = numSettableProperties(device [,properties])
Arguments:
device device of interest
[property] returned array of properties found
This function returns values as follows:
number of settable properties found for the requested device
Related functions:
numReadableProperties, deviceProperties, hasProperty, hasReading,
hasSetting, hasStatus, hasControl, hasAnalogAlarm, hasDigitalAlarm,
deviceDownloadProperties, device
-------------------------------------------------------------------------------
oacsOnNode : returns the names of OACs running on an ACNET node
numOacs = oacsOnNode([node] [,oacNames])
Arguments:
[node] node of interest
(default is local node)
[oacNames] returned OAC (Open Access CLient) names
This function returns values as follows:
number of OACs found
Related functions:
loggersOnNode, coresidentNodes, nodeAcnetTasks, node, nodeIs, nodeIsUp
-------------------------------------------------------------------------------
octal : returns a value as an octal string
string = octal(value [,convertLength] [,fillChar] [,dataType])
Arguments:
value value to convert
[convertLength] converted string length
[fillChar] fill character
[dataType] data type
(integer,
float,
double)
(default is to use the native type of the value)
This function returns values as follows:
converted string value
Synonyms: toOctal
Related functions:
hex, binary, decimal, radix, toString, toTrimmedString, rad50ToString
-------------------------------------------------------------------------------
oldestLoggerTime : returns the oldest timestamp for a logged device
date = oldestLoggerTime(device [,loggerNode] [,dataEvent])
Arguments:
device device to check
[loggerNode] logger node to check
(default is "fastest")
[dataEvent] data event string to check for
(default is null string)
This function returns values as follows:
oldest logged timestamp for the requested device
Related functions:
loggerNameToNode, nodeToLoggerName, whereDeviceIsLogged,
loggerListInfo, loggerListDeviceStats, loggerListWrapTime,
whereDeviceWasLogged, oldestSrFile, newestSrFile, currentSdaFile,
dateToSdaFile, sdaFileDate
-------------------------------------------------------------------------------
oldestSrFile : returns the oldest save/restore file number
fileNumber = oldestSrFile([category])
Arguments:
[category] desired save/restore category
(all -> all categories (default),
global,
linac,
booster,
mainInjector,
externalBeams,
tevatron,
pbar,
frig (cryo),
electronCooling,
archive,
recycler,
shots,
circular,
miniboone,
numi,
hins,
nml)
This function returns values as follows:
oldest save/restore file number for the requested category
Related functions:
newestSrFile, saveFileInfo, currentSdaFile, dateToSdaFile, sdaFileDate
-------------------------------------------------------------------------------
openFile : opens a file for reading and/or writing
fileId = openFile(fileName [,openMode] [,flushFile])
Arguments:
fileName file to open
[openMode] file open mode
(r (default),
w,
a,
r+,
w+,
a+)
[flushFile] flag indicating whether or not to flush the file
after each write
(flush,
noFlush (default))
This function returns values as follows:
file ID for use by future file functions
Synonyms: fopen, fileOpen
Related functions:
closeFile, fileGetString, filePrintf, fscanf, fileRead, fileRewind,
fileWrite, fileFlush
-------------------------------------------------------------------------------
or : bitwise or
resultValue = or(value, value2)
Arguments:
value first value
value2 second value
This function returns values as follows:
bitwise or of the two arguments
Related functions:
xor, and
-------------------------------------------------------------------------------
pad : pads a string with a specified character to a specified length
string = pad(sourceString, padLength [,padChar])
Arguments:
sourceString source string
padLength length to pad the string to
(If the length is less than the present length
of the string, the string is truncated.)
[padChar] pad character
(default is blank)
This function returns values as follows:
modified string
Related functions:
pos, trim, leftTrim, rightTrim, toTrimmedString
-------------------------------------------------------------------------------
pageTitle : returns the title for a page
title = pageTitle(page)
Arguments:
page page to retrieve title for (ex: 'M4')
This function returns values as follows:
page title
Related functions:
programMapping
-------------------------------------------------------------------------------
parameterPageDevices : returns the devices on a parameter page
numDevices = parameterPageDevices(paramPage, [,deviceNames]
[,arrayIndices] [,fullNames])
Arguments:
paramPage parameter page subpage
({page}:{subpage 1}[:{subpage 2}][:{subpage 3}])
[deviceNames] returned device names
[arrayIndices] returned device array indices
[fullNames] flag indicating whether or not to return
full device names
(fullNames -> want full device names,
normalNames -> want normal device names (default))
This function returns values as follows:
number of devices found on the parameter page
Related functions:
fileDevices, sqlQueryDevices, loggerListDevices, userAlarmListDevices,
userSaveListDevices
-------------------------------------------------------------------------------
parseFileName : parses a file name into its component pieces
fileName = parseFileName(fullFileName [,filePath] [,rootFileName]
[,fileExt])
Arguments:
fullFileName full file name
[filePath] returned file path
[rootFileName] returned root file name
[fileExt] returned file extension
This function returns values as follows:
file name
Related functions:
expandFileName, openFile, closeFile, fileGetString, filePrintf, fscanf,
fileRead, fileRewind, fileWrite, findFileInPath, findInFile
-------------------------------------------------------------------------------
playBeep : plays a beep sound
status = playBeep([console] [,volume])
Arguments:
[console] console to play beep on
(default is local console)
[volume] beep volume
(default is 100)
This function returns values as follows:
execution status
Related functions:
playSound
-------------------------------------------------------------------------------
playSound : plays an existing sound file
status = playSound(soundFile [,console])
Arguments:
soundFile sound file name
[console] console to play beep on
(default is local console)
This function returns values as follows:
execution status
Related functions:
playBeep
-------------------------------------------------------------------------------
pos : pads with spaces/truncates a string to a specified length
string = pos(sourceString, padLength)
Arguments:
sourceString source string
padLength length to pad the string to
(If the length is less than the present length
of the string, the string is truncated.)
This function returns values as follows:
modified string
Related functions:
pad, trim, leftTrim, rightTrim, toTrimmedString
-------------------------------------------------------------------------------
prec : output precision (eg. prec(value,fraction_digits))
roundedValue = prec(value, numDigits)
Arguments:
value value to round
numDigits number of digits to round to
This function returns values as follows:
rounded value
Related functions:
round, trunc, abs
-------------------------------------------------------------------------------
previousSibling : returns the device's previous sibling (or 0)
siblingDevice = previousSibling(device)
Arguments:
device device of interest
This function returns values as follows:
device's previous sibling
Related functions:
nextSibling, controllingDevice
-------------------------------------------------------------------------------
printf : functions like printf with the additional functionality
of toString
numChars = printf(formatString [,arg1] ...)
Arguments:
formatString format string
[arg1] first value to format
This function returns values as follows:
number of characters output
Related functions:
printfNoNewline, sprintf, filePrintf, toString, toTrimmedString,
formatDateString, stringCopy, toNumeric
-------------------------------------------------------------------------------
printfNoNewline : functions like printf with the additional
functionality of toString (no newline added)
numChars = printfNoNewline(formatString [,arg1] ...)
Arguments:
formatString format string
[arg1] first value to format
This function returns values as follows:
number of characters output
Related functions:
printf, sprintf, filePrintf, toString, toTrimmedString,
formatDateString, stringCopy, toNumeric
-------------------------------------------------------------------------------
processExists : determines if a process exists
boolean = processExists(processName [,wildcard] [,searchType]
[,numPids] [,processNames] [,pids])
Arguments:
processName process name (or pid)
[wildcard] flag indicating whether or not the name is wildcarded
(default is FALSE)
[searchType] search type
(name -> search by process name (default),
userName -> search by user name,
userId -> search by user ID,
groupName -> search by group name,
groupId -> search by group ID,
parentPid -> search by parent pid)
[numPids] returned number of matching pids
[processNames] returned matching process names
[pids] returned matching pids
This function returns values as follows:
TRUE process exists
FALSE process does not exist
Related functions:
processInfo, taskExists, nodeAcnetTasks, taskId, taskPid, isServerTask,
taskIdToName, taskPidToName
-------------------------------------------------------------------------------
processInfo : retrieves information about a process
name = processInfo(pid [,commandLine] [,startTime] [,userName]
[,userId] [,groupName] [,groupId] [,parentPid]
[,state] [,memorySize] [,rss] [,cpuTime]
[,numThreads])
Arguments:
pid process pid
[commandLine] returned command line
[startTime] returned process start time
[userName] returned process user name
[userId] returned process user ID
[groupName] returned process group name
[groupId] returned process group ID
[parentPid] returned parent process' pid
[state] returned process state
[memorySize] returned process memory size
[rss] returned resident set size (memory)
[cpuTime] returned total CPU time used (in clock ticks)
[numThread] returned number of process threads
This function returns values as follows:
process name
Related functions:
processExists, taskExists, nodeAcnetTasks, taskId, taskPid,
isServerTask, taskIdToName, taskPidToName
-------------------------------------------------------------------------------
programMapping : returns the pages that a program is mapped to
numPages = programMapping(program [,pages])
Arguments:
program program to retrieve mapping for
(ex: 'PA0052', 'M4', 52)
[pages] returned array of mapped pages
This function returns values as follows:
number of pages found
Related functions:
pageTitle
-------------------------------------------------------------------------------
quoteString : adds beginning and ending quotes to a string
string = quoteString(sourceString [,quoteChar])
Arguments:
sourceString source string
[quoteChar] quote character
This function returns values as follows:
modified string
Related functions:
stripQuotes, isQuotedString
-------------------------------------------------------------------------------
rad50ToString : converts a radix 50 value to a string
string = rad50ToString(rad50Value)
Arguments:
rad50Value rad50 value to convert
This function returns values as follows:
converted string
Related functions:
stringToRad50, isRad50String, radix, decimal, hex, binary, octal
-------------------------------------------------------------------------------
radix : returns a value as an arbitrary radix (2-36) string
string = radix(value, radixValue [,convertLength] [,fillChar]
[,dataType])
Arguments:
value value to convert
radixValue conversion radix (2-36)
[convertLength] converted string length
[fillChar] fill character
[dataType] data type
(integer,
float,
double)
(default is to use the native type of the value)
This function returns values as follows:
converted string value
Synonyms: toRadix
Related functions:
hex, binary, octal, decimal, toString, toTrimmedString, rad50ToString
-------------------------------------------------------------------------------
random : returns pseudo random numbers from 0 to 2^31 - 1
value = random([maximum] [,minimum])
Arguments:
[maximum] maximum random number to return
(default is 2^31 - 1)
[minimum] minimum random number to return
(default is 0)
This function returns values as follows:
pseudo random number
Synonyms: rand
Related functions:
randomSeed
-------------------------------------------------------------------------------
randomSeed : sets the seed value for the random function
randomSeed([seedValue])
Arguments:
[seedValue] desired random seed
(default is a pseudo random number)
This function returns values as follows:
0 (return value is meaningless)
Synonyms: srand
Related functions:
random
-------------------------------------------------------------------------------
range : range of an array of values
rangeValue = range(value [,value2...])
Arguments:
value first value (This argument can be an array value.
To indicate a range of array values, use the
value[m:n] notation. To indicate the entire
array, use the value[] notation.)
[value2...] subsequent values (These must be single values.)
This function returns values as follows:
range of the values
Related functions:
mean, median, mode, minimum, maximum, sum, rms, stddev, variance,
identical, min, max, histogram
-------------------------------------------------------------------------------
readLock : retrieves information about a lock
status = readLock(lockName [,checkLock] [,lockTime] [,owner]
[,ipNode] [,pid] [,nodeConsole] [,slot])
Arguments:
lockName desired lock name
[checkLock] check to see if the lock is still valid
(default is FALSE)
[lockTime] returned timestamp when lock was acquired
[owner] returned owner of the lock
[ipNode] returned IP address of the owner of the lock
[pid] returned process ID of owner of the lock
[nodeConsole] returned ACNET node or console number of lock owner
[slot] returned console slot of lock owner
This function returns values as follows:
LOCK_OK lock does not exist
LOCK_OTHER another process has the lock
LOCK_ALREADY the calling process has the lock
Related functions:
readProgramLocks
-------------------------------------------------------------------------------
readProgramLocks : retrieves the locks held by a program
numLocks = readProgramLocks([ownerName] [,node] [,checkLocks]
[,lockName] [,lockTime] [,pid]
[,console] [,slot])
Arguments:
[ownerName] owner/program name
(default is the calling program)
[node] owner/program name
(default is the calling program's node)
[checkLocks] check to see if the returned locks are still valid
(default is FALSE)
[lockName] returned lock name(s)
[lockTime] returned timestamps when locks were acquired
[pid] returned process ID of owner of the lock
[console] returned console number of lock owner
[slot] returned console slot of lock owner
This function returns values as follows:
number of locks
Related functions:
readLock
-------------------------------------------------------------------------------
regexpCompareString : compares a string to a pattern (case sensitive)
value = regexpCompareString(string, pattern [,case])
Arguments:
string string to compare
pattern pattern to compare
[case] case sensitivity
(caseSensistive (default),
caseInsensitive)
This function returns values as follows:
0 strings match
otherwise strings don't match
Related functions:
regexpCompareStringNocase, stringCompare, stringCompareNocase,
byteCompare
-------------------------------------------------------------------------------
regexpCompareStringNocase : compares a string to a pattern
(case insensitive)
value = regexpCompareStringNocase(string, pattern)
Arguments:
string string to compare
pattern pattern to compare
This function returns values as follows:
0 strings match
otherwise strings don't match
Related functions:
regexpCompareString, stringCompare, stringCompareNocase,
byteCompare
-------------------------------------------------------------------------------
regexpFindString : returns the position of one string within another
using regular expressions for the search
position = regexpFindString(searchString, sourceString [,option1]
[,option2] [,option3])
Arguments:
searchString search string
sourceString source string
[option1...3] optional argument strings
(caseSensitive -> case sensitive,
caseInsensitive -> case insensitive (default),
useBasic -> use basic regular expressions,
useExtended -> use extended regular expressions,
normalNl -> treat new lines as normal characters,
specialNl -> treat new lines as special characters)
This function returns values as follows:
0 search string was not found
otherwise match position (starts at 1)
Related functions:
findString, findChar, findNotChar, findTagString, stringStartsWith
-------------------------------------------------------------------------------
regexpReplaceString : replaces one string with another string in a
string using regular expressions for the search
string = regexpReplaceString(searchString, replaceString, sourceString
[,option1] [,option2] [,option3]
[,option4])
Arguments:
searchString search string
replaceString replacement string
sourceString source string
[option1...4] optional arguments
(caseSensitive -> case sensitive,
caseInsensitive -> case insensitive (default),
useBasic -> use basic regular expressions,
useExtended -> use extended regular expressions,
normalNl -> treat new lines as normal characters,
specialNl -> treat new lines as special characters,
all -> replace all instances (default),
n -> replace the first n occurrences)
This function returns values as follows:
modified source string
Related functions:
replaceString, replaceChar
-------------------------------------------------------------------------------
regexpSplit : splits up a string based upon finding a delimiter string
which is a regular expression
numStrings = regexpSplit(sourceString [,delimiter] [,strings])
Arguments:
sourceString source string
[delimiter] delimiter string
(default is a blank)
[strings] returned array of substrings
This function returns values as follows:
number of substrings
Related functions:
split, splitByCharSet
-------------------------------------------------------------------------------
repeatString : repeats a substring a number of times
string = repeatString(copyString, numCopies [,separator])
Arguments:
copyString string to copy multiple times
numCopies number of copies to make of the string
[separator] separator string to place between adjacent copies
(default is no separator)
This function returns values as follows:
repeated string
Related functions:
stringCopy
-------------------------------------------------------------------------------
replaceBracketedString : replace a bracketed substring
string = replaceBracketedString(leftBracket, rightBracket,
replaceString, sourceString
[,option1] [,option2] [,option3])
Arguments:
leftBracket left bracket string
rightBracket right bracket string
replaceString replacement string
sourceString source string
[option1...3] optional argument strings
(caseSensitive -> case sensitive,
caseInsensitive -> case insensitive (default),
ignoreSpaces -> ignore spaces while matching,
wildcard=c -> specify a wildcard character,
preserveBrackets -> retain the bracket strings)
This function returns values as follows:
modified source string
Related functions:
replaceString, regexpReplaceString, replaceChar
-------------------------------------------------------------------------------
replaceChar : replaces any of a set of characers with another character
string = replaceChar(searchChars, replaceChar, sourceString
[,option1])
Arguments:
searchChars search characters
replaceChar replacement character
sourceString source string
[option1] optional argument
(all -> replace all instances (default),
n -> replace the first n occurrences)
This function returns values as follows:
modified source string
Related functions:
replaceString, regexpReplaceString, replaceBracketedString
-------------------------------------------------------------------------------
replaceString : replaces one string with another string in a string
string = replaceString(searchString, replaceString, sourceString
[,option1] [,option2] [,option3] [,option4])
Arguments:
searchString search string
replaceString replacement string
sourceString source string
[option1...4] optional argument strings
(caseSensitive -> case sensitive,
caseInsensitive -> case insensitive (default),
ignoreSpaces -> ignore spaces while matching,
wildcard=c -> specify a wildcard character,
all -> replace all instances (default),
n -> replace the first n occurrences)
This function returns values as follows:
modified source string
Related functions:
regexpReplaceString, replaceBracketedString, replaceChar
-------------------------------------------------------------------------------
reverse : reverses a string
string = reverse(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
modified string
Related functions:
arrayInvert
-------------------------------------------------------------------------------
rightJustify : right justify a string
string = rightJustify(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
modified string
Related functions:
justify, leftJustify, center, leftShift, rightShift, strShift, pad
-------------------------------------------------------------------------------
rightShift : right shift a string
string = rightShift(sourceString [,numChars])
Arguments:
sourceString source string
[numChars] number of characters to shift
(default is 1)
This function returns values as follows:
modified string
Related functions:
strShift, leftShift, justify, leftJustify, rightJustify, center, pad
-------------------------------------------------------------------------------
rightTrim : removes trailing blanks from a string
string = rightTrim(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
modified string
Related functions:
trim, leftTrim, toTrimmedString, pad
-------------------------------------------------------------------------------
rms : RMS of an array of values
rmsValue = rms(value [,value2...])
Arguments:
value first value (This argument can be an array value.
To indicate a range of array values, use the
value[m:n] notation. To indicate the entire
array, use the value[] notation.)
[value2...] subsequent values (These must be single values.)
This function returns values as follows:
RMS of the values
Related functions:
mean, median, mode, minimum, maximum, sum, range, stddev, variance,
identical, min, max, histogram
-------------------------------------------------------------------------------
round : round (to a specified number of digits)
roundedValue = round(value [,numDigits])
Arguments:
value value to round
[numDigits] number of digits to round to
(default is 0)
This function returns values as follows:
rounded value
Related functions:
prec, trunc, abs
-------------------------------------------------------------------------------
rshft : circular right shift
value = rshft(sourceValue, numShift)
Arguments:
sourceValue value to modify
numShift number of bits to shift by
This function returns values as follows:
modified value with the bits circularly shifted to the right
Related functions:
circularShift, lshft, clearBit, setBit, bit, bitCount, bitField,
bitComplement
-------------------------------------------------------------------------------
saveFileInfo : returns information about a single save/restore file
exists = saveFileInfo(fileNumber [,title] [,startDate] [,endDate]
[,numProperties] [,numErrors])
Arguments:
fileNumber file number of file to retrieve
[title] returned save file title
[startDate] returned save starting date
[endDate] returned save ending date
[numProperties] returned number of saved properties
[numErrors] returned number of save errors
This function returns values as follows:
TRUE save file exists
FALSE save file does not exist
Related functions:
oldestSrFile, newestSrFile
-------------------------------------------------------------------------------
scondif : returns the second argument as a string if the first has a
value of true or the third argument as a string if it has
a value of false
stringValue = scondif(booleanValue, trueStringValue, falseStringValue)
Arguments:
booleanValue boolean value to test
trueStringValue string value to return if the first argument
has a value of TRUE
falseStringValue string value to return if the first argument
has a value of FALSE
This function returns values as follows:
selected string value
Related functions:
condif
-------------------------------------------------------------------------------
sdaFileDate : returns the starting or ending date for an SDA file
date = sdaFileDate([fileNumber] [,sdaUsage] [,whichDate])
Arguments:
[fileNumber] file number to convert
(current SDA file number)
[sdaUsage] desired SDA usage string
(default is "Collider")
[whichDate] which date to return
(start -> return starting date (default),
end -> want ending date)
This function returns values as follows:
corresponding SDA file date
Related functions:
dateToSdaFile, currentSdaFile, isValidSdaFile, isValidSdaCase,
isValidSdaSet
-------------------------------------------------------------------------------
secant : secant
resultValue = secant(value)
Arguments:
value value to take the secant of in radians
This function returns values as follows:
secant value of the argument
Related functions:
cosecant, cotan, cotand, tan, tand, tanh, atan, atand, atan2, atan2d,
atanh, cos, cosd, cosh, sin, sind, sinh, acos, acosd, acosh, asin,
asind, asinh
-------------------------------------------------------------------------------
setBit : set a bit in a value
value = setBit(sourceValue, bitNumber)
Arguments:
sourceValue value to modify
bitNumber bit number (starts at 1)
This function returns values as follows:
modified value with the requested bit set
Related functions:
clearBit, bit, bitCount, bitField, circularShift, bitComplement,
setBitField
-------------------------------------------------------------------------------
setBitField : sets a bit field value
value = setBitField(sourceValue, fieldValue, startBit [,numBits])
Arguments:
sourceValue value to modify
fieldValue field value to set
startBit starting bit number (starts at 1)
[numBits] number of bits to set
(default is 1)
This function returns values as follows:
modified value with the requested bit field set
Related functions:
setBit, clearBit, bit, bitCount, bitField, circularShift, bitComplement
-------------------------------------------------------------------------------
setenv : sets an environment variable to a value
status = setenv(envVariable [,value])
Arguments:
envVariable environment variable name
[value] setting value
(default is null string)
This function returns values as follows:
OK
Related functions:
getenv, delenv, getLogicalName, setLogicalName, deleteLogicalName
-------------------------------------------------------------------------------
setLogicalName : sets a logical name to a value
status = setLogicalName(logicalName [,value] [,nameType])
Arguments:
logicalName logical name
[value] setting value
(default is null string)
[nameType] type of logical name
(group (default),
process)
This function returns values as follows:
OK
Related functions:
getLogicalName, deleteLogicalName, getenv, setenv, delenv
-------------------------------------------------------------------------------
settingsAreEnabled : determines if settings are enabled
(supports optional device argument)
areEnabled = settingsAreEnabled([device])
Arguments:
[device] optional device to check specifically if that
device can be set
This function returns values as follows:
TRUE settings are enabled
FALSE settings are not enabled
Related functions:
none
-------------------------------------------------------------------------------
setUserAlarmListStatus : sets the status of a user alarm list
status = setUserAlarmListStatus(alarmList, listStatus)
Arguments:
alarmList alarm list name
({system}\{name})
listStatus desired list status
(bypass -> mark the list as bypassed,
enable -> mark the list as enabled)
This function returns values as follows:
enabled alarm list is enabled
bypassed alarm list is disabled
empty alarm list is empty
Related functions:
userAlarmList
-------------------------------------------------------------------------------
sin : sine
resultValue = sin(value)
Arguments:
value value to take the sine of in radians
This function returns values as follows:
sine value of the argument
Related functions:
sind, asin, asind, asinh, sinh, acos, acosd, acosh, cos, cosd, cosh
-------------------------------------------------------------------------------
sind : sine (argument in degrees)
resultValue = sind(value)
Arguments:
value value to take the sine of in degrees
This function returns values as follows:
sine value of the argument
Related functions:
sin, asin, asind, asinh, sinh, acos, acosd, acosh, cos, cosd, cosh
-------------------------------------------------------------------------------
sinh : hyperbolic sine
resultValue = sinh(value)
Arguments:
value value to take the hyperbolic sine of
This function returns values as follows:
hyperbolic sine value of the argument
Related functions:
sin, sind, asin, asind, asinh, acos, acosd, acosh, cos, cosd, cosh
-------------------------------------------------------------------------------
sizeof : returns the number of elements in a device, device list, input, or variable
numElements = sizeof(value)
Arguments:
value value to determine the number of elements of
(device property, variable, or device list)
This function returns values as follows:
number of elements
Related functions:
sizeofVariable, byteSizeof, byteSizeofVariable, numElements, exists
-------------------------------------------------------------------------------
sizeofVariable : returns the number of elements in a variable (dynamic)
numberOfElements = sizeofVariable(variable)
Arguments:
variable variable to determine the number of elements of
This function returns values as follows:
number of elements
Related functions:
sizeof, byteSizeof, byteSizeofVariable, numElements, variableType
-------------------------------------------------------------------------------
snapManagerDataDirectory : returns snapshot manager data file
information
numFiles = snapManagerDataDirectory(system [,device] [,startTime]
[,endTime] [,devices] [,systems]
[,dates] [,records] [,errors]
[,fullNames])
Arguments:
system detached snapshot manager system
(all
linac,
booster,
mainInjector
tevatron
switchyard
pbar
cryogenics
cdf
recycler
store
global
scratch
crew
hins
numi
MISCELLANEOUS)
[device] device of interest
(default is all devices)
[startTime] start time
(default is oldest existing date)
[endTime] end time
(default is now)
[devices] returned matching device names
[systems] returned matching system names
[dates] returned matching file dates
[records] returned matching file records
[errors] returned matching file error status values
[fullNames] flag indicating whether or not to return
full device names
(fullNames -> want full device names,
normalNames -> want normal device names (default))
This function returns values as follows:
number of matching files
Related functions:
snapshotMaxFreq
-------------------------------------------------------------------------------
snapshotMaxFreq : returns the maximum snapshot plot frequency for a
device or plot class and optionally the number of
points as well
maxFreq = snapshotMaxFreq(device [,maxPoints])
Arguments:
device device of interest
[maxPoints] returned maximum number of points
This function returns values as follows:
maximum snapshot frequency
Related functions:
ftpMaxFreq, snapManagerDataDirectory
-------------------------------------------------------------------------------
split : splits up a string based upon finding a delimiter string
numStrings = split(sourceString [,delimiter] [,strings] [,options...])
Arguments:
sourceString source string
[delimiter] delimiter string
(default is a blank)
[strings] returned array of substrings
[options] variable number of split options
(caseSensitive -> make case sensitive string comparions,
caseInsensitive -> make case insensitive string comparions (default),
trim -> trim leading and trailing spaces (default),
noTrim -> don't trim leading or trailing spaces)
This function returns values as follows:
number of substrings
Related functions:
splitByCharSet, regexpSplit
-------------------------------------------------------------------------------
splitByCharSet : splits up a string based upon finding any of a set
of delimiter characters
numStrings = splitByCharSet(sourceString [,delimiters] [,strings]
[,options...])
Arguments:
sourceString source string
[delimiters] delimiter characters
(default is all white space characters)
[strings] returned array of substrings
[options] variable number of split options
(trim -> trim leading and trailing spaces (default),
noTrim -> don't trim leading or trailing spaces,
handleQuotes -> handle substrings which are quoted
strings,
handleEmbeddedQuotes -> handle substrings which have
quoted strings embedded
in them
preserveQuotes -> preserve the quote characters
in quoted substrings,
handleBraces -> handle substrings which are bracketed
strings,
handleEmbeddedBraces -> handle substrings which have
bracketed strings embedded
in them,
handleParentheses -> handle substrings which are
parenthetical strings,
handleEmbeddedParentheses -> handle substrings which
have parenthetical
strings embedded in them)
This function returns values as follows:
number of substrings
Related functions:
split, regexpSplit
-------------------------------------------------------------------------------
sprintf : formats output strings like sprintf with the additional
functionality of toString
string = sprintf(formatString [,arg1] ...)
Arguments:
formatString format string
[arg1] first value to format
This function returns values as follows:
formatted string
Related functions:
toString, toTrimmedString, formatDateString, stringCopy, toNumeric
-------------------------------------------------------------------------------
sqlQueryDevices : returns devices from a SQL query
numDevices = sqlQueryDevices(server, database, sqlString [,deviceNames]
[,allowObsolete] [,fullNames])
Arguments:
server server name
(default is ADBS)
database database name
(default is appdb)
sqlString SQL string to retrieve devices
[deviceNames] returned device names
[allowObsolete] flag indicating whether or not to allow obsolete devices
(obsolete -> allow obsolete devices,
noObsolete -> don't allow obsolete devices (default))
[fullNames] flag indicating whether or not to return
full device names
(fullNames -> want full device names,
normalNames -> want normal device names (default))
This function returns values as follows:
number of devices found by the query
Related functions:
fileDevices, loggerListDevices, userAlarmListDevices,
userSaveListDevices, parameterPageDevices
-------------------------------------------------------------------------------
sqrt : square root
resultValue = sqrt(value)
Arguments:
value original value
This function returns values as follows:
square root of argument
Related functions:
none
-------------------------------------------------------------------------------
sscanf : functions like sscanf with the additional functionality
of toNumeric
numConverted = sscanf(inputString, formatString [,arg1] ...)
Arguments:
inputString input string to convert
formatString format string
[arg1] first value to convert or conversion type
This function returns values as follows:
number of values converted
Synonyms: stringScanf
Related functions:
fscanf, openFile, closeFile, filePrintf, sprintf, printf, toNumeric,
toString, toTrimmedString, formatDateString, stringCopy
-------------------------------------------------------------------------------
ssdnToString : converts an SSDN value to a standard string
string = ssdnToString(ssdn)
Arguments:
ssdn SSDN to convert
This function returns values as follows:
converted string
Related functions:
stringToSsdn, emcToString, deviceSsdn, stringToEmc
-------------------------------------------------------------------------------
stateText : returns the text for a state of a state device
string = stateText(stateDevice [,stateNumber] [,noNumber])
Arguments:
stateDevice stateDevice
[stateNumber] state number
(default is the current state number)
[noNumber] format flag
(TRUE -> strip the leading numeric state value,
FALSE -> return the string including the state number)
(default is FALSE)
This function returns values as follows:
state text string
Related functions:
none
-------------------------------------------------------------------------------
stddev : standard deviation of an array of values
stddevValue = stddev(value [,value2...])
Arguments:
value first value (This argument can be an array value.
To indicate a range of array values, use the
value[m:n] notation. To indicate the entire
array, use the value[] notation.)
[value2...] subsequent values (These must be single values.)
This function returns values as follows:
standard deviation of the values
Related functions:
mean, median, mode, minimum, maximum, sum, range, rms, variance,
identical, min, max, histogram
-------------------------------------------------------------------------------
stepMotorIsMoving : determines whether or not a stepping motor
is currently moving
isMoving = stepMotorIsMoving(device)
Arguments:
device stepper motor device of interest
This function returns values as follows:
TRUE motor is moving
FALSE motor is not moving
Related functions:
<none>
-------------------------------------------------------------------------------
stringCompare : compares one string to another (case sensitive)
value = stringCompare(firstString, secondString [,compareLength]
[,firstIndex] [,secondIndex] [,case])
Arguments:
firstString first string to compare
secondString second string to compare
[compareLength] number of characters to compare
(default is to compare the entire strings)
[firstIndex] index in the first string to start comparing
(starts at 1)
(default is 1)
[secondIndex] index in the second string to start comparing
(starts at 1)
(default is 1)
[case] case sensitivity
(caseSensistive (default),
caseInsensitive)
This function returns values as follows:
0 strings match
otherwise strings don't match
Related functions:
stringCompareNocase, regexpCompareString, regexpCompareStringNocase,
stringCopy, stringGetChar, stringSetChar, substring, byteCompare,
byteCopy
-------------------------------------------------------------------------------
stringCompareNocase : compares one string to another (case insensitive)
value = stringCompareNocase(firstString, secondString [,compareLength]
[,firstIndex] [,secondIndex])
Arguments:
firstString first string to compare
secondString second string to compare
[compareLength] number of characters to compare
(default is to compare the entire strings)
[firstIndex] index in the first string to start comparing
(starts at 1)
(default is 1)
[secondIndex] index in the second string to start comparing
(starts at 1)
(default is 1)
This function returns values as follows:
0 strings match
otherwise strings don't match
Related functions:
stringCompare, regexpCompareStringNocase, regexpCompareString,
stringCopy, stringGetChar, stringSetChar, substring, byteCompare,
byteCopy
-------------------------------------------------------------------------------
stringConcatenate : concatenate two strings
string = stringConcatenate(leftString, rightString)
Arguments:
leftString left string to concatenate
rightString right string to concatenate
This function returns values as follows:
concatenated string
Synonyms: strcat, concatenateString
Related functions:
stringCopy, stringSetChar, substring, stringGetChar
-------------------------------------------------------------------------------
stringCopy : copies one string to another
string = stringCopy(destString, copyString [,copyLength]
[,destIndex] [,copyIndex])
Arguments:
destString string to copy to
copyString string to copy
[copyLength] number of characters to copy
(default is the length of the copy string and in this
case functions like strcpy)
[destIndex] index to start copying to (starts at 1)
(default is 1)
[copyIndex] index to start copying (starts at 1)
(default is 1)
This function returns values as follows:
modified string
Synonyms: strcpy, strncpy, copyString
Related functions:
byteCopy, stringSetChar, substring, stringGetChar, byteCompare
-------------------------------------------------------------------------------
stringEndsWith : determines if a string ends with a substring
position = stringEndsWith(sourceString, matchString [,option1])
Arguments:
sourceString source string
matchString substring to match
[option1] optional argument strings
(caseSensitive -> case sensitive,
caseInsensitive -> case insensitive (default))
This function returns values as follows:
0 matching string not found
otherwise matching character position (starts at 1)
Related functions:
stringStartsWith, getLastChar, getFirstChar, lastCharPos, firstCharPos,
findChar, findNotChar, findString, regexpFindString
-------------------------------------------------------------------------------
stringExtractLine : extract a line from a string
lineString = stringExtractLine(sourceString, lineLength)
Arguments:
sourceString source string (Note: The extracted string is
removed from this buffer.)
lineLength maximum length of one line
This function returns values as follows:
extracted string
Related functions:
stringLineInfo
-------------------------------------------------------------------------------
stringGetChar : retrieve a substring from a string
(similar to substring but with different defaults)
string = stringGetChar(sourceString [,startChar] [,numChars])
Arguments:
sourceString string to get substring from
[startChar] starting character position (starts at 1)
(default is 1)
[numChars] number of characters to copy
(default is 1)
This function returns values as follows:
desired substring
Related functions:
substring, stringCopy, stringSetChar, getFirstChar, getLastChar,
firstCharPos, stringStartsWith, findChar, findNotChar
-------------------------------------------------------------------------------
stringGetValue : returns the next token of the specified type from
a string and removes it from the original string
string = stringGetValue(sourceString, stringType [,terminators]
[,options] [,conditions] [,condTerms]
[,remainString])
Arguments:
sourceString source string (If this function is successful
and the "remainString" argument is omitted or
defaulted, this string is modified by setting
it to the remaining string after the extracted
string.)
stringType type of string to extract
(simpleString -> simple string with no imbedded
white space,
compoundString -> string with possible imbedded
white space,
alphanumeric -> simple alphanumeric string,
integer -> signed integer string,
hex -> hexadecimal string,
float -> floating point value string,
deviceName -> ACNET device name string,
deviceFullName -> ACNET device full name string,
simpleDeviceName -> ACNET device name string
with no property indicators,
quotedString -> quoted string (enclosed by either
single (') or double (") quotes),
textLine -> line of text terminated by either
a line feed character or a line feed/
carriage return combination)
[terminators] terminator characters
[options] retrieval options
(none -> no options selected (default),
skipTerminator -> start the string remainder past
the terminator character,
handleQuotes -> preserve quoted strings,
handleParentheses -> preserve parenthetical strings)
[conditions] condition flags
(none -> no conditions selected (default),
firstAlphabetic -> first character is alphabetic,
firstNotNumeric -> first character is not numeric,
isNumericValue -> current value is numeric,
notNumericValue -> current value is not numeric,
isDeviceValue -> current value is a device,
notDeviceValue -> current value is not a device,
previousNotNumeric -> previous character is not
numeric)
[condTerms] condition terminator characters
[remainString] remaining string after the extracted string
(If this argument is omitted or defaulted,
the source string argument will be set to
this value.)
This function returns values as follows:
extracted string
Related functions:
stringToken, split, regexpSplit, splitByCharSet
-------------------------------------------------------------------------------
stringLength : returns the length of a string
length = stringLength(string [,maxLength])
Arguments:
string string to determine the length of
[maxLength] maximum length to return
(default is infinite)
This function returns values as follows:
string length
Related functions:
delimitedStringLength, nonblankLength, sizeof, sizeofVariable
-------------------------------------------------------------------------------
stringLineInfo : determines how many lines are in a string
numLines = stringLineInfo(sourceString, lineLength [,longestLine])
Arguments:
sourceString source string
lineLength maximum length of one line
[longestLine] returned length of the longest line
This function returns values as follows:
number of lines contained in the string
Related functions:
stringExtractLine
-------------------------------------------------------------------------------
stringSetChar : overwrite a substring of one string with another
(similar to stringCopy)
string = stringSetChar(destString, copyIndex, copyString)
Arguments:
destString string to modify
copyIndex index to start copying (starts at 1)
copyString string to copy
This function returns values as follows:
modified string
Related functions:
stringCopy, stringGetChar, substring
-------------------------------------------------------------------------------
stringStartsWith : determines if a string starts/ends with a substring
position = stringStartsWith(sourceString, matchString [,option1]
[,option2])
Arguments:
sourceString source string
matchString substring to match
[option1...2] optional argument strings
(caseSensitive -> case sensitive,
caseInsensitive -> case insensitive (default),
first -> match beginning of the string,
last -> match end of the string)
This function returns values as follows:
0 matching string not found
otherwise matching character position (starts at 1)
Related functions:
stringEndsWith, findChar, findNotChar, findString, regexpFindString
-------------------------------------------------------------------------------
stringToColor : converts a string to a color value
colorValue = stringToColor(string)
Arguments:
string string to convert
This function returns values as follows:
color value
Related functions:
stringToProperty, stringToConvertType, stringToRad50
-------------------------------------------------------------------------------
stringToConsoleClassMask : converts a string to a console class mask value
classMask = stringToConsoleClassMask(classString [,joinString])
Arguments:
classString string to convert
[joinString] join string between successive class names
(default is "+")
This function returns values as follows:
converted console class mask
Related functions:
consoleClassMaskToString, myConsoleClass
-------------------------------------------------------------------------------
stringToConvertType : converts a string to a convert type value
convertTypeValue = stringToConvertType(string)
Arguments:
string string to convert
This function returns values as follows:
convert type value
Related functions:
convertTypeToString, stringToColor, stringToProperty, stringToRad50
-------------------------------------------------------------------------------
stringToDate : converts a string to a date value
date = stringtoDate(string [,formatString])
Arguments:
string date string to convert
formatString format string suitable for use with strptime
This function returns values as follows:
date value in seconds
Related functions:
dateToString, convertSeconds, timeAgo, timeFromDate, timeSinceEvent,
cpuTime, systemTime, 15HzCount, timer, julianDate, julianDateToDate,
currentTimeInClinks, currentTime, localtime
-------------------------------------------------------------------------------
stringToDeviceName : finds device names matching a search string
numNames = stringToDeviceName(string [,deviceNames] [,nameType])
Arguments:
string search string
[deviceNames] returned matching device name(s)
[nameType] type of name to search for
(name[s] -> search normal names (default),
fullName[s] -> search full names)
This function returns values as follows:
number of matching device names
Related functions:
deviceFullNameToName
-------------------------------------------------------------------------------
stringToDouble : converts a string to a double precision
floating point value
numericValue = stringToDouble(string)
Arguments:
string string to convert
This function returns values as follows:
converted double precision floating point value
Related functions:
stringToInteger, toNumeric, toString, toTrimmedString
-------------------------------------------------------------------------------
stringToEmc : converts a string to an EMC value
emcLongword = stringToEmc(string [,emc])
Arguments:
string string to convert
[emc] returned EMC value
(If this argument has a data type of short,
the EMC is returned as 4 shorts.
If this argument has a data type of integer,
the EMC value is returned as 2 integers.
Otherwise, the EMC is returned as 8 bytes.)
This function returns values as follows:
first 4 bytes of the EMC
Related functions:
emcToString, stringToSsdn, ssdnToString, deviceEmc
-------------------------------------------------------------------------------
stringToInteger : converts a string to an integer
numericValue = stringToInteger(string)
Arguments:
string string to convert
This function returns values as follows:
converted integer value
Related functions:
stringToDouble, toNumeric, toString, toTrimmedString
-------------------------------------------------------------------------------
stringToken : returns the next token from a string and removes it from
the original string
string = stringToken(sourceString [,terminators] [,option])
Arguments:
sourceString source string (If this function is successful,
this string is modified by removing the extracted
string.)
[terminators] terminator characters
(default is all white space characters)
[option] parsing option
(none (default),
handleQuotes -> handle substrings which are quoted
strings,
preserveQuotes -> preserve the quote characters
in quoted substrings)
This function returns values as follows:
extracted string
Synonyms: stringGetToken
Related functions:
stringGetValue, split, regexpSplit, splitByCharSet
-------------------------------------------------------------------------------
stringToProperty : converts a string to a property value
propertyValue = stringToProperty(string)
Arguments:
string string to convert
This function returns values as follows:
property value
Related functions:
stringToColor, stringToRad50, stringToConvertType
-------------------------------------------------------------------------------
stringToRad50 : convert a string to a radix 50 value
rad50Value = stringToRad50(string)
Arguments:
string string to convert
This function returns values as follows:
rad50 value
Related functions:
rad50ToString, isRad50String, stringToColor, stringToProperty,
stringToConvertType
-------------------------------------------------------------------------------
stringToSsdn : converts a string to an SSDN value
ssdnLongword = stringToSsdn(string [,ssdn])
Arguments:
string string to convert
[ssdn] returned SSDN value
(If this argument has a data type of short,
the SSDN is returned as 4 shorts.
If this argument has a data type of integer,
the SSDN value is returned as 2 integers.
Otherwise, the SSDN is returned as 8 bytes.)
This function returns values as follows:
first 4 bytes of the SSDN
Related functions:
ssdnToString, stringToEmc, emcToString, deviceSsdn
-------------------------------------------------------------------------------
stringType : returns a string describing the argument string's type
typeString = stringType(string)
Arguments:
string string to determine the type of
This function returns values as follows:
unknown failed to determine the type of the string
blank blank string
alphabetic alphabetic string
alphanumeric alphanumeric string
numeric numeric (integer) string
float numeric (floating point) string
hex hexadecimal string
date date string
device device specification string
property device property string
node node string
error error name string
event clock event string
Related functions:
toNumeric, decimal, hex, toString, toTrimmedString
-------------------------------------------------------------------------------
stripBrackets : strips beginning and ending brackets from a string
string = stripBrackets(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
modified string
Related functions:
isBracketedString, stripQuotes, stripCharacters, stripSpaces,
stripNonprintables, stripHtml, stripEolCharacters
-------------------------------------------------------------------------------
stripCharacters : strips a requested set of characters from a string
string = stripCharacters(sourceString, stripChars)
Arguments:
sourceString source string
stripChars characters to strip
This function returns values as follows:
modified string
Related functions:
stripSpaces, stripNonprintables, stripHtml, stripQuotes,
stripEolCharacters
-------------------------------------------------------------------------------
stripEolCharacters : strips end of line characters from the end of
a string
string = stripEolCharacters(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
modified string
Related functions:
stripCharacters, stripSpaces, stripNonprintables, stripHtml, stripQuotes
-------------------------------------------------------------------------------
stripHtml : strips HTML tags from a string
string = stripHtml(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
modified string
Related functions:
stripCharacters, stripSpaces, stripNonprintables, stripQuotes,
stripEolCharacters
-------------------------------------------------------------------------------
stripNonprintables : strips nonprintable characters from a string
string = stripNonprintables(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
modified string
Related functions:
makePrintable, isPrintableString, stripCharacters, stripSpaces,
stripHtml, stripQuotes, stripEolCharacters
-------------------------------------------------------------------------------
stripQuotes : strips beginning and ending quotes from a string
string = stripQuotes(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
modified string
Related functions:
quoteString, isQuotedString, stripBrackets, stripCharacters,
stripSpaces, stripNonprintables, stripHtml, stripEolCharacters
-------------------------------------------------------------------------------
stripSpaces : strips any whitespace from a string
string = stripSpaces(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
modified string
Related functions:
stripCharacters, stripNonprintables, stripHtml, stripQuotes,
stripEolCharacters
-------------------------------------------------------------------------------
strncmp : compares the first n characters of two strings
value = strncmp(firstString, secondString [,compareLength]
[,firstIndex] [,secondIndex] [,case])
Arguments:
firstString first string to compare
secondString second string to compare
[compareLength] number of characters to compare
(default is to compare the entire strings)
[firstIndex] index in the first string to start comparing
(starts at 1)
(default is 1)
[secondIndex] index in the second string to start comparing
(starts at 1)
(default is 1)
[case] case sensitivity
(caseSensistive (default),
caseInsensitive)
This function returns values as follows:
0 strings match
otherwise strings don't match
Related functions:
stringCompare, stringCompareNocase, stringCopy, stringGetChar,
stringSetChar, substring, byteCompare, byteCopy
-------------------------------------------------------------------------------
strShift : left or right shift a string
string = strShift(sourceString, direction [,numChars])
Arguments:
sourceString source string
direction shift direction
(left or right)
[numChars] number of characters to shift
(default is 1)
This function returns values as follows:
modified string
Related functions:
leftShift, rightShift, justify, leftJustify, rightJustify, center, pad
-------------------------------------------------------------------------------
substring : returns a substring of a string
string = substring(sourceString, startChar [,numChars])
Arguments:
sourceString string to get substring from
startChar starting character position (starts at 1)
(If a negative value is passed, the starting
character will be that many characters from
the end of the string.)
numChars number of characters to copy
(default is the rest of the string from the
starting character)
This function returns values as follows:
desired substring
Related functions:
stringGetChar, stringCopy, stringSetChar
-------------------------------------------------------------------------------
sum : sum of an array of values
sumValue = sum(value [,value2...])
Arguments:
value first value (This argument can be an array value.
To indicate a range of array values, use the
value[m:n] notation. To indicate the entire
array, use the value[] notation.)
[value2...] subsequent values (These must be single values.)
This function returns values as follows:
sum of the values
Related functions:
mean, median, mode, minimum, maximum, range, rms, stddev, variance,
identical, min, max, histogram
-------------------------------------------------------------------------------
synopticDevices : returns devices in a Synoptic display
numDevices = synopticDevices(synopticName, [,deviceNames] [,fullNames])
Arguments:
synopticName Synoptic display name
[deviceNames] returned device names
[fullNames] flag indicating whether or not to return
full device names
(fullNames -> want full device names,
normalNames -> want normal device names (default))
This function returns values as follows:
number of devices found in the Synoptic display
Related functions:
fileDevices, sqlQueryDevices, loggerListDevices, userAlarmListDevices,
userSaveListDevices, parameterPageDevices, lexSaDevices
-------------------------------------------------------------------------------
systemTime : returns system time in milliseconds since ACL
was initialized
elapsedTime = systemTime([prevSysTime])
Arguments:
[prevSysTime] reference time
(delta -> time in milliseconds since last call,
scriptStart -> time in milliseconds since the
start of the script
otherwise -> previous system time in milliseconds)
(default is 0)
This function returns values as follows:
elapsed system time in milliseconds since ACL was initialized
Related functions:
cpuTime, 15HzCount, timer, timeAgo, timeFromDate, timeSinceEvent,
stringToDate, dateToString, convertSeconds, julianDate,
julianDateToDate, currentTimeInClinks, currentTime, localtime
-------------------------------------------------------------------------------
tail : returns the end of a string
string = tail(sourceString, numChars)
Arguments:
sourceString source string
numChars length of string to return
This function returns values as follows:
end of source string
Related functions:
head
-------------------------------------------------------------------------------
tan : tangent
resultValue = tan(value)
Arguments:
value value to take the tangent of in radians
This function returns values as follows:
tangent value of the argument
Related functions:
tand, tanh, atan, atand, atan2, atan2d, atanh, cos, cosd, cosh,
sin, sind, sinh, acos, acosd, acosh, asin, asind, asinh
-------------------------------------------------------------------------------
tand : tangent (argument in degrees)
resultValue = tand(value)
Arguments:
value value to take the tangent of in degrees
This function returns values as follows:
tangent value of the argument
Related functions:
tan, tanh, atan, atand, atan2, atan2d, atanh, cos, cosd, cosh,
sin, sind, sinh, acos, acosd, acosh, asin, asind, asinh
-------------------------------------------------------------------------------
tanh : hyperbolic tangent
resultValue = tanh(value)
Arguments:
value value to take the hyperbolic tangent of
This function returns values as follows:
hyperbolic tangent value of the argument
Related functions:
tan, tand, atan, atand, atan2, atan2d, atanh, cos, cosd, cosh,
sin, sind, sinh, acos, acosd, acosh, asin, asind, asinh
-------------------------------------------------------------------------------
taskExists : determines if an ACNET task exists
boolean = taskExists(taskName [,node] [,wildcard] [,numTasks]
[,taskNames])
Arguments:
taskName task name
[node] task node
(default is local machine)
[wildcard] flag indicating whether or not the name is wildcarded
(default is FALSE)
[numTasks] returned number of matching ACNET tasks
[taskNames] returned matching ACNET task names
This function returns values as follows:
TRUE task exists
FALSE task does not exist
Related functions:
nodeAcnetTasks, taskId, taskPid, isServerTask, taskIdToName,
taskPidToName, processExists, processInfo
-------------------------------------------------------------------------------
taskId : returns an ACNET task ID
id = taskId(taskName [,node])
Arguments:
taskName task name
[node] task node
(default is local machine)
This function returns values as follows:
task ID value
Related functions:
taskExists, taskPid, isServerTask, taskIdToName, taskPidToName
-------------------------------------------------------------------------------
taskIdToName : converts an ACNET task ID to a name
taskName = taskIdToName(id [,node])
Arguments:
id task ID
[node] task node
(default is local machine)
This function returns values as follows:
task name
Related functions:
taskId, taskPidToName, taskPid, taskExists, isServerTask
-------------------------------------------------------------------------------
taskPid : returns an ACNET task process ID
processId = taskPid(taskName [,node])
Arguments:
taskName task name
[node] task node
(default is local machine)
This function returns values as follows:
task process ID value
Related functions:
taskExists, taskId, isServerTask, taskIdToName, taskPidToName
-------------------------------------------------------------------------------
taskPidToName : converts an ACNET task process ID to name(s)
numTasks = taskPidToName(taskPid [,node] [,taskName])
Arguments:
taskPid task process ID
[node] task node
(default is local machine)
[taskName] returned task names
This function returns values as follows:
number of returned task names
Related functions:
taskPid, taskIdToName, taskId, taskExists, isServerTask
-------------------------------------------------------------------------------
text : returns a device descriptive text string
string = text(device)
Arguments:
device device of interest
This function returns values as follows:
device descriptive text string
Related functions:
fullText, name, fullName
-------------------------------------------------------------------------------
timeAgo : returns date which is some number of time units before a
base time
date = timeAgo(timeUnits [,numUnits] [,baseDate])
Arguments:
timeUnits time units
(sec -> seconds,
min -> minutes,
hour -> hour,
day -> day,
week -> week,
month -> month,
year -> year)
[numUnits] number of time units
(default is 1)
[baseDate] base date for calculation
(default is now)
This function returns values as follows:
calculated date in the past
Related functions:
timeFromDate, systemTime, cpuTime, timer, 15HzCount, timeSinceEvent,
stringToDate, dateToString, convertSeconds, julianDate,
julianDateToDate, currentTimeInClinks, currentTime, localtime
-------------------------------------------------------------------------------
timeFromDate : returns date which is some number of time units after a
base time
date = timeFromDate(timeUnits [,numUnits] [,baseDate])
Arguments:
timeUnits time units
(sec -> seconds,
min -> minutes,
hour -> hour,
day -> day,
week -> week,
month -> month,
year -> year)
[numUnits] number of time units
(default is 1)
[baseDate] base date for calculation
(default is now)
This function returns values as follows:
calculated date in the future
Related functions:
timeAgo, systemTime, cpuTime, timer, 15HzCount, timeSinceEvent,
stringToDate, dateToString, convertSeconds, julianDate,
julianDateToDate, currentTimeInClinks, currentTime, localtime
-------------------------------------------------------------------------------
timer : returns the current value of a timer
elapsedTime = timer(timerName [,units])
Arguments:
timerName timer of interest
[units] desired time units
(sec -> seconds,
ticks -> 15Hz ticks)
This function returns values as follows:
elapsed time since timer was created
Related functions:
systemTime, cpuTime, 15HzCount, timeAgo, timeFromDate, timeSinceEvent,
stringToDate, dateToString, convertSeconds, julianDate,
julianDateToDate, currentTimeInClinks, currentTime, localtime
-------------------------------------------------------------------------------
timeSinceEvent : returns the elapsed time since an event has occurred
seconds = timeSinceEvent(event [,eventType])
Arguments:
event clock event value
[eventType] type of clock event
(tclk -> TCLK event (default),
mibs -> MIBS clock event,
rrbs -> RRBS clock event,
tvbs -> TVBS clock event,
hins -> HINS clock event,
nml -> NML clock event,
test -> test clock event)
This function returns values as follows:
elapsed time in seconds since the requested clock event occurred
Related functions:
eventDate, eventOccurred, clearEventOccurred, eventCount, cpuTime,
systemTime, 15HzCount, timer, convertSeconds, timeAgo, timeFromDate,
stringToDate, dateToString, julianDate, julianDateToDate,
currentTimeInClinks, currentTime, localtime
-------------------------------------------------------------------------------
toLower : converts a string to lower case
string = toLower(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
modified string
Related functions:
toUpper, case, capitalize
-------------------------------------------------------------------------------
toNumeric : converts a string to its numeric value
numericValue = toNumeric(value [,convertType])
Arguments:
value value to convert
[convertType] optional conversion type
This function returns values as follows:
converted numeric value
Related functions:
toString, toTrimmedString, stringToDouble, stringToInteger,
formatDateString, stringCopy, sprintf
-------------------------------------------------------------------------------
toString : converts a value to its corresponding string
stringValue = toString(value [,convertLength] [,justify])
Arguments:
value value to convert
[convertLength] converted string length
[justify] string justification
(none -> no justification,
left -> left justification,
right -> right justification,
center -> center justification)
This function returns values as follows:
converted string value
Related functions:
toTrimmedString, toNumeric, formatDateString, stringCopy, sprintf
-------------------------------------------------------------------------------
totalNumberOfDevices : returns the total number of devices in the
control system
numDevices = totalNumberOfDevices([minDeviceIndex] [,maxDeviceIndex]
[options...])
Arguments:
[minDeviceIndex] returned minimum device index
[maxDeviceIndex] returned maximum active device index
[options...] query options
(obsolete -> include obsolete devices,
deleted -> include deleted devices)
This function returns values as follows:
number of active devices in the control system
Related functions:
none
-------------------------------------------------------------------------------
toTrimmedString : converts a value to a string with no spaces
stringValue = toTrimmedString(value [,convertLength] [,justify])
Arguments:
value value to convert
[convertLength] converted string length
[justify] string justification
(none -> no justification,
left -> left justification,
right -> right justification,
center -> center justification)
This function returns values as follows:
converted string value
Related functions:
toString, toNumeric, formatDateString, stringCopy, sprintf
-------------------------------------------------------------------------------
toUpper : converts a string to upper case
string = toUpper(sourceString)
Arguments:
sourceString source string
This function returns values as follows:
modified string
Related functions:
toLower, case, capitalize
-------------------------------------------------------------------------------
trim : removes leading and trailing blanks from a string
string = trim(sourceString [,trimType])
Arguments:
sourceString source string
[trimType] trim type
(both -> trim leading and trailing spaces (default),
left/beginning -> trim leading spaces,
right/ending -> trim trailing spaces)
This function returns values as follows:
modified string
Related functions:
leftTrim, rightTrim, toTrimmedString, pad
-------------------------------------------------------------------------------
trunc : truncate
truncatedValue = trunc(value)
Arguments:
value value to truncate
This function returns values as follows:
truncated value
Related functions:
round, prec, abs
-------------------------------------------------------------------------------
trunkNodeToNode : converts a trunk and node number into a node value
nodeValue = trunkNodeToNode(trunk, nodeNumber)
Arguments:
trunk trunk number
nodeNumber node number
This function returns values as follows:
node value
Related functions:
nodeToTrunkNode, node, ipNameToNode, isNodeString, nodeIs, nodeIsUp
-------------------------------------------------------------------------------
unescapeString : replaces escape characters in a string with their
original characters
string = unescapeString(sourceString, escapeType [,handleQuotes])
Arguments:
sourceString original string
escapeType type of escape characters
(C,
URL,
HTML)
[handleQuotes] preserve characters enclosed in a quoted string
This function returns values as follows:
modified string
Related functions:
escapeString
-------------------------------------------------------------------------------
units : returns a device units string
string = units(device [,property] [,scalingType])
Arguments:
device device of interest
[property] desired property
(reading,
setting)
(default is the implicit property from the device
argument)
[scalingType] scaling type
(common -> engineering units (default),
primary -> primary units)
This function returns values as follows:
units text string
Related functions:
deviceReadSetScaling, deviceScalingLength, name, fullName, text,
fullText
-------------------------------------------------------------------------------
userAlarmList : returns the state of a user alarm list
(enabled, bypassed, or empty)
status = userAlarmList(alarmList)
Arguments:
alarmList alarm list name
This function returns values as follows:
enabled alarm list is enabled
bypassed alarm list is disabled
empty alarm list is empty
Related functions:
setUserAlarmListStatus
-------------------------------------------------------------------------------
userAlarmListDevices : returns the devices in a user alarm list
numDevices = userAlarmListDevices(alarmList [,deviceNames])
Arguments:
alarmList user alarm list
({system}[\{list name}])
[deviceNames] returned device names
This function returns values as follows:
number of devices in the user alarm list
Related functions:
fileDevices, sqlQueryDevices, loggerListDevices,
userSaveListDevices, parameterPageDevices
-------------------------------------------------------------------------------
userSaveListDevices : returns the devices in a user save list
numDevices = userSaveListDevices(saveList [,deviceNames])
Arguments:
saveList user save list
({system}[\{category name}][\{list name}])
[deviceNames] returned device names
This function returns values as follows:
number of devices in the user save list
Related functions:
fileDevices, sqlQueryDevices, loggerListDevices,
userAlarmListDevices, parameterPageDevices
-------------------------------------------------------------------------------
valueToLogicalArray : converts bit values into a logical array
numBitsTested = valueToLogicalArray(sourceValue, logicalArray
[,startBit] [,numBits])
Arguments:
sourceValue value to convert
logicalArray returned logical array
(There will be one entry for each bit tested.
If necessary, the variable will be resized.)
[startBit] starting bit number (starts at 1)
(default is 1)
[numBits] number of bits to test
(default is all)
This function returns values as follows:
number of bits actually tested
Related functions:
bit, bitCount, lowestBit, highestBit, bitField, deviceBitField, bitText,
bitDataText
-------------------------------------------------------------------------------
valueType : returns the type of a value as a string
type = valueType(value)
Arguments:
value value to determine the type of
This function returns values as follows:
type of value as a string
Related functions:
variableType, variableNumReadings, variableNumSettings,
ifLevel, loopLevel
-------------------------------------------------------------------------------
variableNumReadings : returns the number of times a variable
has been read
numReadings = variableNumReadings(variable)
Arguments:
variable variable to get the number of readings for
This function returns values as follows:
number of times that the variable has been read
Related functions:
variableNumSettings, variableType, valueType, sizeofVariable,
byteSizeofVariable, numElements, ifLevel, loopLevel
-------------------------------------------------------------------------------
variableNumSettings : returns the number of times a variable
has been set
numSettings = variableNumSettings(variable)
Arguments:
variable variable to get the number of settings for
This function returns values as follows:
number of times that the variable has been set
Related functions:
variableNumReadings, variableType, valueType, sizeofVariable,
byteSizeofVariable, numElements, ifLevel, loopLevel
-------------------------------------------------------------------------------
variableType : returns the type of a variable as a string
type = variableType(variable)
Arguments:
variable variable to determine the type of
This function returns values as follows:
type of variable as a string
Related functions:
variableNumReadings, variableNumSettings, valueType, sizeofVariable,
byteSizeofVariable, numElements, ifLevel, loopLevel
-------------------------------------------------------------------------------
variance : variance of an array of values
varianceValue = variance(value [,value2...])
Arguments:
value first value (This argument can be an array value.
To indicate a range of array values, use the
value[m:n] notation. To indicate the entire
array, use the value[] notation.)
[value2...] subsequent values (These must be single values.)
This function returns values as follows:
variance of the values
Related functions:
mean, median, mode, minimum, maximum, sum, range, rms, stddev,
identical, min, max, histogram
-------------------------------------------------------------------------------
virtualMachineDevices : returns the devices belonging to a
virtual machine
numDevices = virtualMachineDevices(device [,machineDevices])
Arguments:
device device of interest
[machineDevices] returned devices which are members of
this virtual machine
This function returns values as follows:
number of devices which are members of this virtual machine
Related functions:
deviceVirtualMachine, controlledDevices, deviceInCompositeDevices,
deviceInFamilies
-------------------------------------------------------------------------------
whereDeviceIsLogged : returns where a device is logged
numLogged = whereDeviceIsLogged(device [,dataEvent] [,loggerNodes]
[,loggerLists] [,loggerEvents]
[,deviceNames])
Arguments:
device device of interest
[dataEvent] retrieval data event (default is null data event)
[loggerNodes] returned logger nodes
[loggerLists] returned logger list numbers (0-17)
[loggerEvents] returned data events
[deviceNames] returned device names
This function returns values as follows:
number of locations where the device is being logged
Related functions:
whereDeviceWasLogged, loggerListInfo, loggerListDeviceStats,
loggerListWrapTime, oldestLoggerTime, loggerNameToNode,
nodeToLoggerName
-------------------------------------------------------------------------------
whereDeviceWasLogged : returns where a device was logged in the past
numLogged = whereDeviceWasLogged(device [,dataEvent] [,options]
[,startDate] [,endDate]
[,loggerNodes] [,loggerLists]
[,loggerEvents] [,deviceNames]
[,deleteDates] [,userNames])
Arguments:
device device of interest
[dataEvent] retrieval data event (default is null data event)
[options] search option
(all -> match all device requests (default),
exact -> match the specific device elements specified)
[startDate] starting deletion date
(default is 01-JAN-1972 00:00:00)
[endDate] ending deletion date
(default is now)
[loggerNodes] returned logger nodes
[loggerLists] returned logger list numbers (0-17)
[loggerEvents] returned data events
[deviceNames] returned device names
[deleteDates] returned deletion dates
[userNames] returned user names who deleted the device
This function returns values as follows:
number of locations where the device was previously being logged
Related functions:
whereDeviceIsLogged, loggerListInfo, loggerListDeviceStats,
loggerListWrapTime, oldestLoggerTime, loggerNameToNode,
nodeToLoggerName
-------------------------------------------------------------------------------
wordCount : returns the number of words in a string
numWords = wordCount(sourceString, [,words] [,option])
Arguments:
sourceString source string
[words] returned array of words
[option] parsing options
(handleQuotes -> observe quoted strings)
This function returns values as follows:
number of words
Related functions:
characterCount, split, splitByCharSet, regexpSplit
-------------------------------------------------------------------------------
xor : bitwise exclusive or
resultValue = xor(value, value2)
Arguments:
value first value
value2 second value
This function returns values as follows:
bitwise exclusive or of the two arguments
Synonyms: exclusiveOr
Related functions:
or, and
-------------------------------------------------------------------------------