applications/utilities/postProcessing/dataConversion/foamToTecplot360/tecio/tecsrc/AUXDATA.h

   1 /*
   2  * NOTICE and LICENSE for Tecplot Input/Output Library (TecIO) - OpenFOAM
   3  *
   4  * Copyright (C) 1988-2009 Tecplot, Inc.  All rights reserved worldwide.
   5  *
   6  * Tecplot hereby grants OpenCFD limited authority to distribute without
   7  * alteration the source code to the Tecplot Input/Output library, known
   8  * as TecIO, as part of its distribution of OpenFOAM and the
   9  * OpenFOAM_to_Tecplot converter.  Users of this converter are also hereby
  10  * granted access to the TecIO source code, and may redistribute it for the
  11  * purpose of maintaining the converter.  However, no authority is granted
  12  * to alter the TecIO source code in any form or manner.
  13  *
  14  * This limited grant of distribution does not supersede Tecplot, Inc.'s
  15  * copyright in TecIO.  Contact Tecplot, Inc. for further information.
  16  *
  17  * Tecplot, Inc.
  18  * 3535 Factoria Blvd, Ste. 550
  19  * Bellevue, WA 98006, USA
  20  * Phone: +1 425 653 1200
  21  * http://www.tecplot.com/
  22  *
  23  */
  24 /*
  25  *****************************************************************
  26  *****************************************************************
  27  *******                                                  ********
  28  ****** Copyright (C) 1988-2008 Tecplot, Inc.              *******
  29  *******                                                  ********
  30  *****************************************************************
  31  *****************************************************************
  32  */
  33 #if !defined AUXDATA_h
  34 #define AUXDATA_h
  35
  36 #if defined EXTERN
  37 #  undef EXTERN
  38 #endif
  39 #if defined AUXDATAMODULE
  40 #  define EXTERN
  41 #else
  42 #  define EXTERN extern
  43 #endif
  44
  45 /**
  46  */
  47 EXTERN Boolean_t AuxDataIsValidNameChar(char      Char,
  48                                         Boolean_t IsLeadChar);
  49 /**
  50  */
  51 EXTERN Boolean_t AuxDataIsValidName(const char *Name);
  52
  53 /**
  54  */
  55 EXTERN AuxData_pa AuxDataAlloc(void);
  56
  57 /**
  58  */
  59 EXTERN void AuxDataDealloc(AuxData_pa *AuxData);
  60
  61 /**
  62  */
  63 EXTERN Boolean_t AuxDataItemDestructor(void       *ItemRef,
  64                                        ArbParam_t  ClientData);
  65 /**
  66  */
  67 EXTERN AuxData_pa AuxDataCopy(AuxData_pa AuxData,
  68                               Boolean_t  ConsiderRetain);
  69
  70 /**
  71  */
  72 EXTERN LgIndex_t AuxDataGetNumItems(AuxData_pa AuxData);
  73
  74 /**
  75  */
  76 EXTERN Boolean_t AuxDataGetItemIndex(AuxData_pa AuxData,
  77                                      const char *Name,
  78                                      LgIndex_t  *ItemIndex);
  79 /**
  80  */
  81 EXTERN void AuxDataGetItemByIndex(AuxData_pa    AuxData,
  82                                   LgIndex_t     Index,
  83                                   const char    **Name,
  84                                   ArbParam_t    *Value,
  85                                   AuxDataType_e *Type,
  86                                   Boolean_t     *Retain);
  87
  88 /**
  89  */
  90 EXTERN Boolean_t AuxDataGetItemByName(AuxData_pa    AuxData,
  91                                       const char    *Name,
  92                                       ArbParam_t    *Value,
  93                                       AuxDataType_e *Type,
  94                                       Boolean_t     *Retain);
  95
  96 /**
  97  */
  98 EXTERN Boolean_t AuxDataGetBooleanItemByName(AuxData_pa     AuxData,
  99                                              const char    *Name,
 100                                              Boolean_t     *Value,
 101                                              AuxDataType_e *Type,
 102                                              Boolean_t     *Retain);
 103
 104 /**
 105  */
 106 EXTERN Boolean_t AuxDataSetItem(AuxData_pa    AuxData,
 107                                 const char    *Name,
 108                                 ArbParam_t    Value,
 109                                 AuxDataType_e Type,
 110                                 Boolean_t     Retain);
 111
 112 /**
 113  */
 114 EXTERN Boolean_t AuxDataDeleteItemByName(AuxData_pa AuxData,
 115                                          const char *Name);
 116
 117 /**
 118  */
 119 EXTERN Boolean_t AuxDataAppendItems(AuxData_pa TargetAuxData,
 120                                     AuxData_pa SourceAuxData);
 121 /**
 122  */
 123 EXTERN void AuxDataDeleteItemByIndex(AuxData_pa AuxData,
 124                                      LgIndex_t  Index);
 125
 126 #if defined TECPLOTKERNEL
 127 /* CORE SOURCE CODE REMOVED */
 128 #endif /* TECPLOTKERNEL */
 129
 130 #endif /* !defined AUXDATA_h */