Data structure for anchor position on sea bed. More...

#include <JAnchor.hh>

Inheritance diagram for JDETECTOR::JAnchor:

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

	JAnchor (const int id, const double x, const double y)
	Constructor. More...

int	getID () const
	Get identifier. More...

void	setID (const int id)
	Set identifier. More...

bool	less (const JObjectID &object) const
	Less than method. More...

bool	less (const int id) const
	Less than method. More...

bool	more (const int id) const
	More than method. More...

const JPosition2D &	getPosition () const
	Get position. More...

JPosition2D &	getPosition ()
	Get position. More...

void	setPosition (const JVector2D &pos)
	Set position. More...

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

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

JPosition2D &	rotate (const JRotation2D &R)
	Rotate. More...

JPosition2D &	rotate_back (const JRotation2D &R)
	Rotate back. More...

double	getDot (const JAngle2D &angle) const
	Get dot product. More...

double	getDot (const JVersor2D &versor) const
	Get dot product. More...

double	getDot (const JVector2D &point) const
	Get dot product. More...

double	getPerpDot (const JAngle2D &angle) const
	Get perpendicular dot product. More...

double	getPerpDot (const JVersor2D &dir) const
	Get perpendicular dot product. More...

double	getPerpDot (const JVector2D &point) const
	Get perpendicular dot product. More...

double	getX () const
	Get x position. More...

double	getY () const
	Get y position. More...

JVector2D &	negate ()
	Negate vector. More...

JVector2D &	add (const JVector2D &vector)
	Add vector. More...

JVector2D &	sub (const JVector2D &vector)
	Subtract vector. More...

JVector2D &	mul (const double factor)
	Scale vector. More...

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

JVector2D &	div (const double factor)
	Scale vector. More...

JVector2D &	transform (const JMatrix2D &T)
	Transform. More...

bool	equals (const JVector2D &vector) const
	Check equality. More...

double	getLengthSquared () const
	Get length squared. More...

double	getLength () const
	Get length. More...

double	getDistanceSquared (const JVector2D &point) const
	Get squared of distance to point. More...

double	getDistance (const JVector2D &point) const
	Get distance to point. More...

Protected Attributes
int	__id

double	__x

double	__y

Friends
std::istream &	operator>> (std::istream &in, JAnchor &anchor)
	Read JAnchor from input. More...

std::ostream &	operator<< (std::ostream &out, const JAnchor &anchor)
	Write JAnchor to output. More...

Detailed Description

Data structure for anchor position on sea bed.

Definition at line 24 of file JAnchor.hh.

Constructor & Destructor Documentation

JDETECTOR::JAnchor::JAnchor ( )

inline

Default constructor.

Definition at line 32 of file JAnchor.hh.

               :
       JObjectID(),
       JPosition2D()
     {}

JDETECTOR::JAnchor::JAnchor	(	const int	id,
		const double	x,
		const double	y
	)

inline

Constructor.

Parameters

id	identifier
x	x position
y	y position

Definition at line 45 of file JAnchor.hh.

                             :
       JObjectID(id),
       JPosition2D(x, y)
     {}

Member Function Documentation

int JLANG::JObjectID::getID ( ) const

inlineinherited

Get identifier.

Returns: identifier

Definition at line 54 of file JObjectID.hh.

     { 
       return __id;
     }

void JLANG::JObjectID::setID ( const int id )

inlineinherited

Set identifier.

Parameters

id	identifier

Definition at line 65 of file JObjectID.hh.

     { 
       this->__id = id;
     }

bool JLANG::JObjectID::less ( const JObjectID & object ) const

inlineinherited

Less than method.

Parameters

object object identifier

Returns: true if this identifier less than given identifier; else false

Definition at line 77 of file JObjectID.hh.

     { 
       return this->getID() < object.getID();
     }

bool JLANG::JObjectID::less ( const int id ) const

inlineinherited

Less than method.

Parameters

id	identifier

Returns: true if this identifier less than given identifier; else false

Definition at line 89 of file JObjectID.hh.

     { 
       return this->getID() < id;
     }

bool JLANG::JObjectID::more ( const int id ) const

inlineinherited

More than method.

Parameters

id	identifier

Returns: true if this identifier greater than given identifier; else false

Definition at line 101 of file JObjectID.hh.

     { 
       return this->getID() > id;
     }

const JPosition2D& JGEOMETRY2D::JPosition2D::getPosition ( ) const

inlineinherited

Get position.

Returns: position

Definition at line 97 of file JPosition2D.hh.

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

JPosition2D& JGEOMETRY2D::JPosition2D::getPosition ( )

inlineinherited

Get position.

Returns: position

Definition at line 108 of file JPosition2D.hh.

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

void JGEOMETRY2D::JPosition2D::setPosition ( const JVector2D & pos )

inlineinherited

Set position.

Parameters

pos position

Definition at line 119 of file JPosition2D.hh.

     {
       static_cast<JVector2D&>(*this) = pos;
     }

JGEOMETRY2D::JPosition2D::operator JAngle2D ( ) const

inlineinherited

Type conversion operator.

Returns: angle

Definition at line 130 of file JPosition2D.hh.

     {
       return JAngle2D(getX(), getY());
     }

JGEOMETRY2D::JPosition2D::operator JVersor2D ( ) const

inlineinherited

Type conversion operator.

Returns: direction

Definition at line 141 of file JPosition2D.hh.

     {
       return JVersor2D(getX(), getY());
     }

JPosition2D& JGEOMETRY2D::JPosition2D::rotate ( const JRotation2D & R )

inlineinherited

Rotate.

Parameters

R	rotation matrix

Returns: this position

Definition at line 153 of file JPosition2D.hh.

     {
       R.rotate(__x, __y);
 
       return *this;
     }

JPosition2D& JGEOMETRY2D::JPosition2D::rotate_back ( const JRotation2D & R )

inlineinherited

Rotate back.

Parameters

R	rotation matrix

Returns: this position

Definition at line 167 of file JPosition2D.hh.

     {
       R.rotate_back(__x, __y);
 
       return *this;
     }

double JGEOMETRY2D::JPosition2D::getDot ( const JAngle2D & angle ) const

inlineinherited

Get dot product.

Parameters

angle angle

Returns: dot product

Definition at line 181 of file JPosition2D.hh.

     {
       return
         getX() * angle.getDX() +
         getY() * angle.getDY();
     }

double JGEOMETRY2D::JPosition2D::getDot ( const JVersor2D & versor ) const

inlineinherited

Get dot product.

Parameters

versor versor

Returns: dot product

Definition at line 195 of file JPosition2D.hh.

     {
       return
         getX() * versor.getDX() +
         getY() * versor.getDY();
     }

double JGEOMETRY2D::JVector2D::getDot ( const JVector2D & point ) const

inlineinherited

Get dot product.

Parameters

point vector

Returns: dot product

Definition at line 231 of file JVector2D.hh.

     {
       return
         getX() * point.getX() + 
         getY() * point.getY();
     }

double JGEOMETRY2D::JPosition2D::getPerpDot ( const JAngle2D & angle ) const

inlineinherited

Get perpendicular dot product.

Parameters

angle angle

Returns: perpendicular dot product

Definition at line 209 of file JPosition2D.hh.

     {
       return
         getX() * angle.getDY() -
         getY() * angle.getDX();
     }

double JGEOMETRY2D::JPosition2D::getPerpDot ( const JVersor2D & dir ) const

inlineinherited

Get perpendicular dot product.

Parameters

dir direction

Returns: perpendicular dot product

Definition at line 223 of file JPosition2D.hh.

     {
       return
         getX() * dir.getDY() -
         getY() * dir.getDX();
     }

double JGEOMETRY2D::JVector2D::getPerpDot ( const JVector2D & point ) const

inlineinherited

Get perpendicular dot product.

Parameters

point vector

Returns: perpendicular dot product

Definition at line 245 of file JVector2D.hh.

     {
       return
         getX() * point.getY() - 
         getY() * point.getX();
     }

double JGEOMETRY2D::JVector2D::getX ( ) const

inlineinherited

Get x position.

Returns: x position

Definition at line 61 of file JVector2D.hh.

     { 
       return __x;
     }

double JGEOMETRY2D::JVector2D::getY ( ) const

inlineinherited

Get y position.

Returns: y position

Definition at line 72 of file JVector2D.hh.

     { 
       return __y;
     }

JVector2D& JGEOMETRY2D::JVector2D::negate ( )

inlineinherited

Negate vector.

Returns: this vector

Definition at line 83 of file JVector2D.hh.

     {
       __x = -__x;
       __y = -__y;
 
       return *this;
     }

JVector2D& JGEOMETRY2D::JVector2D::add ( const JVector2D & vector )

inlineinherited

Add vector.

Parameters

vector vector

Returns: this vector

Definition at line 98 of file JVector2D.hh.

     {
       __x += vector.getX();
       __y += vector.getY();
 
       return *this;
     }

JVector2D& JGEOMETRY2D::JVector2D::sub ( const JVector2D & vector )

inlineinherited

Subtract vector.

Parameters

vector vector

Returns: this vector

Definition at line 113 of file JVector2D.hh.

     {
       __x -= vector.getX();
       __y -= vector.getY();
 
       return *this;
     }

JVector2D& JGEOMETRY2D::JVector2D::mul ( const double factor )

inlineinherited

Scale vector.

Parameters

factor multiplication factor

Returns: this vector

Definition at line 128 of file JVector2D.hh.

     {
       __x *= factor;
       __y *= factor;
 
       return *this;
     }

JVector2D & JMATH::JMath< JVector2D , 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);
     }

JVector2D& JGEOMETRY2D::JVector2D::div ( const double factor )

inlineinherited

Scale vector.

Parameters

factor division factor

Returns: this vector

Definition at line 143 of file JVector2D.hh.

     {
       __x /= factor;
       __y /= factor;
 
       return *this;
     }

JVector2D& JGEOMETRY2D::JVector2D::transform ( const JMatrix2D & T )

inlineinherited

Transform.

Parameters

T matrix

Returns: this vector

Definition at line 158 of file JVector2D.hh.

     {
       T.transform(__x, __y);
 
       return *this;
     }

bool JGEOMETRY2D::JVector2D::equals ( const JVector2D & vector ) const

inlineinherited

Check equality.

Parameters

vector vector

Returns: true if vectors are equal; else false

Definition at line 172 of file JVector2D.hh.

     {
       return (getX() == vector.getX() && 
               getY() == vector.getY());
     }

double JGEOMETRY2D::JVector2D::getLengthSquared ( ) const

inlineinherited

Get length squared.

Returns: square of length

Definition at line 184 of file JVector2D.hh.

     { 
       return getX()*getX() + getY()*getY();
     }

double JGEOMETRY2D::JVector2D::getLength ( ) const

inlineinherited

Get length.

Returns: length

Definition at line 195 of file JVector2D.hh.

     { 
       return sqrt(getLengthSquared());
     }

double JGEOMETRY2D::JVector2D::getDistanceSquared ( const JVector2D & point ) const

inlineinherited

Get squared of distance to point.

Parameters

point point

Returns: square of distance

Definition at line 207 of file JVector2D.hh.

     {
       return JVector2D(point).sub(*this).getLengthSquared();
     }

double JGEOMETRY2D::JVector2D::getDistance ( const JVector2D & point ) const

inlineinherited

Get distance to point.

Parameters

point point

Returns: distance

Definition at line 219 of file JVector2D.hh.

     {
       return sqrt(getDistanceSquared(point));
     }

Friends And Related Function Documentation

std::istream& operator>>	(	std::istream &	in,
		JAnchor &	anchor
	)

friend

Read JAnchor from input.

Parameters

in	input stream
anchor	JAnchor

Returns: input stream

Definition at line 60 of file JAnchor.hh.

     {
       int    id;
       double x, y;
 
       if (in >> id >> x >> y)
         anchor = JAnchor(id, x, y);
 
       return in;
     }

std::ostream& operator<<	(	std::ostream &	out,
		const JAnchor &	anchor
	)

friend

Write JAnchor to output.

Parameters

out	output stream
anchor	JAnchor

Returns: output stream

Definition at line 79 of file JAnchor.hh.

     {
       out << anchor.getID();
       out << ' ';
       out << anchor.getX();
       out << ' ';
       out << anchor.getY();
 
       return out;
     }

Member Data Documentation

int JLANG::JObjectID::__id

protectedinherited

Definition at line 159 of file JObjectID.hh.

double JGEOMETRY2D::JVector2D::__x

protectedinherited

Definition at line 253 of file JVector2D.hh.

double JGEOMETRY2D::JVector2D::__y

protectedinherited

Definition at line 254 of file JVector2D.hh.

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

JAnchor.hh

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation