JUTM::JUTMPosition Class Reference

Data structure for UTM position. More...

#include <JUTMPosition.hh>

Inheritance diagram for JUTM::JUTMPosition:

Public Member Functions
	JUTMPosition ()
	Default constructor.
	JUTMPosition (const JVector3D &pos)
	Constructor.
	JUTMPosition (const double east, const double north, const double z)
	Constructor.
const JUTMPosition &	getUTMPosition () const
	Get UTM position.
void	setUTMPosition (const JUTMPosition &position)
	Set UTM position.
JPosition3D	getPosition () const
	Get position.
	operator JPosition3D () const
	Type conversion operator.
double	getUTMEast () const
	Get UTM east.
double	getUTMNorth () const
	Get UTM north.
double	getUTMZ () const
	Get UTM Z.
double	getX () const
	Get x.
double	getY () const
	Get y.
double	getZ () const
	Get z.
JUTMPosition &	negate ()
	Negate UTM position.
JUTMPosition &	add (const JUTMPosition &pos)
	Add UTM position.
JUTMPosition &	sub (const JUTMPosition &pos)
	Subtract UTM position.
JUTMPosition &	mul (const double factor)
	Scale UTM position.
JUTMPosition &	div (const double factor)
	Scale UTM position.
double	getDisplacement (const JUTMPosition &position) const
	Get displacement to position.
JFirst_t &	mul (const JSecond_t &object)
	Multiply with object.

Protected Attributes
double	east
double	north
double	z

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

Detailed Description

Data structure for UTM position.

The z-coordinate corresponds to the depth where z = 0 is at sea level.

Definition at line 36 of file JUTMPosition.hh.

Constructor & Destructor Documentation

JUTMPosition() [1/3]

JUTM::JUTMPosition::JUTMPosition ( )

inline

Default constructor.

Definition at line 43 of file JUTMPosition.hh.

                   :
      east (0.0),
      north(0.0),
      z    (0.0)
    {}

JUTMPosition() [2/3]

JUTM::JUTMPosition::JUTMPosition ( const JVector3D & pos )

inline

Constructor.

Parameters

pos	UTM position

Definition at line 55 of file JUTMPosition.hh.

                                       :
      east (pos.getX()),
      north(pos.getY()),
      z    (pos.getZ())
    {}

JUTMPosition() [3/3]

JUTM::JUTMPosition::JUTMPosition ( const double east, const double north, const double z )

inline

Constructor.

Parameters

east	UTM East
north	UTM North
z	UTM Z

Definition at line 69 of file JUTMPosition.hh.

    {
      this->east  = east;
      this->north = north;
      this->z     = z;
    }

Member Function Documentation

getUTMPosition()

const JUTMPosition & JUTM::JUTMPosition::getUTMPosition ( ) const

inline

Get UTM position.

Returns

position

Definition at line 84 of file JUTMPosition.hh.

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

setUTMPosition()

void JUTM::JUTMPosition::setUTMPosition ( const JUTMPosition & position )

inline

Set UTM position.

Parameters

position

position

Definition at line 95 of file JUTMPosition.hh.

    {
      static_cast<JUTMPosition&>(*this) = position;
    }

getPosition()

JPosition3D JUTM::JUTMPosition::getPosition ( ) const

inline

Get position.

Returns

position

Definition at line 106 of file JUTMPosition.hh.

    {
      return JPosition3D(this->getX(), this->getY(), this->getZ());
    }

operator JPosition3D()

JUTM::JUTMPosition::operator JPosition3D ( ) const

inline

Type conversion operator.

Returns

position

Definition at line 117 of file JUTMPosition.hh.

    {
      return getPosition();
    }

getUTMEast()

double JUTM::JUTMPosition::getUTMEast ( ) const

inline

Get UTM east.

Returns

UTM East

Definition at line 128 of file JUTMPosition.hh.

    {
      return this->east;
    }

getUTMNorth()

double JUTM::JUTMPosition::getUTMNorth ( ) const

inline

Get UTM north.

Returns

UTM North

Definition at line 139 of file JUTMPosition.hh.

    {
      return this->north;
    }

getUTMZ()

double JUTM::JUTMPosition::getUTMZ ( ) const

inline

Get UTM Z.

Returns

UTM Z

Definition at line 150 of file JUTMPosition.hh.

    {
      return this->z;
    }

getX()

double JUTM::JUTMPosition::getX ( ) const

inline

Get x.

Returns

UTM East

Definition at line 161 of file JUTMPosition.hh.

    {
      return this->east;
    }

getY()

double JUTM::JUTMPosition::getY ( ) const

inline

Get y.

Returns

UTM North

Definition at line 172 of file JUTMPosition.hh.

    {
      return this->north;
    }

getZ()

double JUTM::JUTMPosition::getZ ( ) const

inline

Get z.

Returns

UTM Z

