GLIMSView Source Code Documentation

glacieriddef.h

Go to the documentation of this file.

#ifndef __GLACIERIDDEF_H
#define __GLACIERIDDEF_H

#include "shape.h"
#include "glimsglobals.h"
#include <string>
#include <qstring.h>
#include <qregexp.h>
#include "ValidationReport.h"


class GlacierIDDef : public XMLSerializeable {
public:
  double      mLat;          
  double      mLon;          
  Node        mImgCoord;     
  std::string mName;         
  std::string mWGMSID;       
  std::string mLocalID;      
  std::string mParentID;     
  int         mPrimCsfn;     
  int         mForm;         
  int         mFChar;        
  int         mLChar;        
  int         mDomMassSrc;   
  int         mTongueAct;    
  float       mWidth;        
  float       mLength;       
  float       mArea;         
  float       mAbzoneArea;   
  float       mSpeed;        
  float       mELA;          

  std::string mELADesc;      


  float       mSnowLineElev; 

  GlacierIDDef( ) {
    mLat          = 0.0;      // LATITUDE OF GLACIER ID
    mLon          = 0.0;      // LONGITUDE OF GLACIER ID
    mName         = "";       // NAME OF GLACIER
    mWGMSID       = "";       // WGMS ID
    mLocalID      = "";       // LOCAL(TO RC) ID
    mParentID     = "";       // PARENT GID
    mPrimCsfn     = -1;       // PRIMARY CLASSIFICATION INDEX
    mForm         = -1;       // FORM INDEX
    mFChar        = -1;       // FRONTAL CHARACTERISTICS INDEX
    mLChar        = -1;       // LONGITUDINAL CHARACTERISTICS INDEX
    mDomMassSrc   = -1;       // DOMINANT MASS SOURCE INDEX
    mTongueAct    = -1;       // TOUNGE ACTIVITY INDEX
    mWidth        = -999.0f;  // WIDTH
    mLength       = -999.0f;  // LENGTH
    mArea         = -999.0f;  // AREA
    mAbzoneArea   = -999.0f;  // ABZONE AREA
    mSpeed        = -999.0f;  // SPEED
    mELA          = -999.0f;  // ELA (Equilibrium Line Altitude, i.e., altitude where net mass balance is zero, ablation equals accumulation) 
    mELADesc      = "";       // ELA DESCRIPTION
    mSnowLineElev = -999.0f;  // SNOW LINE ELEVATION
  }

  GlacierIDDef( const QString & new_glimsID ) {
    mLat          = 0.0;      // LATITUDE OF GLACIER ID
    mLon          = 0.0;      // LONGITUDE OF GLACIER ID

    int len = 0 , ndx = -1 ;
    QString strval ;

    QRegExp r("G[0-9]+E") ;         // matches longitude value in GLIMS ID
    ndx = r.match(new_glimsID, 0, &len) ;
    if (ndx >= 0) {
      strval = new_glimsID.mid (ndx + 1, len - 2) ;  // pulls lon value out of GLIMS ID
      mLon = (strval.toFloat()) / pow(10, len - 5) ; // converts integer into correct float
                                                     // len -2 for G and E characters, and -3 for decimal shift  
    } 

    r.setPattern ("E[0-9]+[N|S]") ; // matches latitude value in GLIMS ID
    ndx = r.match(new_glimsID, 0, &len) ;
    if (ndx >= 0) {
      strval = new_glimsID.mid (ndx + 1, len - 2) ;  // pulls lat value out of GLIMS ID
      mLat = (strval.toFloat()) / pow(10, len - 4) ; // converts integer into correct float
                                                     // len -2 for E and N|S characters, and -2 for decimal shift  
    } 

    mName         = "";       // NAME OF GLACIER
    mWGMSID       = "";       // WGMS ID
    mLocalID      = "";       // LOCAL(TO RC) ID
    mParentID     = "";       // PARENT GID
    mPrimCsfn     = -1;       // PRIMARY CLASSIFICATION INDEX
    mForm         = -1;       // FORM INDEX
    mFChar        = -1;       // FRONTAL CHARACTERISTICS INDEX
    mLChar        = -1;       // LONGITUDINAL CHARACTERISTICS INDEX
    mDomMassSrc   = -1;       // DOMINANT MASS SOURCE INDEX
    mTongueAct    = -1;       // TOUNGE ACTIVITY INDEX
    mWidth        = -999.0f;  // WIDTH
    mLength       = -999.0f;  // LENGTH
    mArea         = -999.0f;  // AREA
    mAbzoneArea   = -999.0f;  // ABZONE AREA
    mSpeed        = -999.0f;  // SPEED
    mELA          = -999.0f;  // ELA (Equilibrium Line Altitude, i.e., altitude where net mass balance is zero, ablation equals accumulation) 
    mELADesc      = "";       // ELA DESCRIPTION
    mSnowLineElev = -999.0f;  // SNOW LINE ELEVATION
  }


