CapeTypes.hpp

/* -----------------------------------------------------------------------------
 *  Diana process modelling, simulation and analysis software
 *  Copyright (c) 2005, Michael Krasnyk
 *  All rights reserved.
 *
 *  This file is a part of Diana process modelling, simulation and analysis software
 *
 *  Diana is free software; you can redistribute it and/or modify it
 *  under the terms of the GNU General Public License as published
 *  by the Free Software Foundation (see accompanying file LICENSE)
 * -----------------------------------------------------------------------------
 *  $Id: CapeTypes.hpp 8160 2009-03-16 18:36:30Z miha $
 * -----------------------------------------------------------------------------
 *  Description:
 */

#ifndef CAPE_TYPES_HPP

#define CAPE_TYPES_HPP

#include <iostream>
#include <string>
#include <vector>

namespace Common{

  namespace Types{

#ifndef SWIG

    enum CapeType{
      ctCapeNone = 0,     
      ctCapeLong,         
      ctCapeShort,        
      ctCapeDouble,       
      ctCapeFloat,        

      ctCapeBoolean,      
      ctCapeChar,         
      ctCapeString,       
      ctCapeArrayString,  
      ctCapeDate,         

      ctCapeURL,          
      ctCapePointer,      
      ctDianaArray,       
      ctDianaSparseArray, 
    };
#endif

    // elementary type definitions

    typedef long           CapeLong;       
    typedef short          CapeShort;      

    typedef double         CapeDouble;     
    typedef float          CapeFloat;      
      // We define it not as bool, because std::vector is something strange
      // with bitwise storage and masks
      // we are better off with skalar types 
      //typedef bool           CapeBoolean;    ///< Cape Open boolean type
    typedef unsigned char  CapeBoolean;    

    typedef char           CapeChar;       
    typedef std::string    CapeString;     
    typedef CapeString     CapeDate;       
    typedef CapeString     CapeURL;        

    typedef void*          CapePointer;    

    // sequence definitions
    typedef std::vector<CapeLong>      CapeArrayLong;       
    typedef std::vector<CapeShort>     CapeArrayShort;      
    typedef std::vector<CapeDouble>    CapeArrayDouble;     
    typedef std::vector<CapeFloat>     CapeArrayFloat;      
    typedef std::vector<CapeBoolean>   CapeArrayBoolean;    
    typedef std::vector<CapeChar>      CapeArrayChar;       
    typedef std::vector<CapeString>    CapeArrayString;     
    typedef std::vector<CapeDate>      CapeArrayDate;       
    typedef std::vector<CapeURL>       CapeArrayURL;        
    typedef std::vector<CapePointer>   CapeArrayPointer;    

    enum CapeValidationStatus{
      CAPE_NOT_VALIDATED, 
      CAPE_INVALID,       
      CAPE_VALID          
    };

    typedef std::vector<CapeValidationStatus> CapeArrayValidationStatus;  

    // Definition of Undefined values
    const CapeLong    CapeLongUNDEFINED   = 1<<31;      
    const CapeShort   CapeShortUNDEFINED  = 1<<15;      

    const CapeDouble  CapeDoubleUNDEFINED = -4.9E-324;  
    const CapeFloat   CapeFloatUNDEFINED  = -1.4E-45;   

    const CapeChar    CapeCharUNDEFINED   = '\0';       
    const CapeString  CapeStringUNDEFINED = CapeString("");         
    const CapeDate    CapeDateUNDEFINED   = CapeString("");         
    const CapeURL     CapeURLUNDEFINED    = CapeString("");         
  }
}

#endif // CAPE_TYPES_HPP