All tclSDDS commands begin with "sdds", and are followed by a space and then the desired sub-command. All commands return catchable errors. You can get a usage statement for every comand by typing "sdds <sub-command>".
# Example
if [catch {sdds open foo.sdds r} result] {
puts stderr "unable to open foo.sdds: $result"
exit
} else {
set fileDescriptor $result
}
set fd [sdds open foo.sdds r]
# You can retrieve the list of column, parameter, and array names in a file
sdds getNames $fd column
sdds getNames $fd parameter
sdds getNames $fd array
# You can retrieve meta data about any given column, parameter, or array.
# These commands set a tcl array, with one element for each piece of information.
sdds getColumnInformation $fd c1 c1Info
puts "$c1Info(name) $c1Info(units) $c1Info(description) etc.."
# The command parray will print out all the contents of an array
parray c1Info
# The commands for parameter and array are identical
sdds getParameterInformation $fd p1 p1Info
sdds getArrayInformation $fd a1 a1Info
# This returns a list of two parameters, one from each page
set parameterList [sdds getParameter $fd p1]
# This returns a single list of all pages of column data concatenated together
set colData [sdds getColumn $fd c1]
# Alternately, you may cycle through the pages manually until EOF is returned
set moreData 1
set n 1
while {$moreData} {
if [catch {sdds getColumn $fd c1 -page $n} res] {
if {![string compare $res EOF]} {
set moreData 0
} else {
puts stderr "error: $res"
exit
}
} else {
puts "page $n data: $res"
}
incr n
}
# Arrays must be retrieved one page at a time. The getArray command does not
# return the data, but rather sets an array variable in your current scope.
sdds getArray $fd tclArrayName a1 -page 1
parray tclArrayName
# Don't forget to close the file
sdds close $fd
# You can also do "sdds open new.sdds w SDDS_BINARY" set fd [sdds open new.sdds w] # Define all parameters, columns, and arrays sdds defineParameter $fd par1 -type SDDS_STRING -fixedValue "any thing" sdds defineParameter $fd par2 -type SDDS_DOUBLE -description "par" -units Amps sdds defineColumn $fd col1 -type SDDS_LONG sdds defineArray $fd sddsArray1 -type SDDS_DOUBLE -dimensions 2 # Write the header out sdds writeLayout $fd # Start a data page with 200 row max sdds startPage $fd 200 # Set the page data sdds setParameter $fd par2 123.234 sdds setColumn $fd col1 23 43 55 22 0 23 83 220 4401 32 # To set an array, first define the tcl array (a 2x3 array in this case) set tclArr(0,0) 23.3 set tclArr(0,1) 44.3 set tclArr(0,2) 1.0032 set tclArr(1,0) 2.0093 set tclArr(1,1) 483.0 set tclArr(1,2) 9 # Set the array, giving the range of each dimension as arguments sdds setArray $fd tclArr sddsArray1 2 3 # Write the data page out sdds writePage $fd # Can start additional data pages if desired sdds startPage $fd 200 ... sdds writePage $fd # Make sure to close the file sdds close $fd
# Example on how to load an sdds file into a tcl array.
if [catch {sdds load foo.sdds bar} result] {
puts stderr "unable to load foo.sdds: $result"
exit
} else {
# Printing out all parameter data
foreach name $bar(ParameterNames) {
set page 1
foreach data $bar(Parameter.$name) {
puts "page $page, $name = $data"
incr page
}
}
# Printing out all array data
foreach name $bar(ArrayNames) {
set page 1
foreach data $bar(Array.$name) {
array set temp $data
foreach index [array names temp] {
puts "page $page, $name\($index\) = $temp($index)"
}
incr page
}
}
# Printing out all column data
foreach name $bar(ColumnNames) {
set page 1
foreach data $bar(Column.$name) {
set row 1
foreach item $data {
puts "page $page, row $row, $name = $item"
incr row
}
incr page
}
}
}
# Example on how to save a two page sdds file using a predefined tcl array.
# Defining description
set bar(Description.Text) "Example file"
set bar(Description.Contents) "Random data"
# Defining parameters
set bar(ParameterNames) "Time Date"
set bar(ParameterInfo.Time) "type SDDS_LONG"
set now [clock seconds]
set tomorrow [expr $now + 86400]
set bar(Parameter.Time) [list $now $tomorrow]
set bar(Parameter.Date) [list [clock format $now] [clock format $tomorrow]]
# Defining arrays
set bar(ArrayNames) "Direction"
set bar(ArrayInfo.Direction) "type SDDS_CHARACTER dimensions 2"
set bar(Array.Direction) [list "0,0 n 0,1 s 1,0 e 1,1 w" "0,0 N 0,1 S 1,0 E 1,1 W"]
# Defining columns
set bar(ColumnNames) "Days Colors"
set bar(Column.Days) [list "Sunday Monday Tuesday" "Wednesday Thursday Friday Saturday"]
set bar(Column.Colors) [list "Red Orange Yellow" "Green Blue Purple White"]
if [catch {sdds save foo.sdds bar} result] {
puts stderr "unable to save foo.sdds: $result"
exit
}
Open an sdds file for read or write. Opening for write will replace any existing file contents. The SDDS_BINARY option is available when writing a file.
Closes sdds file and frees up resources.
Read given column from file and return as a list with one element per row. If -page option is omitted or 0, all pages are read and columns are concatenated. Pages start at number 1. You may proceed to read pages one at a time by incrementing the -page option until the command returns a catchable error with the return string "EOF". This indicates all pages have been read.
Read given parameter from file and return its value in a list. If -page option is omitted or 0, all pages are read and all parameter values are concatenated to one list. Pages start at number 1. You may proceed to read pages one at a time by incrementing the -page option until the command returns a catchable error with the return string "EOF". This indicates all pages have been read.
Read array from sdds file and create a tcl array with same dimensions. Nothing is returned with this call other than a catchable return.
Get all information associated with given sdds column name, and put it in given tcl array, one element per piece of information. Ie. array(units), array(symbol), array(type).
Get all information associated with given sdds parameter name, and put it in given tcl array, one element per piece of information. Ie. array(units), array(symbol), array(type).
Get all information associated with given sdds array name, and put it in given tcl array, one element per piece of information. Ie. array(units), array(symbol), array(type).
Find out what columns, parameters, or arrays are defined in an open file.
For writing files. Defines a new parameter. Defaults to type SDDS_STRING.
For writing files. Defines a new column. Defaults to type SDDS_STRING.
For writing files. Defines a new array. Defaults to type SDDS_STRING.
For writing files. Writes SDDS header out after all sdds defines are complete. This must precede sdds startPage.
For writing files. Begins a new SDDS data page. User supplies a maximum expected row count. This command must precede any sdds set commands.
For writing files. Sets given parameter in current data page. Note that given value must convert to native SDDS type given in corresponding sdds defineParameter command. Ie. don't give a string "abc" when the parameter was defined as SDDS_LONG.
For writing files. Sets given column in current data page. Note that given value(s) must convert to native SDDS type given in corresponding sdds defineColumn command. Ie. don't give a string "abc" when the column was defined as SDDS_LONG.
For writing files. Sets given row number in current data page. Note that given value(s) must convert to native SDDS type given in corresponding sdds defineColumn commands. Ie. don't give a string "abc" when the column was defined as SDDS_LONG.
For writing files. Sets given sdds array in current data page using data from tcl array. Tcl array is indexed as follows: array(1), or array(2,4), or array(1,3,0). Only one, two, and three-dimensional arrays are supported.
The arity of the tcl array must match that of the sdds array. Ie. tcl array must be 2d if sdds array was defined as 2d. In addition, the elements of the tcl array must convert to the native data type of the sdds array. You must supply the range of each dimension. Ie. if your tcl array is 2x3x5, you must indicated 2 3 5 as the last three arguments.
For writing files. Writes SDDS data page out to file. You must do another sdds startPage before setting any additional values.
For loading files into a tcl array.
For saving files from a tcl array.
epics/extensions/src/tcl/extensions/sddsYou must also link against the SDDS library which is in epics/extensions:
epics/extensions/src/SDDSThe xxAppInit.c file of your interpreter should include the following lines in order to initialize the tclSDDS extension:
if (TclSDDS_Init(interp) == TCL_ERROR) {
return TCL_ERROR;
}
The link command for your interpreter must include this library along with several SDDS libraries:-ltclSDDS -lSDDS1 -lrpnlib -lnamelist -lmdblib