  ~GlacierIDDef( ) {;}

  virtual bool fromXML( QDomElement &elem ) {
    if ( std::string( "GlacierIDDef" ).compare( (const char*)elem.tagName() ) )
      return false;

    QDomElement imgcoordelem = getElemByTagName( elem, "ImgCoord" );
    mLat =          readDoubleTag( elem, "Lat" );
    mLon =          readDoubleTag( elem, "Lon" );

    mName =         readTextTag( elem, "Name" );
    mWGMSID =       readTextTag( elem, "WGMSID" );
    mLocalID =      readTextTag( elem, "LocalID" );
    mParentID =     readTextTag( elem, "ParentID" );

    mPrimCsfn =     readIntTag( elem, "PrimCsfn" );
    mForm =         readIntTag( elem, "Form" );
    mFChar =        readIntTag( elem, "FChar" );
    mLChar =        readIntTag( elem, "LChar" );
    mDomMassSrc =   readIntTag( elem, "DomMassSrc" );
    mTongueAct =    readIntTag( elem, "TongueAct" );

    mWidth =        readDoubleTag( elem, "Width" );
    mLength =       readDoubleTag( elem, "Length" );
    mArea =         readDoubleTag( elem, "Area" );
    mAbzoneArea =   readDoubleTag( elem, "AbzoneArea" );
    mSpeed =        readDoubleTag( elem, "Speed" );
    mELA =          readDoubleTag( elem, "ELA" );
    mELADesc =      readTextTag( elem, "ELADesc" );
    mSnowLineElev = readDoubleTag( elem, "SnowLineElev" );

    return true;
  }

  virtual bool toXML( QDomDocument &doc,
                      QDomElement &elem,
                      std::string id = "" ) {
    QDomElement base = doc.createElement( "GlacierIDDef" );
    if ( id != "" )
      base.setAttribute( "id", (char*)id.c_str() );
    elem.appendChild( base );

    writeDoubleTag( doc, base, "Lat", mLat );
    writeDoubleTag( doc, base, "Lon", mLon );
    writeTextTag( doc, base, "Name", mName );
    writeTextTag( doc, base, "WGMSID", mWGMSID );
    writeTextTag( doc, base, "LocalID", mLocalID );
    writeTextTag( doc, base, "ParentID", mParentID );
    writeIntTag( doc, base, "PrimCsfn", mPrimCsfn );
    writeIntTag( doc, base, "Form", mForm );
    writeIntTag( doc, base, "FChar", mFChar );
    writeIntTag( doc, base, "LChar", mLChar );
    writeIntTag( doc, base, "DomMassSrc", mDomMassSrc );
    writeIntTag( doc, base, "TongueAct", mTongueAct );
    writeDoubleTag( doc, base, "Width", mWidth );
    writeDoubleTag( doc, base, "Length", mLength );
    writeDoubleTag( doc, base, "Area", mArea );
    writeDoubleTag( doc, base, "AbzoneArea", mAbzoneArea );
    writeDoubleTag( doc, base, "Speed", mSpeed );
    writeDoubleTag( doc, base, "ELA", mELA );
    writeTextTag( doc, base, "ELADesc", mELADesc );
    writeDoubleTag( doc, base, "SnowLineElev", mSnowLineElev );
    return true;
  }

  // updateVersion: make applicable fixes to the glacier info in the
  //                project based on the version date of the project file
  virtual void updateVersion (QDate * projectVersion) {

    // 5/20/20034: classifications off by 1 - stored as reference to index of dropdown box
    //             instead of the WGMS specification number
    QDate checkDate (2004, 5, 20) ;
    if ( *projectVersion < checkDate ) {
      mPrimCsfn   -= 1 ;
      mForm       -= 1 ;
      mFChar      -= 1 ;
      mLChar      -= 1 ;
      mDomMassSrc -= 1 ;
      mTongueAct  -= 1 ;
    }
  }


