Pointwise Plugin SDK
Macros | Typedefs

The common data types used by all plugin APIs. More...

+ Collaboration diagram for Cross-Platform Base Types:

Macros

#define PWP_CAST_BOOL(v)   ((v) ? PWP_TRUE : PWP_FALSE)
 Cast a value to a PWP_BOOL value (PWP_TRUE or PWP_FALSE) More...
 
#define PWP_FALSE   (0)
 PWP_BOOL logical "false" value. More...
 
#define PWP_INT16_FORMAT   "hd"
 PWP_INT16 printf format flags. More...
 
#define PWP_INT32_FORMAT   "d"
 PWP_INT32 printf format flags. More...
 
#define PWP_INT64_FORMAT   "lld"
 PWP_INT64 printf format flags. More...
 
#define PWP_INT8_FORMAT   "d"
 PWP_INT8 printf format flags. More...
 
#define PWP_INT_FORMAT   PWP_INT32_FORMAT
 PWP_INT printf format flags. More...
 
#define PWP_TRUE   (!PWP_FALSE)
 PWP_BOOL logical "true" value. More...
 
#define PWP_UINT16_FORMAT   "hu"
 PWP_UINT16 printf format flags. More...
 
#define PWP_UINT16_MAX   ((PWP_UINT16)(~0))
 maximum valid PWP_UINT16 value More...
 
#define PWP_UINT16_UNDEF   PWP_UINT16_MAX
 "undefined" PWP_UINT16 value More...
 
#define PWP_UINT32_FORMAT   "u"
 PWP_UINT32 printf format flags. More...
 
#define PWP_UINT32_MAX   ((PWP_UINT32)(~0))
 maximum valid PWP_UINT32 value More...
 
#define PWP_UINT32_UNDEF   PWP_UINT32_MAX
 "undefined" PWP_UINT32 value More...
 
#define PWP_UINT64_FORMAT   "llu"
 PWP_UINT64 printf format flags. More...
 
#define PWP_UINT64_MAX   ((PWP_UINT64)(~0))
 maximum valid PWP_UINT64 value More...
 
#define PWP_UINT64_UNDEF   PWP_UINT64_MAX
 "undefined" PWP_UINT64 value More...
 
#define PWP_UINT8_FORMAT   "u"
 PWP_UINT8 printf format flags. More...
 
#define PWP_UINT8_MAX   ((PWP_UINT8)(~0))
 maximum valid PWP_UINT8 value More...
 
#define PWP_UINT8_UNDEF   PWP_UINT8_MAX
 "undefined" PWP_UINT8 value More...
 
#define PWP_UINT_FORMAT   PWP_UINT32_FORMAT
 PWP_UINT printf format flags. More...
 
#define PWP_UINT_MAX   ((PWP_UINT)(~0))
 maximum valid PWP_UINT value More...
 
#define PWP_UINT_UNDEF   PWP_UINT_MAX
 "undefined" PWP_UINT value More...
 

Typedefs

typedef int PWP_BOOL
 logical value More...
 
typedef float PWP_FLOAT
 32-bit real More...
 
typedef PWP_INT32 PWP_INT
 integer same size as void* More...
 
typedef short PWP_INT16
 16-bit integer More...
 
typedef int PWP_INT32
 32-bit integer More...
 
typedef long long PWP_INT64
 64-bit integer More...
 
typedef signed char PWP_INT8
 8-bit integer More...
 
typedef double PWP_REAL
 64-bit real More...
 
typedef PWP_UINT32 PWP_UINT
 unsigned integer same size as void* More...
 
typedef unsigned short PWP_UINT16
 16-bit unsigned integer More...
 
typedef unsigned int PWP_UINT32
 32-bit unsigned integer More...
 
typedef unsigned long long PWP_UINT64
 64-bit unsigned integer More...
 
typedef unsigned char PWP_UINT8
 8-bit unsigned integer More...
 
typedef void PWP_VOID
 no value More...
 

Detailed Description

The common data types used by all plugin APIs.

Cross-platform "C" data types. Cross-platform data issues can be minimized by using the following data types internally for plugins. All API calls use these types.

Each integer type has a corresponding PWP_XXX_FORMAT macro that is suitable for composing a compile-time printf format string:

Sample usage:
PWP_UINT32 ndx32 = 32;
printf("ndx32=(%-5" PWP_UINT32_FORMAT ")\n", ndx32);
PWP_INT64 ndx64 = -64;
printf("ndx64=(%5" PWP_INT64_FORMAT ")\n", ndx64);
// output:
// ndx32=(32 )
// ndx64=( -64)

Macro Definition Documentation

◆ PWP_CAST_BOOL

