Data Loading


Functions

Boolean_t TecUtilDataSetReadX (ArgList_pa ArgList)
  Read one or more data files into Tecplot to form a new data set in the current frame.
void TecUtilDataLoadBegin (void)
  Notifies Tecplot that a major data load operation is about to begin.
void TecUtilDataLoadEnd (void)
  Notifies Tecplot that a major data load operation has completed.

Function Documentation

void TecUtilDataLoadBegin ( void   ) 

Notifies Tecplot that a major data load operation is about to begin.

Please see TecUtilDataLoadEnd() for more details.

TecUtilDataLoadBegin() and TecUtilDataLoadEnd() are used together with add-ons that perform a moving window of calculations through data. This is particularly important for add-ons processing transient data.

Since:
11.0-0-430
See also:
TecUtilDataLoadEnd, TecUtilDataValueAutoLOD, TecUtilDataValueCustomLOD
Python Syntax:
  Results = TecUtil.DataLoadBegin()

  Output:
    Results[0]    ReturnVal            NONE

void TecUtilDataLoadEnd ( void   ) 

Notifies Tecplot that a major data load operation has completed.

At the beginning or end of each major data load operation Tecplot examines its current memory use and decides if it needs to unload any data.

After this call all data references (i.e. field data, node maps, face neighbors, etc.) previously acquired by the add-on are invalid and should be re-acquired before using them again.

TecUtilDataLoadBegin() and TecUtilDataLoadEnd() are used together with add-ons that perform a moving window of calculations through data. This is particularly important for add-ons processing transient data.

Since:
11.0-0-430
See also:
TecUtilDataLoadBegin, TecUtilDataValueAutoLOD, TecUtilDataValueCustomLOD
Python Syntax:
  Results = TecUtil.DataLoadEnd()

  Output:
    Results[0]    ReturnVal            NONE

Boolean_t TecUtilDataSetReadX ( ArgList_pa  ArgList  ) 

Read one or more data files into Tecplot to form a new data set in the current frame.

Parameters:
ArgList Set of Arglist entries. This is built using calls to TecUtilArgListAppendXXXX functions.

Arglist Values

SV_READDATAOPTION
Type: ReadDataOption_e
Arg Function: TecUtilArgListAppendInt()
Default: ReadDataOption_NewData
Required: No
Notes: Determine how to handle the situation where a data set already exists in the current frame. The possible values are: ReadDataOption_NewData, ReadDataOption_AppendData and ReadDataOption_ReplaceData.

SV_RESETSTYLE
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Default: TRUE
Required: No
Notes: TRUE if you want to reset the style of the current frame, FALSE if you want to keep the same style.

SV_FILENAMESORINSTRUCTIONS
Type: StringList_pa
Arg Function: TecUtilArgListAppendStringList()
Required: Yes
Notes: A string list containing the file names to load or the instructions to send to the data set reader (converter or loader).

SV_DATASETREADER
Type: char *
Arg Function: TecUtilArgListAppendInt()
Default: "TECPLOT"
Required: No
Notes: Name of the data set reader (converter or loader). To let Tecplot load the data, use NULL.

SV_INITIALPLOTFIRSTZONEONLY
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Default: FALSE
Required: No
Notes: Informs Tecplot that after the data is loaded it only needs to activate the first enabled zone for the initial plot. This option is particularly usefull if you have many zones and want to get the data into Tecplot and the first zone drawn as fast as possible. The inactive zones can always be activated when needed.

SV_INITIALPLOTTYPE
Type: PlotType_e
Arg Function: TecUtilArgListAppendInt()
Default: PlotType_Automatic
Required: No
Notes: Initial frame plot type for the data. Only used if SV_RESETSTYLE is TRUE. To have Tecplot determine the most appropriate frame plot type for the data, use PlotType_Automatic (the default).

SV_INCLUDETEXT
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Default: TRUE
Required: No
Notes: Set to TRUE to load any text, geometries, or custom labels in the data files.

SV_INCLUDEGEOM
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Default: TRUE
Required: No

SV_INCLUDECUSTOMLABL
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Default: TRUE
Required: No

SV_INCLUDEDATA
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Default: TRUE
Required: No
Notes: Set to TRUE to load the data from the data files. Set to FALSE to only load text, geometries and/or customer labels, depending on SV_INCLUDETEXT, SV_INCLUDEGEOM, and SV_INCLUDECUSTOMLABELS

SV_COLLAPSEZONESANDVARS
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Default: FALSE
Required: No
Notes: Set to TRUE to renumber zones and variables if any are disabled. For more information on collapsing zones and variables, see Section 5.1.1.7, "Zone and Variable List Collapsing," in the Tecplot User's Manual.

