TCL Layer Expressions for Headers
TCL expressions to manipulate headers are documented below.
hdrNew
hdrDel
hdrInsWithLogical
hdrInsWithDbl
hdrInsWithInt
hdrInsWithAscii
hdrDelByKeyword
hdrFree
hdrGetAsAscii
hdrGetAsDbl
hdrGetAsInt
hdrGetAsLogical
hdrGetLine
hdrGetLineCont
hdrGetLineno
hdrDelByLine
hdrReplaceLine
hdrMakeLineWithAscii
hdrMakeLineWithDbl
hdrMakeLineWithInt
hdrMakeLineWithLogical
hdrCopy
hdrPrint
A TCL expression to create a new empty header. This command is actually an
alias in dervishStartup.tcl for handleNewFromType HDR.
TCL SYNTAX:
hdrNew
RETURNS:
TCL_OK Successful completion. The Interp result string contains the
name of the handle that was created.
TCL_ERROR Error occurred. Depending on the nature of the error,
the Interp result string will contain an appropriate message.
A TCL expression to delete a header. This command is actually an
alias in dervishStartup.tcl for handleDelFromType. This
command should not be used to delete a header within a
region (see hdrFree instead).
TCL SYNTAX:
hdrDel <handle>
<handle> handle to a header
RETURNS:
TCL_OK Successful completion.
TCL_ERROR Error occurred. Depending on the nature of the error,
the Interp result string will contain an appropriate message.
A TCL expression to insert a double value in a header.
TCL SYNTAX:
hdrInsWithDbl <header> <keyword> <value> [comment]
<header> header expression
<keyword> keyword used to identify the value
<value> Double value to be inserted
[comment] Optional comment
RETURNS:
TCL_OK Successful completion.
TCL_ERROR Error occurred. Depending on the nature of the error,
the Interp result string will contain an appropriate message.
A TCL expression to insert an integer value in a header.
TCL SYNTAX:
hdrInsWithInt <header> <keyword> <value> [comment]
<header> header expression
<keyword> keyword used to identify the value
<value> Integer value to be inserted
[comment] Optional comment
RETURNS:
TCL_OK Successful completion.
TCL_ERROR Error occurred. Depending on the nature of the error,
the Interp result string will contain an appropriate message.
A TCL expression to insert an alphanumeric value in a header.
TCL SYNTAX:
hdrInsWithAscii <header> <keyword> <value> [comment]
<header> header expression
<keyword> keyword used to identify the value
<value> Alphanumeric value to be inserted
[comment] Optional comment
RETURNS:
TCL_OK Successful completion.
TCL_ERROR Error occurred. Depending on the nature of the error,
the Interp result string will contain an appropriate message.
A TCL expression to delete a line identified by a keyword from a header.
The header must exist in order for this expression to
execute successfully.
TCL SYNTAX:
hdrDelByKeyword <header> <keyword>
<header> header expression
<keyword> keyword used to identify the line to be deleted
RETURNS:
TCL_OK Successful completion
TCL_ERROR Error occurred. Depending on the nature of the error,
the Interp result string will contain an appropriate message.
A TCL expression to free all memory occupied by a header except the
actual header structure.
TCL SYNTAX:
hdrFree <header>
<header> header expression
RETURNS:
TCL_OK Successful completion
TCL_ERROR Error occurred. Depending on the nature of the error,
the Interp result string will contain an appropriate message.
A TCL expression to get an alphanumeric string identified by a keyword from a
header. The header must have been created before using this expression.
TCL SYNTAX:
hdrGetAsAscii <header> <keyword>
<header> header expression
<keyword> keyword to search the header by
RETURNS:
TCL_OK Successful completion
TCL_ERROR Error occurred. Depending on the nature of the error,
the Interp result string will contain an appropriate message.
A TCL expression to get a double identified by a keyword from a header.
The header must have been created before using this expression.
TCL SYNTAX:
hdrGetAsDbl <header> <keyword>
<header> header expression
<keyword> keyword to search the header by
RETURNS:
TCL_OK Successful completion
TCL_ERROR Error occurred. Depending on the nature of the error,
the Interp result string will contain an appropriate message.
A TCL expression to get an integer identified by a keyword from a header.
The header must have been created before using this expression.
TCL SYNTAX:
hdrGetAsInt <header> <keyword>
<header> header expression
<keyword> keyword to search the header by
RETURNS:
TCL_OK Successful completion
TCL_ERROR Error occurred. Depending on the nature of the error,
the Interp result string will contain an appropriate message.
A TCL expression to get a logical value (0 or 1) identified by a keyword from
a header. The header must have been created before using this expression.
TCL SYNTAX:
hdrGetAsLogical <header> <keyword>
<header> header expression
<keyword> keyword to search the header by
RETURNS:
TCL_OK Successful completion
TCL_ERROR Error occurred. Depending on the nature of the error,
the Interp result string will contain an appropriate message.
A TCL expression to get an entire line (vector) identified by a keyword from
a header. The header must have been created before using this expression.
TCL SYNTAX:
hdrGetLine <header> <keyword>
<header> header expression
<keyword> keyword to search the header by
RETURNS:
TCL_OK Successful completion
TCL_ERROR Error occurred. Depending on the nature of the error,
the Interp result string will contain an appropriate message.
A TCL expression to get an entire line (vector) identified by a line number from
a header. The header must have been created before using this expression.
TCL SYNTAX:
hdrGetLineCont <header> <lineno>
<header> header expression
<lineno> line number to search the header by
RETURNS:
TCL_OK Successful completion
TCL_ERROR Error occurred. Depending on the nature of the error,
the Interp result string will contain an appropriate message.
A TCL expression to get the line number on which a certain line occurred in
a header. The line to be searched for is identified by a keyword.
The header must have been created before using this expression.
TCL SYNTAX:
hdrGetLineno <header> <keyword>
<header> header expression
<keyword> keyword to search the header by
RETURNS:
TCL_OK Successful completion
TCL_ERROR Error occurred. Depending on the nature of the error,
the Interp result string will contain an appropriate message.
A TCL expression to delete a line from a header. The line to be deleted
is identified by a line number. The header must exist for this
expression to execute successfully.
TCL SYNTAX:
hdrDelByLine <header> <lineNumber>
<header> header expression
<lineNumber> Line number of the line to be deleted
RETURNS:
TCL_OK Successful completion
TCL_ERROR Error occurred. Depending on the nature of the error,
the Interp result string will contain an appropriate message.
A TCL expression to replace a header line. The line to be replaced
is passed as an argument, as is the line number where it should be
replaced at. The header must exist for this expression to execute
successfully.
TCL SYNTAX:
hdrReplaceLine <header> <lineNumber> <lineContents>
<header> header expression
<lineNumber> Line number of the line to be deleted
<lineContents> Line to be replaced (Enclose in quotes)
RETURNS:
TCL_OK Successful completion
TCL_ERROR Error occurred. Depending on the nature of the error,
the Interp result string will contain an appropriate message.
A TCL expression to construct a line containing ASCII (alphanumeric) value
suitable for insertion in a header. The line is constructed using
the supplied keyword, value and an optional comment field.
TCL SYNTAX:
hdrMakeLineWithAscii <keyword> <value> [comment]
<keyword> Keyword to be contained in the line
<value> Ascii value in the line
[comment] Comments for the line (optional)
RETURNS:
TCL_OK Successful completion. The Interp result string will contain
the constructed line
TCL_ERROR Error occurred. Depending on the nature of the error,
the Interp result string will contain an appropriate message.
A TCL expression to construct a line containing a double value suitable
for insertion in a header. The line is constructed using the supplied
keyword, value and an optional comment field.
TCL SYNTAX:
hdrMakeLineWithDbl <keyword> <value> [comment]
<keyword> Keyword to be contained in the line
<value> Double value in the line
[comment] Comments for the line (optional)
RETURNS:
TCL_OK Successful completion. The Interp result string will contain
the constructed line
TCL_ERROR Error occurred. Depending on the nature of the error,
the Interp result string will contain an appropriate message.
A TCL expression to construct a line containing an integer value suitable
for insertion in a header. The line is constructed using the supplied
keyword, value and an optional comment field.
TCL SYNTAX:
hdrMakeLineWithInt <keyword> <value> [comment]
<keyword> Keyword to be contained in the line
<value> Integer value in the line
[comment] Comments for the line (optional)
RETURNS:
TCL_OK Successful completion. The Interp result string will contain
the constructed line
TCL_ERROR Error occurred. Depending on the nature of the error,
the Interp result string will contain an appropriate message.
A TCL expression to construct a line containing a logical (0 or 1) value
suitable for insertion in a header. The line is constructed using
the supplied keyword, value and an optional comment field.
TCL SYNTAX:
hdrMakeLineWithLogical <keyword> <value> [comment]
<keyword> Keyword to be contained in the line
<value> Logical value in the line
[comment] Comments for the line (optional)
RETURNS:
TCL_OK Successful completion. The Interp result string will contain
the constructed line
TCL_ERROR Error occurred. Depending on the nature of the error,
the Interp result string will contain an appropriate message.
A TCL expression to copy one header to another.
TCL SYNTAX:
hdrCopy <sourceHeader> <destinationHeader>
<sourceHeader> header to copy from
<destinationHeader> header to copy to
RETURNS:
TCL_OK Successful completion.
TCL_ERROR Error occurred. Depending on the nature of the error,
the Interp result string will contain an appropriate
message.
A TCL expression to print the contents of a header.
TCL SYNTAX:
hdrPrint <handle>
<handle> header to print
RETURNS:
TCL_OK Successful completion.
TCL_ERROR Error occurred. Depending on the nature of the error,
the Interp result string will contain an appropriate
message.