#define PWP_CAST_BOOL (   v)    ((v) ? PWP_TRUE : PWP_FALSE)

Cast a value to a PWP_BOOL value (PWP_TRUE or PWP_FALSE)

Definition at line 314 of file apiPWP.h.

Referenced by PwAsmSetCondition(), PwBlkSetCondition(), PwConSetCondition(), PwDomSetCondition(), and PwuGetValue().

◆ PWP_FALSE

#define PWP_FALSE   (0)

PWP_BOOL logical "false" value.

Definition at line 308 of file apiPWP.h.

Referenced by caeuExportBndryConditionsOnly(), caeuExportStructuredAsUnstructured(), caeuProgressBeginStep(), caeuProgressEndStep(), caeuProgressIncr(), caeuProgressInit(), caeuPublishValueDefinition(), grdpProgressBeginStep(), grdpProgressEndStep(), grdpProgressIncr(), grdpProgressInit(), grdpPublishValueDefinition(), PwAsmFinalize(), PwAsmPushElementFace(), PwAsmSetCellSpanConditionKey(), PwAsmSetProperty(), PwBlkCondition(), PwBlkNdxBoundary(), PwBlkNdxBoundaryAndCondition(), PwBlkNdxConnection(), PwBlkNdxVertData(), PwBlkSetExportName(), PwBlkSetName(), PwBlkSetProperty(), PwBlkSize(), PwBlock(), PwBndryCondition(), PwBoundary(), PwCaeElementType(), PwCaeGridWrite(), PwConnection(), PwConSetName(), PwConSetProperty(), PwDomCondition(), PwDomSetName(), PwDomSetProperty(), PwElemDataMod(), PwElemDataModEnum(), PwGridRead(), PwModCustomIndex3SchemeReady(), PwModCustomIndexSchemeReady(), PwModGetAttributeValue(), PwModNdxBoundary(), PwModNdxBoundaryAndCondition(), PwModNdxConnection(), PwModStreamFaces(), PwpActivateAPI(), PwpGetValue(), PwpIsLicensed(), PwuAssignValue(), PwUnsBlkAllocateElements(), PwUnsBlkSetElement(), PwUnsDomAllocateElements(), PwUnsDomSetElement(), PwuProgressBegin(), PwuProgressNextStep(), PwuProgressQuit(), PwuProgressStatus(), PwuPublishValueDefinition(), PwuUnfFileBegin(), PwuUnfFileEnd(), PwuUnfRecBegin(), PwuUnfRecBeginFixed(), PwuUnfRecEnd(), PwuUnfRecWriteArr(), PwuValueSetter(), PwVertDataMod(), PwVertIndexMod(), PwVertXyzVal(), PwVlstIsStructured(), PwVlstIsUnstructured(), PwVlstReadFile(), PwVlstSetXYZ(), PwVlstSetXYZ2(), PwVlstSetXYZ2Data(), PwVlstSetXYZ3(), PwVlstSetXYZ3Data(), PwVlstSetXYZData(), PwVlstSetXYZVal(), PwVlstSetXYZVal2(), PwVlstSetXYZVal3(), PwXform2to3(), PwXform3to2(), PwXformFollows(), CaePlugin< MT >::run(), runtimeWrite(), unfHdrLenWrite(), and unfUDataInit().

◆ PWP_INT16_FORMAT

#define PWP_INT16_FORMAT   "hd"

PWP_INT16 printf format flags.

Definition at line 201 of file apiPWP.h.

◆ PWP_INT32_FORMAT

#define PWP_INT32_FORMAT   "d"

PWP_INT32 printf format flags.

Definition at line 221 of file apiPWP.h.

◆ PWP_INT64_FORMAT

#define PWP_INT64_FORMAT   "lld"

PWP_INT64 printf format flags.

Definition at line 248 of file apiPWP.h.

Referenced by PwpAsciiWriter::write().

◆ PWP_INT8_FORMAT

#define PWP_INT8_FORMAT   "d"

PWP_INT8 printf format flags.

Definition at line 181 of file apiPWP.h.

◆ PWP_INT_FORMAT

#define PWP_INT_FORMAT   PWP_INT32_FORMAT

PWP_INT printf format flags.

Definition at line 290 of file apiPWP.h.

◆ PWP_TRUE

#define PWP_TRUE   (!PWP_FALSE)

◆ PWP_UINT16_FORMAT

#define PWP_UINT16_FORMAT   "hu"

PWP_UINT16 printf format flags.

Definition at line 204 of file apiPWP.h.

◆ PWP_UINT16_MAX

#define PWP_UINT16_MAX   ((PWP_UINT16)(~0))