SV_ASSIGNSTRANDIDS
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Default: FALSE
Required: No
Notes: Set to TRUE to request that Tecplot assign strand ID's to zones that hava a strand ID of -1.

SV_ADDZONESTOEXISTINGSTRANDS
Type: Boolean_t
Arg Function: TecUtilArgListAppendInt()
Default: FALSE
Required: No
Notes: Set to TRUE to request that Tecplot add the zones to matching strands, if they exist. Otherwise, if the new data specifies strands, Tecplot will create new strands beginning after the last strand in the dataset.

SV_ZONELIST
Type: Set_pa
Arg Function: TecUtilArgListAppendSet()
Default: NULL
Required: No
Notes: Set of zones to load from the data files. Use NULL to load all zones.

SV_VARLOADMODE
Type: VarLoadMode_e
Arg Function: TecUtilArgListAppendInt()
Default: VarLoadMode_ByPosition
Required: No
Notes: Choose to load variables by name or by their position in the data file.

SV_VARPOSITIONLIST
Type: Set_pa
Arg Function: TecUtilArgListAppendSet()
Default: NULL
Required: No
Notes: Set of variables to load from the data files. Use NULL to load all variables. Must be NULL if SV_VARLOADMODE is VarLoadMode_ByName.

SV_VARNAMELIST
Type: StringList_pa
Arg Function: TecUtilArgListAppendStringList()
Default: NULL
Required: No
Notes: Set of variable names to laod from the data files.

SV_ISKIP
Type: LgIndex_t
Arg Function: TecUtilArgListAppendInt()
Default: 1
Required: No
Notes: The default value of 1 loads every data point in the I-, J-, or K-directions. A value of 2 for each loads every other data point and so forth. These values only apply to ordered dat

SV_JSKIP
Type: LgIndex_t
Arg Function: TecUtilArgListAppendInt()
Default: 1
Required: No

SV_KSKIP
Type: LgIndex_t
Arg Function: TecUtilArgListAppendInt()
Default: 1
Required: No


Returns:
TRUE if the input parameters are valid and the data was successfully loaded, FALSE otherwise.
Precondition:
ArgList Argument list must be valid.

Must have one or more frames.

Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilDataSetReadX(ArgListPtr)
    POINTER (ArgListPtr, ArgList)

Python Syntax:

  Results = TecUtil.DataSetReadX(ArgList)

  Input:
                  ArgList              dictionary
  Output:
    Results[0]    ReturnVal            boolean

Read in a the file newdata.plt. Note that some arglist entries are shown here using their default values as an example only as they normally would not have to be provided. 

   StringList_pa Instructions = TecUtilStringListAlloc();
   ArgList_pa ArgList;
   TecUtilLockStart(AddOnID);
   ArgList = TecUtilArgListAlloc();

   TecUtilStringListAppendString(Instructions, "newdata.plt");

   TecUtilArgListAppendInt(ArgList,       SV_READDATAOPTION,  ReadDataOption_NewData);
   TecUtilArgListAppendInt(ArgList,       SV_RESETSTYLE,      TRUE);
   TecUtilArgListAppendStringList(ArgList,SV_FILENAMESORINSTRUCTIONS, Instructions);
   TecUtilArgListAppendInt(ArgList,       SV_INITIALPLOTFIRSTZONEONLY,FALSE);
   TecUtilArgListAppendInt(ArgList,       SV_INITIALPLOTTYPE,PlotType_Automatic);
   TecUtilArgListAppendInt(ArgList,       SV_INCLUDETEXT,      TRUE);
   TecUtilArgListAppendInt(ArgList,       SV_INCLUDEGEOM,     TRUE);
   TecUtilArgListAppendInt(ArgList,       SV_INCLUDECUSTOMLABELS,  TRUE);
   TecUtilArgListAppendInt(ArgList,       SV_INCLUDEDATA,     TRUE);
   TecUtilArgListAppendInt(ArgList,       SV_COLLAPSEZONESANDVARS,    FALSE);
   TecUtilArgListAppendInt(ArgList,       SV_VARLOADMODE,     VarLoadMode_ByPosition);
   TecUtilArgListAppendArray(ArgList,     SV_VARPOSITIONLIST, NULL);
   TecUtilArgListAppendInt(ArgList,       SV_ISKIP, 1);
   TecUtilArgListAppendInt(ArgList,       SV_JSKIP, 1);
   TecUtilArgListAppendInt(ArgList,       SV_KSKIP, 1);

   TecUtilDataSetReadX(ArgList);

   TecUtilStringListDealloc(&Instructions);
   TecUtilArgListDealloc(&ArgList);
   TecUtilLockFinish(AddOnID);

Generated on Tue Mar 12 02:24:40 2013 for Tecplot by  doxygen 1.5.5