DTCL Tcl Commands

ArgDelete
Delete an argument structure

ArgGet
Get an item from an SDS structure

ArgGetType
Get the type of an Arg style SDS structure

ArgNew
Create a new argument structure

ArgPutString
Put a character string item into an SDS structure

ArgPutc
Put a character item into an SDS structure

ArgPutd
Put a double floating point item into an SDS structure

ArgPutf
Put a floating point item into an SDS structure

ArgPuti
Put an integer item into an SDS structure

ArgPuts
Put a short integer item into an SDS structure

ArgPutu
Put an unsigned integer item into an SDS structure

ArgPutus
Put an unsigned short integer item into an SDS structure

Bell
Ring the terminal bell.

DisconnectHandler
Specify a handler for task Disconnect messages.

DitsActionWait
Blocks the current action and waits for a message to be received.

DitsArgument
Fetch the argument of the Dits message which caused this entry

DitsConnectHandler
Specify a handler for task Connect messages.

DitsDeleteTask
Delete the specified task.

DitsErrorText
Fetch the message string assocaited with a status code.

DitsGetActIndex
Return the index of the current action

DitsGetContext
Returns the Dits context

DitsGetEntName
Get the name associated with the current entry of the current action.

DitsGetEntTransId
Get the transaction id associated with the current entry of the current action.

DitsGetParId
Get the parameter system id.

DitsGetPath
Gets a path to a task.

DitsGetSeq
Returns the sequence count of the current action.

DitsGetTaskDescr
Return the description of the specified task.

DitsGetTaskName
Fetch the Dits name of the task running the interpeter

DitsGetTaskType
Return the type of the specified task.

DitsKill
Kill an action in the current task.

DitsLoad
Loads and runs a task.

DitsLogMsg
Log a message using the DRAMA logging facility.

DitsLogSysEnabled
Indicate if a DRAMA logging system might be active.

DitsLosePath
Lose the path to the specified tasks.

DitsMessage
Send a DRAMA obey/kick/get/set/control/monitor message.

DitsMsgOut
Output a message to the user.

DitsPutActStatus
Allows an TCL action code to set the DRAMA status.

DitsPutAction
Add a new action to this task.

DitsPutArgument
Allows an TCL action code to set the DRAMA completion argument

DitsPutKickHandler
Sets a new handler routine for the next kick

DitsPutObeyHandler
Sets a new handler routine for the next reschedule.

DitsPutRequest
Request to the fixed part for when the Action returns.

DitsReason
Return the reason for a Dits Entry

DitsRegistrationHandler
Specify a handler for task Registration messages.

DitsRequestNotify
Requests notification when a Task's buffer empties

DitsScanTasks
Scans the known tasks and returns details on them.

DitsSetDebug
Set the Dits debug flag.

DitsSetDetails
Set the task details.

DitsSetFixFlags
Set the DITS flags used for communicating with the DRAMA fixed part.

DitsSignal
Signal an action in the current task to reenter.

DitsStatus
Returns the status of the Dits message which causes this entry.

DitsStatusText
Returns the status of the Dits message which causes this entry.

DitsTask
Fetch the name of the Dits task which sent this message.

DitsTaskIsLocal
Returns 1 if the specified task is local, 0 otherwise.

DitsTaskNode
Return the node that a given task is on.

DramaLoad
Load a program using the Drama system.

DtclError
Command invoked to process background errors.

DtclFindFile
Find a file using search paths, defaultings and wildcards.

DtclParseFile
Parse a file name using defaults and search paths.

DtclTkDialog
Creates a dialog box containing a bitmap, message and one or more buttons

DtclTkDialogButOpts
Get/Set the options for the predefined button types used by DtclTkDialog

DtclTkDialogCentre
Set the initial position of a dialog to the centre of the current screen.

DtclTkDialogPosUnderMouse
Set the initial position of a dialog to be under the mouse

DtclTkDialogPosition
Set the initial position of a dialog.

DtclTkHelpDialog
Creates a dialog box to display a simple help message.

DtclTkScreenInfo
Returns information about screens in a multi-desktop configuration.

ErrorHandler
Specify an error handler for Ers error messages

ErsAnnul
Annul any error messages reported with Ers.

ErsFlush
Flush any error messages reported with Ers.

ErsRep
Report error messages.

ImpProbe
Probe the Imp message layer of dits.

IsUnix
Indicate if we are running on a Unix machine

IsVms
Indicate if we are running on a VMS machine

IsVxworks
Indicate if we are running on a VxWorks machine

MessageHandler
Specify a handler for MsgOut messages

NotifyRequest
Requests notification when a Task's buffer empties

PutFacility
A a new message code facility table to this program.

SdpCreate
Create a parameter in the current task.

SdpGet
Get an item from the task's parameter system.

SdpGetSds
Get an Sds reference to an item from the task's parameter system.

SdpPut
Put an item into the task's parameter system.

SdpUpdate
Notify the parameter system that an item has been updated via its id.

SdsArrayCell
Return the contents of one cell of an Sds array.

SdsArrayGet
Return the contents of a 1 dimensional array

SdsCell
Find a component of a structured array.

SdsCopy
Make a copy of an SDS object

SdsDelete
Delete an SDS structure

SdsEvalAndCheck
Evaluate a Tcl command checking for SDS leaks.

SdsExtract
Extract an object from a structure.

SdsFillArray
Fill out the contents of a structured array

SdsFind
Find an SDS structure component by name

SdsFindByPath
Find an Sds item by path name.

SdsFreeId
Free an identifier so that its associated memory may be reused

SdsFreeIdCheck
Free an identifier so that its associated memory may be reused. Check id.

SdsGet
Get data from an Sds item.

SdsGetExtra
Get an Sds structure's Extra infomation field contents.

SdsIndex
Find an SDS structure component by position

SdsInfo
Return information about an SDS object.

SdsInsert
Insert an existing SDS object into a structure

SdsInsertCell
Insert object into a structure array

SdsList
List contents of an SDS object

SdsNew
Create a new Sds structure

SdsPhotoImages
A new Photo image format to support Tcl images read from Sds structures.

SdsPut
Put data into an Sds item.

SdsPutExtra
Put an Sds structure's Extra infomation field contents.

SdsRead
Read an SDS object from a file

SdsReadFree
Free Buffer allocated by SdsRead

SdsRename
Rename an SDS object.

SdsResize
Change the dimensions of an array.

SdsWrite
Write an SDS object to a file

TaskRunning
Checks if a task is running.

Translate
Perform one of a number of possible translations.

TranslateName
Translate a logical name/environment variable.

after
Reimplementation of the alarm command under drama.

args
Create argument structure containing a number of strings

control
Send a Control message to a Drama task

kick
Send a kick message to an action in a Drama task

monitor
Send a monitor message to a Drama task

obey
Invoke an action in a Drama task

pget
Get values of one or more parameters from a Drama task

pset
Set a parameter in a task


Click here for the DRAMA home page and here for the AAO home page.

 For more information, contact tjf@aaoepp.aao.gov.au