Definition at line 183 of file JUTMPosition.hh.

    {
      return this->z;
    }

negate()

JUTMPosition & JUTM::JUTMPosition::negate ( )

inline

Negate UTM position.

Returns

this UTM position

Definition at line 194 of file JUTMPosition.hh.

    {
      east  = -east;
      north = -north;
      z     = -z;
 
      return *this;
    }

add()

JUTMPosition & JUTM::JUTMPosition::add ( const JUTMPosition & pos )

inline

Add UTM position.

Parameters

pos	UTM position

Returns

this UTM position

Definition at line 210 of file JUTMPosition.hh.

    {
      east  += pos.getUTMEast();
      north += pos.getUTMNorth();
      z     += pos.getUTMZ();
 
      return *this;
    }

sub()

JUTMPosition & JUTM::JUTMPosition::sub ( const JUTMPosition & pos )

inline

Subtract UTM position.

Parameters

pos	UTM position

Returns

this UTM position

Definition at line 226 of file JUTMPosition.hh.

    {
      east  -= pos.getUTMEast();
      north -= pos.getUTMNorth();
      z     -= pos.getUTMZ();
 
      return *this;
    }

mul() [1/2]

JUTMPosition & JUTM::JUTMPosition::mul ( const double factor )

inline

Scale UTM position.

Parameters

factor

multiplication factor

Returns

this UTM position

Definition at line 242 of file JUTMPosition.hh.

    {
      east  *= factor;
      north *= factor;
      z     *= factor;
 
      return *this;
    }

div()

JUTMPosition & JUTM::JUTMPosition::div ( const double factor )

inline

Scale UTM position.

Parameters

factor

division factor

Returns

this UTM position

Definition at line 258 of file JUTMPosition.hh.

    {
      east  /= factor;
      north /= factor;
      z     /= factor;
 
      return *this;
    }

getDisplacement()

double JUTM::JUTMPosition::getDisplacement ( const JUTMPosition & position ) const

inline

Get displacement to position.

The displacement corresponds to the 2D distance in the (East,North) plane.

Parameters

position

position

Returns

displacement

Definition at line 276 of file JUTMPosition.hh.

    {
      const double x = this->getUTMEast()  - position.getUTMEast();
      const double y = this->getUTMNorth() - position.getUTMNorth();
 
      return sqrt(x*x + y*y);
    }

mul() [2/2]

template<class JFirst_t , class JSecond_t >

JFirst_t & JMATH::JMath< JFirst_t, JSecond_t >::mul ( const JSecond_t & object )

inlineinherited

Multiply with object.

Parameters

object

object

Returns

result object

Definition at line 354 of file JMath.hh.

    {
      return static_cast<JFirst_t&>(*this) = JFirst_t().mul(static_cast<const JFirst_t&>(*this), object);
    }

Friends And Related Symbol Documentation

operator>> [1/2]

std::istream & operator>> ( std::istream & in, JUTMPosition & pos )

friend

Read UTM position from input.

Parameters

in	input stream
pos	UTM position

Returns

input stream

Definition at line 292 of file JUTMPosition.hh.

    {
      return in >> pos.east >> pos.north >> pos.z;
    }

operator<< [1/2]

std::ostream & operator<< ( std::ostream & out, const JUTMPosition & pos )

friend

Write UTM position to output.

Parameters

out	output stream
pos	UTM position

Returns

output stream

Definition at line 305 of file JUTMPosition.hh.

    {
      const JFormat format[] = { JFormat(out, getFormat<JUTMPosition>(JFormat_t(12, 3, std::ios::fixed | std::ios::showpos))),
        JFormat(out, getFormat<JPosition3D> (JFormat_t( 9, 3, std::ios::fixed | std::ios::showpos)))    };
            
      return out << format[0] << pos.east  << ' ' 
                 << format[0] << pos.north << ' ' 
                 << format[1] << pos.z;
    }

operator>> [2/2]

JReader & operator>> ( JReader & in, JUTMPosition & pos )

friend

Read UTM position from input.

Parameters

in	input stream
pos	UTM position

Returns

input stream

Definition at line 324 of file JUTMPosition.hh.

    {
      return in >> pos.east >> pos.north >> pos.z;
    }

operator<< [2/2]

JWriter & operator<< ( JWriter & out, const JUTMPosition & pos )

friend

Write UTM position to output.

Parameters

out	output stream
pos	UTM position

Returns

output stream

Definition at line 337 of file JUTMPosition.hh.

    {
      return out << pos.east << pos.north << pos.z;
    }

Member Data Documentation

east

double JUTM::JUTMPosition::east

protected

Definition at line 344 of file JUTMPosition.hh.

north

double JUTM::JUTMPosition::north

protected

Definition at line 345 of file JUTMPosition.hh.

z

double JUTM::JUTMPosition::z

protected

Definition at line 346 of file JUTMPosition.hh.

---

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

• JUTMPosition.hh