  // create a glacier ID string from the lat-lon value
  std::string toString( ) {
    std::string     gid;        
    char            buf[50];    
    std::string     northing;   
    std::string     flonpad;    
    std::string     flatpad;    
    std::string     blonpad;    
    std::string     blatpad;    
    int             latprec;    
    int             lonprec;    

    double          tLat = mLat ;      // temp container for latitude
    double          tLon = mLon ;      // temp container for latitude

    // ---------------------------------------------------------
    // DETERMINE NORTHING STRING
    if ( tLat < 0 ) {
      northing = "S";
      tLat *= -1;
    } else {
      northing = "N";
    }
    // ---------------------------------------------------------

    // OFFSET LON - get it into -180/180 range and 
    if ( tLon < 0 ) {
      tLon += 360 ;
    }

    // DETERMINE LAT/LON PRECISION
    latprec = (int)((tLat - (int)tLat) * 1000.0 + 0.5);
    lonprec = (int)((tLon - (int)tLon) * 1000.0 + 0.5);

    // ---------------------------------------------------------
    // FILL PADDINGS
    if ( tLon < 10 )
      flonpad = "00";
    else if ( tLon < 100 )
      flonpad = "0";

    if ( tLat < 10 )
      flatpad = "0";

    if ( latprec < 10 )
      blatpad = "00";
    else if ( latprec < 100 )
      blatpad = "0";

    if ( lonprec < 10 )
      blonpad = "00";
    else if ( lonprec < 100 )
      blonpad = "0";
    // ---------------------------------------------------------

    // LOAD BUFFER
    sprintf( buf,
             "G%s%d%s%dE%s%d%s%d%s",
             flonpad.c_str(),
             (int)tLon,
             blonpad.c_str(),
             lonprec,
             flatpad.c_str(),
             (int)tLat,
             blatpad.c_str(),
             latprec,
             northing.c_str() );

    gid = buf;
    return gid;
  }

  bool validate (ValidationReport * valRep) {
    bool dataValid = true ;
    std::stringstream rptstream ;
    rptstream << "Checking glacier " << toString () ;
    valRep->subsectionBegin( rptstream.str() ) ;
    rptstream.str("") ;


    // Latitude
    if ( mLat < -90 || mLat > 90 ) {
      valRep->reportError( "Latitude is invalid." ) ;
      dataValid = false ;
    }
    if ( mLat == 0 ) {
      valRep->reportWarning( "Latitude may be invalid or undefined." ) ;
    }

    // Longitude
    if ( mLon < -180 || mLon > 360 ) {
      valRep->reportError( "Longitude is invalid." ) ;
      dataValid = false ;
    }
    if ( mLon == 0 ) {
      valRep->reportWarning( "Longitude may be invalid or undefined." ) ;
    }

    // Name
    if ( mName.empty() ) {
      valRep->reportWarning( "Glacier name is not defined." ) ;
    }

    // WGMS ID 
    if ( mWGMSID.empty() ) {
      valRep->reportWarning( "WGMS ID is not defined." ) ;
    }

    // Local ID
    if ( mLocalID.empty() ) {
      valRep->reportWarning( "Local ID is not defined." ) ;
    }


    // Parent ID 
    if ( mParentID.empty() ) {
      valRep->reportWarning( "Parent ID is not defined." ) ;
    }

    // Primary classification
    if ( mPrimCsfn < 0 ) {
      valRep->reportWarning( "Primary classification is not defined." ) ;
    }

    // Form
    if ( mForm < -1 ) {
      valRep->reportWarning( "Form is not defined." ) ;
    }

    // Frontal characteristics
    if ( mFChar < -1 ) {
      valRep->reportWarning( "Frontal characteristic is not defined." ) ;
    }

    // Longitudinal characteristics
    if ( mLChar < -1 ) {
      valRep->reportWarning( "Longitudinal characteristic is not defined." ) ;
    }

    // Mass source
    if (mDomMassSrc  < -1 ) {
      valRep->reportWarning( "Dominant mass source is not defined." ) ;
    }

    // Tongue activity
    if ( mTongueAct < -1 ) {
      valRep->reportWarning( "Tongue activity is not defined." ) ;
    }

    // Width
    if ( mWidth  == -999.0 ) {
      valRep->reportWarning( "Width is not defined." ) ;
    }

    // Length
    if ( mLength == -999.0 ) {
      valRep->reportWarning( "Length is not defined." ) ;
    }

    // Area
    if ( mArea == -999.0 ) {
      valRep->reportWarning( "Area is not defined." ) ;
    }

    // Ablation zone area
    if ( mAbzoneArea == -999.0 ) {
      valRep->reportWarning( "Ablation zone area is not defined." ) ;
    }

    // Speed
    if ( mSpeed == -999.0 ) {
      valRep->reportWarning( "Speed is not defined." ) ;
    }

    // ELA
    if ( mELA == -999.0 ) {
      valRep->reportWarning( "ELA is not defined." ) ;
    }

    // ELA Description
    if ( mELADesc.empty() ) {
      valRep->reportWarning( "ELA description is not defined." ) ;
    }

    // Snow Line Elevation
    if ( mSnowLineElev == -999.0 ) {
      valRep->reportWarning( "Snow line elevation is not defined." ) ;
    }

    // end glacier check 
    if (dataValid) {
      rptstream << "Glacier " << toString () << " is valid." ;
      valRep->subsectionEnd( rptstream.str()  ) ;
    }
    else {
      rptstream << "Glacier " << toString () << " has missing or invalid information." ;
      valRep->subsectionEnd( rptstream.str()  ) ;
    }

    // return status of lines
    return dataValid ;
  }


};

#endif

---

Home | Search | Disclaimers & Privacy | Contact Us GLIMSView Maintainer: dsoltesz@usgs.gov