Main Page   Modules   Alphabetical List   Compound List   Compound Members  

Type codes


Typedefs

typedef enum _cpl_type_ cpl_type
 The type code type. More...


Enumerations

enum  _cpl_type_ {
  CPL_TYPE_FLAG_ARRAY,
  CPL_TYPE_INVALID,
  CPL_TYPE_CHAR,
  CPL_TYPE_UCHAR,
  CPL_TYPE_BOOL,
  CPL_TYPE_INT,
  CPL_TYPE_UINT,
  CPL_TYPE_LONG,
  CPL_TYPE_ULONG,
  CPL_TYPE_FLOAT,
  CPL_TYPE_DOUBLE,
  CPL_TYPE_POINTER,
  CPL_TYPE_STRING
}
 The CPL type codes and flags. More...


Functions

size_t cpl_type_sizeof (cpl_type type)
 Compute the size of a type. More...


Detailed Description

This module provides codes for the basic types (char, int, float, etc.). These type codes may be used to indicate the type of a value stored in another object, the value of a property or the pixel of an image for instance. In addition, a utility function is provided to compute the size, which is required to store a value of the type indicated by a given type code.

The module

Synopsis
   #include <cpl_types.h>

Typedef Documentation

typedef enum _cpl_type_ cpl_type
 

The type code type.


Enumeration Type Documentation

enum _cpl_type_
 

The CPL type codes and flags.

Enumeration values:
CPL_TYPE_FLAG_ARRAY  Flag indicating whether a type is an array or a basic type.
CPL_TYPE_INVALID  Invalid or undetermined type.
CPL_TYPE_CHAR  Type code corresponding to type char.
CPL_TYPE_UCHAR  Type code corresponding to type unsigned char.
CPL_TYPE_BOOL  Type code corresponding to the boolean type.
CPL_TYPE_INT  Type code corresponding to type int.
CPL_TYPE_UINT  Type code corresponding to type unsigned int.
CPL_TYPE_LONG  Type code corresponding to type long.
CPL_TYPE_ULONG  Type code corresponding to type unsigned long.
CPL_TYPE_FLOAT  Type code corresponding to type float.
CPL_TYPE_DOUBLE  Type code corresponding to type double.
CPL_TYPE_POINTER  Type code corresponding to a pointer type.
CPL_TYPE_STRING  Type code corresponding to a character array.


Function Documentation

size_t cpl_type_sizeof cpl_type    type
 

Compute the size of a type.

Parameters:
type  Type code to be evaluated.
Returns:
The size of the fundamental type, or 0 in case an invalid type code was given.
The function computes the atomic size of the type type. The result for fundamental types like CPL_TYPE_FLOAT is what you would expect from the C sizeof() operator. For arrays, i.e. types having the CPL_TYPE_FLAG_ARRAY set the returned size is not the size of a pointer to CPL_TYPE_FLOAT for instance, but the size of its fundamental type, i.e. the returned size is same as for the type CPL_TYPE_FLOAT.

Especially for the type CPL_TYPE_STRING, which is explicitly defined for convenience reasons, the size returned by this function is the size of CPL_TYPE_CHAR!


Generated on Mon May 24 14:58:05 2004 for Common Pipeline Library Reference Manual by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002