Content-type: text/html Man page of Tracing TCL variables

Tracing TCL variables

Section: NSCL Data Analysis packages (3)
Updated: 0.1
Index Return to Main Contents
 

NAME

CTCLTracedVariable - A TCL/Tk variable with traces attached.  

SYNOPSIS


#include <TCLTracedVariable.h>

class CTCLTracedVariable : public CTCLVariable
{
  CTCLTracedVariable(CTCLInterpreter*           pInterp,
                  STD(string)                Name,
                  CVariableTraceCallback&    Trace,
                  int                        flags = (TCL_TRACE_READS  |
                                                      TCL_TRACE_WRITES | 
                                                      TCL_TRACE_UNSETS));
  virtual ~CTCLTracedVariable();
  CVariableTraceCallback& getCallback() 
};

#endif

 

DESCRIPTION

This class is derived from CTCLVariable. CTCLVariable encapsulates TCL/Tk variables. This class adds to that encapsulation a seperable callback object. The callback object is derived from the abstract base class CVariableTraceCallback.  

PUBLIC INTERFACE

CTCLTracedVariable(CTCLInterpreter* pInterp, string Name,CVariableTraceCallback& Trace, int flags =(TCL_TRACE_READS | TCL_TRACE_WRITES | TCL_TRACE_UNSETS))

Creates a traced variable. pInterp is the interpreter in which the variable is or will be defined. It is possible to establish traces on variables that don't yet exist. Name is the name of the variable. If the variable names an array, the trace will apply to all elements of the array. If the trace is an array element it should be specified in TCL array element selection notation (e.g. testing(anelement)). Trace is an object that will be dispatched to when the trace fires. flags is a bitwise or of flags indicating which operations on a variable trigger a trace callback. TCL_TRACE_READS fires a trace whenever the value of a variable is computed. TCL_TRACE_WRITES fires a tracek whenever a variable is modified. TCL_TRACE_UNSETS fires a trace whenever the variable goes out of existence. Note that this includes destruction of Name due to the destruction of the interpreter.

~CTCLTracedVariable()

   Destroys an existing traced variable.
CVariableTraceCallback& getCallback()
Returns a reference to the callback object. The callback object is the same as the one registered at object creation time.
 

EXAMPLES

<none yet>  

SEE ALSO

CVariableTraceCallback(3), CLanguageTraceCallback(3), TracingIntro(3)
 

Index

NAME
SYNOPSIS
DESCRIPTION
PUBLIC INTERFACE
EXAMPLES
SEE ALSO
This document was created by man2html, using the manual pages.
Time: 14:18:39 GMT, February 25, 2005