psLookupTable.h File Reference

---

Detailed Description

This file defines the structure and functions for table lookups.

Author:

Ross Harman, MHPCC

Version:

Revision

1.4

Name

rel5_0

Date:

Date

2005/02/17 21:54:09

Copyright 2004 Maui High Performance Computing Center, University of Hawaii

Definition in file psLookupTable.h.

#include "psType.h"
#include "psVector.h"
#include "psArray.h"

Include dependency graph for psLookupTable.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	psLookupTable
	Lookup table structure. More...
Enumerations
enum	psLookupStatusType { PS_LOOKUP_SUCCESS = 0x0000, PS_LOOKUP_PAST_TOP = 0x0101, PS_LOOKUP_PAST_BOTTOM = 0x0102, PS_LOOKUP_ERROR = 0x0104 }
	Lookup table lookup status and error conditions. More...
enum	psParseErrorType { PS_PARSE_SUCCESS = 0x0000, PS_PARSE_ERROR_TYPE = 0x0101, PS_PARSE_ERROR_VALUE = 0x0102, PS_PARSE_ERROR_GENERAL = 0x0104 }
	Lookup table parse status and error conditions. More...
Functions
psLookupTable *	psLookupTableAlloc (const char *fileName, psF64 validFrom, psF64 validTo)
	Allocator for psLookupTable struct.
psLookupTable *	psLookupTableRead (psLookupTable *table)
	Read lookup table.
psF64	psLookupTableInterpolate (psLookupTable *table, psF64 index, psU64 column, psLookupStatusType *status)
	Lookup and interpolate value from table.
psVector *	psLookupTableInterpolateAll (psLookupTable *table, psF64 index, psVector *stats)
	Lookup and interpolate all values from table.

---

Enumeration Type Documentation

enum psLookupStatusType

Lookup table lookup status and error conditions. Success, failure, and status conditions for table lookups. Enumeration values: PS_LOOKUP_SUCCESS  Table lookup succeeded. PS_LOOKUP_PAST_TOP  Lookup off top of table. PS_LOOKUP_PAST_BOTTOM  Lookup off bottom of table. PS_LOOKUP_ERROR  Any other type of lookup error. Definition at line 45 of file psLookupTable.h.

enum psParseErrorType

Lookup table parse status and error conditions. Success, failure, and status conditions for table parsing. Enumeration values: PS_PARSE_SUCCESS  Table lookup succeeded. PS_PARSE_ERROR_TYPE  Error parsing type. PS_PARSE_ERROR_VALUE  Error parsing numerical value. PS_PARSE_ERROR_GENERAL  Any other type of lookup error. Definition at line 56 of file psLookupTable.h.

---

Function Documentation

psLookupTable* psLookupTableAlloc (  const char *  fileName, psF64  validFrom, psF64  validTo )

Allocator for psLookupTable struct. Allocates a new psLookupTable struct. Returns: psLookupTable* New psLookupTable struct. Parameters: fileName  Name of file to read validFrom  Lower bound for rable read validTo  Upper bound for table read

psF64 psLookupTableInterpolate (  psLookupTable *  table, psF64  index, psU64  column, psLookupStatusType *  status )

Lookup and interpolate value from table. Interpolates value from table. Sets status bit for success or one of several possible failure conditions. Returns: psLookupTable* New psLookupTable struct Parameters: table  Table with data index  Value to be interpolated column  Column in table to be interpolated status  Status of lookup

psVector* psLookupTableInterpolateAll (  psLookupTable *  table, psF64  index, psVector *  stats )

Lookup and interpolate all values from table. Interpolates all values from table. Sets status bit for success or one of several possible failure conditions. Returns: psLookupTable* New psLookupTable struct Parameters: table  Table with data index  Value to be interpolated stats  Vector of status for each lookup

psLookupTable* psLookupTableRead (  psLookupTable *  table  )

Read lookup table. Reads a lookup table and fills corresponding psLookupTable struct. Returns: psLookupTable* New psLookupTable struct. Parameters: table  Table to read

---