JUTM::JUTMGrid Class Reference

Data structure for UTM grid. More...

#include <JUTMGrid.hh>

Inheritance diagram for JUTM::JUTMGrid:

Public Member Functions
	JUTMGrid ()
	Default constructor.
	JUTMGrid (const std::string &key, const std::string &wgs, const std::string &zone)
	Constructor.
const JUTMGrid &	getUTMGrid () const
	Get UTM grid.
void	setUTMGrid (const JUTMGrid &grid)
	Set UTM grid.
const std::string &	getKey () const
	Get key.
const std::string &	getWGS () const
	Get WGS.
const std::string &	getUTMZone () const
	Get UTM zone.
int	getUTMValue () const
	Get UTM zone by numerical value.
bool	equals (const JUTMGrid &grid) const
	Check equality.
std::string	toString () const
	Convert UTM grid.

Static Public Member Functions
static JUTMGrid	valueOf (const std::string &buffer)
	Extract UTM grid.

Protected Attributes
std::string	key
std::string	wgs
std::string	zone

Friends
std::istream &	operator>> (std::istream &in, JUTMGrid &grid)
	Read UTM grid from input.
std::ostream &	operator<< (std::ostream &out, const JUTMGrid &grid)
	Write UTM grid to output.
JReader &	operator>> (JReader &in, JUTMGrid &grid)
	Read UTM grid from input.
JWriter &	operator<< (JWriter &out, const JUTMGrid &grid)
	Write UTM grid to output.

Detailed Description

Data structure for UTM grid.

This data structure is composed of:

• World Geodetic System;
• UTM zone;

Definition at line 37 of file JUTMGrid.hh.

Constructor & Destructor Documentation

JUTMGrid() [1/2]

JUTM::JUTMGrid::JUTMGrid ( )

inline

Default constructor.

Definition at line 44 of file JUTMGrid.hh.

               :
      key ("?"),
      wgs ("?"),
      zone("?")
    {}

JUTMGrid() [2/2]

JUTM::JUTMGrid::JUTMGrid ( const std::string & key, const std::string & wgs, const std::string & zone )

inline

Constructor.

Parameters

key	key
wgs	WGS
zone	UTM zone

Definition at line 58 of file JUTMGrid.hh.

    {
      this->key  = key;
      this->wgs  = wgs;
      this->zone = zone;
    }

Member Function Documentation

getUTMGrid()

const JUTMGrid & JUTM::JUTMGrid::getUTMGrid ( ) const

inline

Get UTM grid.

Returns

UTM grid

Definition at line 73 of file JUTMGrid.hh.

    {
      return static_cast<const JUTMGrid&>(*this);
    }

setUTMGrid()

void JUTM::JUTMGrid::setUTMGrid ( const JUTMGrid & grid )

inline

Set UTM grid.

Parameters

grid

UTM grid

Definition at line 84 of file JUTMGrid.hh.

    {
      static_cast<JUTMGrid&>(*this) = grid;
    }

getKey()

const std::string & JUTM::JUTMGrid::getKey ( ) const

inline

Get key.

Returns

key

Definition at line 95 of file JUTMGrid.hh.

    {
      return key;
    }

getWGS()

const std::string & JUTM::JUTMGrid::getWGS ( ) const

inline

Get WGS.

Returns

WGS

Definition at line 106 of file JUTMGrid.hh.

    {
      return wgs;
    }

getUTMZone()

const std::string & JUTM::JUTMGrid::getUTMZone ( ) const

inline

Get UTM zone.

Returns

UTM zone

Definition at line 117 of file JUTMGrid.hh.

    {
      return zone;
    }

getUTMValue()

int JUTM::JUTMGrid::getUTMValue ( ) const

inline

Get UTM zone by numerical value.

Returns

UTM zone

Definition at line 128 of file JUTMGrid.hh.

    {
      using namespace std;
 
      int value = 0;
 
      for (string::const_iterator i = zone.begin(); i != zone.end(); ++i) {
        if (isdigit(*i))
          value = 10 * value  +  (*i - '0');
        else
          break;
      }
      
      return value;
    }

equals()

bool JUTM::JUTMGrid::equals ( const JUTMGrid & grid ) const

inline

Check equality.

Parameters

grid

UTM grid

Returns

true if grids are equal; else false

Definition at line 151 of file JUTMGrid.hh.

    {
      return (this->getKey()      == grid.getKey()    &&
              this->getWGS()      == grid.getWGS()    &&
              this->getUTMValue() == grid.getUTMValue());
    }

toString()

std::string JUTM::JUTMGrid::toString ( ) const

inline

Convert UTM grid.

Returns

UTM grid

Definition at line 164 of file JUTMGrid.hh.

    {
      return (key + " " + wgs + " " + zone);
    }

valueOf()

static JUTMGrid JUTM::JUTMGrid::valueOf ( const std::string & buffer )

inlinestatic

Extract UTM grid.

Parameters

buffer

WGS and UTM zone

Returns

UTM grid

Definition at line 176 of file JUTMGrid.hh.

    {
      JUTMGrid grid;
 
      std::istringstream is(buffer);
 
      if (is >> grid)
        return grid;
      else
        throw JParseError("JUTMGrid::valueOf()");
    }

Friends And Related Symbol Documentation

operator>> [1/2]

std::istream & operator>> ( std::istream & in, JUTMGrid & grid )

friend

Read UTM grid from input.

Parameters

in	input stream
grid	UTM grid

Returns

input stream

Definition at line 196 of file JUTMGrid.hh.

    {
      return in >> grid.key >> grid.wgs >> grid.zone;
    }

operator<< [1/2]

std::ostream & operator<< ( std::ostream & out, const JUTMGrid & grid )

friend

Write UTM grid to output.

Parameters

out	output stream
grid	UTM grid

Returns

output stream

Definition at line 209 of file JUTMGrid.hh.

    {
      return out << grid.key << ' ' << grid.wgs << ' ' << grid.zone;
    }

operator>> [2/2]

JReader & operator>> ( JReader & in, JUTMGrid & grid )

friend

Read UTM grid from input.

Parameters

in	input stream
grid	UTM grid

Returns

input stream

Definition at line 222 of file JUTMGrid.hh.

    {
      using namespace JIO;
 
      return in >> grid.key >> grid.wgs >> grid.zone;
    }

operator<< [2/2]

JWriter & operator<< ( JWriter & out, const JUTMGrid & grid )

friend

Write UTM grid to output.

Parameters

out	output stream
grid	UTM grid

Returns

output stream

Definition at line 237 of file JUTMGrid.hh.

    {
      using namespace JIO;
 
      return out << grid.key << grid.wgs << grid.zone;
    }

Member Data Documentation

key

std::string JUTM::JUTMGrid::key

protected

Definition at line 246 of file JUTMGrid.hh.

wgs

std::string JUTM::JUTMGrid::wgs

protected

Definition at line 247 of file JUTMGrid.hh.

zone

std::string JUTM::JUTMGrid::zone

protected

Definition at line 248 of file JUTMGrid.hh.

---

The documentation for this class was generated from the following file:

• JUTMGrid.hh