maximum valid PWP_UINT16 value

Definition at line 195 of file apiPWP.h.

◆ PWP_UINT16_UNDEF

#define PWP_UINT16_UNDEF   PWP_UINT16_MAX

"undefined" PWP_UINT16 value

Definition at line 198 of file apiPWP.h.

◆ PWP_UINT32_FORMAT

#define PWP_UINT32_FORMAT   "u"

PWP_UINT32 printf format flags.

Definition at line 224 of file apiPWP.h.

◆ PWP_UINT32_MAX

#define PWP_UINT32_MAX   ((PWP_UINT32)(~0))

maximum valid PWP_UINT32 value

Definition at line 215 of file apiPWP.h.

Referenced by PwpFile::readDouble(), and PwpFile::readInt().

◆ PWP_UINT32_UNDEF

#define PWP_UINT32_UNDEF   PWP_UINT32_MAX

"undefined" PWP_UINT32 value

Definition at line 218 of file apiPWP.h.

◆ PWP_UINT64_FORMAT

#define PWP_UINT64_FORMAT   "llu"

PWP_UINT64 printf format flags.

Definition at line 251 of file apiPWP.h.

Referenced by PwpAsciiWriter::write().

◆ PWP_UINT64_MAX

#define PWP_UINT64_MAX   ((PWP_UINT64)(~0))

maximum valid PWP_UINT64 value

Definition at line 255 of file apiPWP.h.

◆ PWP_UINT64_UNDEF

#define PWP_UINT64_UNDEF   PWP_UINT64_MAX

"undefined" PWP_UINT64 value

Definition at line 258 of file apiPWP.h.

◆ PWP_UINT8_FORMAT

#define PWP_UINT8_FORMAT   "u"

PWP_UINT8 printf format flags.

Definition at line 184 of file apiPWP.h.

◆ PWP_UINT8_MAX

#define PWP_UINT8_MAX   ((PWP_UINT8)(~0))

maximum valid PWP_UINT8 value

Definition at line 175 of file apiPWP.h.

◆ PWP_UINT8_UNDEF

#define PWP_UINT8_UNDEF   PWP_UINT8_MAX

"undefined" PWP_UINT8 value

Definition at line 178 of file apiPWP.h.

◆ PWP_UINT_FORMAT

#define PWP_UINT_FORMAT   PWP_UINT32_FORMAT

PWP_UINT printf format flags.

Definition at line 293 of file apiPWP.h.

◆ PWP_UINT_MAX

#define PWP_UINT_MAX   ((PWP_UINT)(~0))

maximum valid PWP_UINT value

Definition at line 297 of file apiPWP.h.

◆ PWP_UINT_UNDEF

#define PWP_UINT_UNDEF   PWP_UINT_MAX

"undefined" PWP_UINT value

Definition at line 300 of file apiPWP.h.

Typedef Documentation

◆ PWP_BOOL

typedef int PWP_BOOL

logical value

Definition at line 305 of file apiPWP.h.

◆ PWP_FLOAT

typedef float PWP_FLOAT

32-bit real

Definition at line 263 of file apiPWP.h.

◆ PWP_INT

typedef PWP_INT32 PWP_INT

integer same size as void*

Definition at line 284 of file apiPWP.h.

◆ PWP_INT16

typedef short PWP_INT16

16-bit integer

Definition at line 189 of file apiPWP.h.

◆ PWP_INT32

typedef int PWP_INT32

32-bit integer

Definition at line 209 of file apiPWP.h.

◆ PWP_INT64

typedef long long PWP_INT64

64-bit integer

Definition at line 242 of file apiPWP.h.

◆ PWP_INT8

typedef signed char PWP_INT8

8-bit integer

Definition at line 169 of file apiPWP.h.

◆ PWP_REAL

typedef double PWP_REAL

64-bit real

Definition at line 266 of file apiPWP.h.

◆ PWP_UINT

unsigned integer same size as void*

Definition at line 287 of file apiPWP.h.

◆ PWP_UINT16

typedef unsigned short PWP_UINT16

16-bit unsigned integer

Definition at line 192 of file apiPWP.h.

◆ PWP_UINT32

typedef unsigned int PWP_UINT32

32-bit unsigned integer

Definition at line 212 of file apiPWP.h.

◆ PWP_UINT64

typedef unsigned long long PWP_UINT64

64-bit unsigned integer

Definition at line 245 of file apiPWP.h.

◆ PWP_UINT8

typedef unsigned char PWP_UINT8

8-bit unsigned integer

Definition at line 172 of file apiPWP.h.

◆ PWP_VOID

typedef void PWP_VOID

no value

Definition at line 319 of file apiPWP.h.