"Fossies" - the Fresh Open Source Software Archive

Member "dx-4.4.4/help/dxall854" (5 Feb 2002, 6206 Bytes) of package /linux/misc/old/dx-4.4.4.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 #!F-adobe-helvetica-medium-r-normal--18*
    2 #!N 
    3 #!N  #!Rgetglo GetGlobal #!N #!N Category #!N #!N  #!Lcatflow,dxall755 h Flow Control  #!EL  #!N #!N 
    4 Function #!N #!N Retrieves an object from the cache. State is 
    5 maintained between executions of any macros containing GetGlobal. #!N #!N Syntax 
    6 #!N #!N  #!F-adobe-times-bold-r-normal--18*   object, link #!EF = GetGlobal(  #!F-adobe-times-bold-r-normal--18*   object, reset 
    7 #!EF ); #!N #!N Inputs #!T,1,91,276,461,646  #!F-adobe-times-medium-r-normal--14*    #!F-adobe-times-bold-r-normal--18*   #!N TAB Name 
    8 TAB Type TAB Default TAB Description #!EF #!N TAB object TAB 
    9 object TAB none TAB object to be output if nothing has 
   10 #!N TAB - TAB - TAB - TAB been set #!N 
   11 TAB reset TAB flag TAB 0 TAB 0: the object cached 
   12 by SetGlobal #!N TAB - TAB - TAB - TAB (if 
   13 there is one) is passed to #!N TAB - TAB - 
   14 TAB - TAB output #!N TAB - TAB - TAB - 
   15 TAB 1: object (not the cached object) #!N TAB - TAB 
   16 - TAB - TAB is passed to output. #!N TAB - 
   17 TAB - TAB - TAB #!EF #!N #!N Outputs #!T,1,161,321,646  #!F-adobe-times-medium-r-normal--14*   
   18  #!F-adobe-times-bold-r-normal--18*   #!N TAB Name TAB Type TAB Description #!EF #!N TAB 
   19 object TAB object TAB retrieved object #!N TAB link TAB string 
   20 TAB link to corresponding SetGlobal module #!N TAB - TAB - 
   21 TAB #!EF #!N #!N Functional Details #!N #!N GetGlobal works with 
   22 SetGlobal to place objects in and retrieve them from the cache. 
   23 GetGlobal is equivalent to (and replaces) Get in previous versions of 
   24 Data Explorer. GetGlobal differs from GetLocal in that GetLocal and SetLocal 
   25 are used when the state maintained by the Get/Set pair should 
   26 be reset when a macro containing these modules is reexecuted. In 
   27 contrast, GetGlobal and SetGlobal will maintain state when the macro is 
   28 reexecuted. Note that for a single execution of a macro (for 
   29 example, throughout the execution of an entire loop), state is of 
   30 course maintained by both GetLocal and GetGlobal. #!N #!I0 #!N #!N 
   31 #!I0 #!N  #!F-adobe-times-bold-r-normal--18*    #!F-adobe-times-bold-r-normal--18*   object #!EF #!EF #!I50 #!N specifies the 
   32 object to be output by GetGlobal if nothing has been placed 
   33 in the cache (e.g., as on the first execution of a 
   34 visual program) or if  #!F-adobe-times-bold-r-normal--18*   reset #!EF = 1. #!N #!I0 
   35 #!N  #!F-adobe-times-bold-r-normal--18*    #!F-adobe-times-bold-r-normal--18*   reset #!EF #!EF #!I50 #!N causes the module 
   36 to output  #!F-adobe-times-bold-r-normal--18*   object #!EF . If this parameter is set 
   37 to 0 (zero), GetGlobal retrieves the last object placed in the 
   38 cache by SetGlobal (if there is one). Otherwise, the module passes 
   39  #!F-adobe-times-bold-r-normal--18*   object #!EF to the output. #!I0 #!N #!N #!N #!N 
   40 The  #!F-adobe-times-bold-r-normal--18*   link #!EF output is to be connected to the 
   41  #!F-adobe-times-bold-r-normal--18*   link #!EF input of the corresponding SetGlobal module. GetGlobal must 
   42 be used with SetGlobal, rather than with SetLocal. SetGlobal must be 
   43 executed on the same machine as GetGlobal (i.e., it cannot be 
   44 distributed to a different machine). #!N #!N #!I0 #!N Notes: #!N 
   45 #!I30 #!N 1. The Reset interactor can be used to provide 
   46  #!F-adobe-times-bold-r-normal--18*   reset #!EF . However, if you are using GetGlobal and 
   47 SetGlobal in a loop, you should not use the Reset interactor 
   48 to provide this parameter, because the Reset interactor will output the 
   49 reset value for one execution, which is an  #!F-adobe-times-medium-i-normal--18*   entire #!EF 
   50 execution of the loop. In general, there are performance advantages to 
   51 using GetLocal, rather than GetGlobal with the First module supplying the 
   52  #!F-adobe-times-bold-r-normal--18*   reset #!EF parameter. While the result will be the same, 
   53 using GetLocal will ensure that all previous results of the macro 
   54 will be cached and ready for reuse. If you use GetGlobal, 
   55 only the last result of the macro is cached. #!N #!I30 
   56 #!N 2. Whenever there is a GetGlobal inside a macro, all 
   57 outputs of the macro will be stored in the cache with 
   58 the cache attribute "cache last." In other words, whenever any input 
   59 to the macro changes, the old results of the macro will 
   60 be deleted from the cache and the new results will be 
   61 stored in the cache. There is no way for the user 
   62 to turn off caching for this macro. The results are also 
   63 locked in the cache, and cannot be flushed. This is because 
   64 GetGlobal maintains state for the macro that may not be reproduced 
   65 given the inputs to the macro. Inconsistent behavior might result if 
   66 results were not cached in this way. #!N #!I30 #!N 3. 
   67 Previously created visual programs which use Get and Set will be 
   68 run using GetGlobal and SetGlobal. You can explicitly change your Gets 
   69 and Sets to either GetGlobals and SetGlobals or GetLocals and SetLocals 
   70 using the Edit menu (see  #!Lscope,dxall444 s Assign Get/Set Scope  #!EL  in IBM Visualization Data Explorer 
   71 User's Guide). There are performance advantages to using GetLocal and SetLocal 
   72 whenever you do not need to maintain state between executions of 
   73 your macro which uses Gets and Sets. A rule of thumb 
   74 is that if you are using the First module to supply 
   75 the reset parameter of Get, you should use GetLocal instead of 
   76 GetGlobal (and the use of First is then unnecessary). #!I0 #!N 
   77 #!N A detailed description of the behavior and use of the 
   78 GetLocal, GetGlobal, SetLocal, and SetGlobal modules can be found in  #!Lstates,dxall269 h Preserving Explicit State  #!EL  
   79 in IBM Visualization Data Explorer User's Guide. #!N #!N Example Visual 
   80 Programs #!N #!N #!CForestGreen #!N  #!F-adobe-courier-bold-r-normal--18*   #!N SIMPLE/GetSet.net #!EF #!N #!N 
   81 #!EC #!N #!N See Also #!N #!N  #!Lodone,dxall828 h Done  #!EL  ,  #!Lofirst,dxall850 h First  #!EL  , 
   82  #!Lsetglo,dxall940 h SetGlobal  #!EL  ,  #!Lgetloc,dxall855 h GetLocal  #!EL  ,  #!Lsetloc,dxall941 h SetLocal  #!EL  ,  #!Lreset,dxall926 h Reset  #!EL  #!N #!N  #!Lxmod,dxall263 h Data Explorer Execution Model  #!EL  in 
   83 IBM Visualization Data Explorer User's Guide. #!N #!N #!N  #!F-adobe-times-medium-i-normal--18*   Next 
   84 Topic #!EF #!N #!N  #!Lgetloc,dxall855 h GetLocal  #!EL  #!N  #!F-adobe-times-medium-i-normal--18*   #!N