GAT Documentation

00001 /** @file GATVersion.h
00002  *  Header file contains the current version macros for the GAT engine.
00003  *
00004  *  @date Tue Mar 30 2004
00005  *
00006  *  @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATVersion.h,v 1.5 2004/04/24 10:54:25 hartmutkaiser Exp $
00007  *
00008  *  Copyright (C) Hartmut Kaiser
00009  *  This file is part of the GAT Engine.
00010  *  Contributed by Hartmut Kaiser <hartmutkaiser [at] t-online [dot] de>.
00011  *
00012  *  Use, modification and distribution is subject to the Gridlab Software
00013  *  License. (See accompanying file GLlicense.txt or copy at
00014  *  http://www.gridlab.org/GLlicense.txt)
00015  */
00016 
00017 #if !defined(_GATVERSION_H_)
00018 #define _GATVERSION_H_
00019 
00020 #include "GATType.h"
00021 
00022 /*
00023  *  GATVERSION_FULLVERSION & 0x0000FF is the sub-minor version
00024  *  GATVERSION_FULLVERSION & 0x00FF00 is the minor version
00025  *  GATVERSION_FULLVERSION & 0xFF0000 is the major version
00026  */
00027 #define GATVERSION_FULLVERSION          0x000901
00028 
00029 #define GATVERSION_VERSION_MAJOR        0
00030 #define GATVERSION_VERSION_MINOR        9
00031 #define GATVERSION_VERSION_SUBMINOR     1
00032 
00033 #define GATVERSION_VERSION_DATE         040424
00034 
00035 /** GATUtil_GetVersion
00036  *  
00037  *  Returns the version of the GAT engine.
00038  */
00039 GATuint32 GATUtil_GetVersion(void);
00040 
00041 /** GATVERSION_ISCOMPATIBLE
00042  *  
00043  *  The GATVERSION_ISCOMPATIBLE macro tests, if the version of the loaded
00044  *  GAT engine is compatible with the version the calling application was 
00045  *  compiled against.
00046  *
00047  */
00048 #define GATVERSION_ISCOMPATIBLE()                                             \
00049     ((GATUtil_GetVersion() & ~GATVERSION_VERSION_SUBMINOR) >=                 \
00050       (GATVERSION_FULLVERSION & ~GATVERSION_VERSION_SUBMINOR))                \
00051   /**/
00052   
00053 #endif /* !defined(_GATVERSION_H_) */