Data structure for UTM position. More...

#include <JUTMPosition.hh>

Inheritance diagram for JUTM::JUTMPosition:

Public Member Functions
	JUTMPosition ()
	Default constructor. More...

	JUTMPosition (const JVector3D &pos)
	Constructor. More...

	JUTMPosition (const double east, const double north, const double z)
	Constructor. More...

const JUTMPosition &	getUTMPosition () const
	Get UTM position. More...

JPosition3D	getPosition () const
	Get position. More...

	operator JPosition3D () const
	Type conversion operator. More...

double	getUTMEast () const
	Get UTM east. More...

double	getUTMNorth () const
	Get UTM north. More...

double	getUTMZ () const
	Get UTM Z. More...

JUTMPosition &	negate ()
	Negate UTM position. More...

JUTMPosition &	add (const JUTMPosition &pos)
	Add UTM position. More...

JUTMPosition &	sub (const JUTMPosition &pos)
	Subtract UTM position. More...

JUTMPosition &	mul (const double factor)
	Scale UTM position. More...

JUTMPosition &	div (const double factor)
	Scale UTM position. More...

JUTMPosition &	mul (const JNullType &object)
	Multiply with object. More...

Protected Attributes
double	east

double	north

double	z

Friends
std::istream &	operator>> (std::istream &in, JUTMPosition &pos)
	Read UTM position from input. More...

std::ostream &	operator<< (std::ostream &out, const JUTMPosition &pos)
	Write UTM position to output. More...

JReader &	operator>> (JReader &in, JUTMPosition &pos)
	Read UTM position from input. More...

JWriter &	operator<< (JWriter &out, const JUTMPosition &pos)
	Write UTM position to output. More...

Detailed Description

Data structure for UTM position.

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

Definition at line 34 of file JUTMPosition.hh.

Constructor & Destructor Documentation

JUTM::JUTMPosition::JUTMPosition ( )

inline

Default constructor.

Definition at line 41 of file JUTMPosition.hh.

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

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

inline

Constructor.

Parameters

pos	UTM position

Definition at line 53 of file JUTMPosition.hh.

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

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 67 of file JUTMPosition.hh.

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

Member Function Documentation

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

inline

Get UTM position.

Returns: position

Definition at line 82 of file JUTMPosition.hh.

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

JPosition3D JUTM::JUTMPosition::getPosition ( ) const

inline

Get position.

Returns: position

Definition at line 93 of file JUTMPosition.hh.

     {
       return JPosition3D(east, north, z);
     }

JUTM::JUTMPosition::operator JPosition3D ( ) const

inline

Type conversion operator.

Returns: position

Definition at line 104 of file JUTMPosition.hh.

     {
       return getPosition();
     }

double JUTM::JUTMPosition::getUTMEast ( ) const

inline

Get UTM east.

Returns: UTM East

Definition at line 115 of file JUTMPosition.hh.

     {
       return this->east;
     }

double JUTM::JUTMPosition::getUTMNorth ( ) const

inline

Get UTM north.

Returns: UTM North

Definition at line 126 of file JUTMPosition.hh.

     {
       return this->north;
     }

double JUTM::JUTMPosition::getUTMZ ( ) const

inline

Get UTM Z.

Returns: UTM Z

Definition at line 137 of file JUTMPosition.hh.

     {
       return this->z;
     }

JUTMPosition& JUTM::JUTMPosition::negate ( )

inline

Negate UTM position.

Returns: this UTM position

Definition at line 148 of file JUTMPosition.hh.

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

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

inline

Add UTM position.

Parameters

pos	UTM position

Returns: this UTM position

Definition at line 164 of file JUTMPosition.hh.

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

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

inline

Subtract UTM position.

Parameters

pos	UTM position

Returns: this UTM position

Definition at line 180 of file JUTMPosition.hh.

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

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

inline

Scale UTM position.

Parameters

factor multiplication factor

Returns: this UTM position

Definition at line 196 of file JUTMPosition.hh.

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

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

inline

Scale UTM position.

Parameters

factor division factor

Returns: this UTM position

Definition at line 212 of file JUTMPosition.hh.

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

JUTMPosition & JMATH::JMath< JUTMPosition , JNullType >::mul ( const JNullType & object )

inlineinherited

Multiply with object.

Parameters

object object

Returns: result object

Definition at line 273 of file JMath.hh.

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

Friends And Related Function Documentation

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 229 of file JUTMPosition.hh.

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

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 242 of file JUTMPosition.hh.

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

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 256 of file JUTMPosition.hh.

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

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 269 of file JUTMPosition.hh.

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

Member Data Documentation

double JUTM::JUTMPosition::east

protected

Definition at line 276 of file JUTMPosition.hh.

double JUTM::JUTMPosition::north

protected

Definition at line 277 of file JUTMPosition.hh.

double JUTM::JUTMPosition::z

protected

Definition at line 278 of file JUTMPosition.hh.

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

JUTMPosition.hh

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation