SpacePoint Class Reference

#include <SpacePoint.hpp>

Inheritance diagram for SpacePoint:

Public Member Functions
	SpacePoint (const ASpace *space=nullptr)
	SpacePoint (const SpacePoint &r)
	SpacePoint (const VectorDouble &coord, const ASpace *space=nullptr)
SpacePoint &	operator= (const SpacePoint &r)
virtual	~SpacePoint ()
bool	operator== (const SpacePoint &v) const
const VectorDouble &	getCoord () const
VectorDouble &	getCoordRef ()
double	getCoord (int idim) const
void	setCoord (double coord)
void	setCoord (const VectorDouble &coord)
void	setCoord (int i, double val)
const double *	getCoordsP () const
double *	getCoordsPM ()
virtual bool	isConsistent (const ASpace *space) const override
	Return true if the point is consistent with the provided space. More...
void	move (const VectorDouble &vec)
	Move me by the given vector. More...
double	getDistance (const SpacePoint &pt) const
	Return the distance between me and another point. More...
double	getDistance1D (const SpacePoint &pt, int idim=0) const
	Return the distance along one direction between me and another point. More...
VectorDouble	getIncrement (const SpacePoint &pt) const
	Return the increment vector between me and another point. More...
void	setFFFF ()
	Fill with TEST values to simulate a missing Space Point. More...
bool	isFFFF () const
	Check if the SpacePoint is actually defined. More...
double	getCosineToDirection (const SpacePoint &T2, const VectorDouble &codir) const
	Return the cosine of the angle between the bipoint and a reference direction. More...
double	getOrthogonalDistance (const SpacePoint &P2, const VectorDouble &codir) const
	Return the orthogonal distance between a bipair and a reference direction. More...
void	setCoordFromAngle (const VectorDouble &angles)
	Initialize coordinates from angles /// TODO : to be removed. More...
virtual String	toString (const AStringFormat *strfmt=nullptr) const override
	Convert space point to string. More...
Public Member Functions inherited from ASpaceObject
	ASpaceObject (const ASpace *space=nullptr)
	ASpaceObject (const ASpace &space)
	ASpaceObject (const ASpaceObject &r)
ASpaceObject &	operator= (const ASpaceObject &r)
virtual	~ASpaceObject ()
const ASpace *	getSpace () const
	Accessor to the current object space context. More...
bool	isConsistent () const
	Indicate if I am consistent with my current space context. More...
VectorDouble	getUnitaryVector () const
	Return unitary vector for the current space context. More...
unsigned int	getNDim () const
	Shortcuts to ASpace methods. More...
const VectorDouble &	getOrigin () const
	Return the current space context origin coordinates. More...
double	getDistance (const SpacePoint &p1, const SpacePoint &p2) const
	Return the distance between two space points for the current space context. More...
double	getDistance1D (const SpacePoint &p1, const SpacePoint &p2, int idim) const
	Return the distance along one direction between two space points. More...
VectorDouble	getIncrement (const SpacePoint &p1, const SpacePoint &p2) const
	Return the increment vector between two space points for the current space context. More...
Public Member Functions inherited from AStringable
	AStringable ()
	AStringable (const AStringable &r)
AStringable &	operator= (const AStringable &r)
virtual	~AStringable ()
virtual void	display (const AStringFormat *strfmt=nullptr) const final
virtual void	display (int level) const final

Constructor & Destructor Documentation

SpacePoint() [1/3]

SpacePoint::SpacePoint

(

const ASpace *

space = nullptr

)

SpacePoint() [2/3]

SpacePoint::SpacePoint

(

const SpacePoint &

r

)

SpacePoint() [3/3]

SpacePoint::SpacePoint	(	const VectorDouble &	coord,
		const ASpace *	space = nullptr
	)

~SpacePoint()

SpacePoint::~SpacePoint ( )

virtual

Member Function Documentation

getCoord() [1/2]

const VectorDouble& SpacePoint::getCoord ( ) const

inline

getCoord() [2/2]

double SpacePoint::getCoord ( int  idim ) const

inline

getCoordRef()

VectorDouble& SpacePoint::getCoordRef ( )

inline

getCoordsP()

const double* SpacePoint::getCoordsP ( ) const

inline

getCoordsPM()

double* SpacePoint::getCoordsPM ( )

inline

getCosineToDirection()

double SpacePoint::getCosineToDirection	(	const SpacePoint &	T2,
		const VectorDouble &	codir
	)		const

Return the cosine of the angle between the bipoint and a reference direction.

getDistance()

double SpacePoint::getDistance

(

const SpacePoint &

pt

)

const

Return the distance between me and another point.

getDistance1D()

double SpacePoint::getDistance1D	(	const SpacePoint &	pt,
		int	idim = 0
	)		const

Return the distance along one direction between me and another point.

getIncrement()

VectorDouble SpacePoint::getIncrement

(

const SpacePoint &

pt

)

const

Return the increment vector between me and another point.

getOrthogonalDistance()

double SpacePoint::getOrthogonalDistance	(	const SpacePoint &	P2,
		const VectorDouble &	codir
	)		const

Return the orthogonal distance between a bipair and a reference direction.

isConsistent()

bool SpacePoint::isConsistent ( const ASpace *  space ) const

overridevirtual

Return true if the point is consistent with the provided space.

Implements ASpaceObject.

isFFFF()

bool SpacePoint::isFFFF

(

)

const

Check if the SpacePoint is actually defined.

move()

void SpacePoint::move

(

const VectorDouble &

vec

)

Move me by the given vector.

operator=()

SpacePoint & SpacePoint::operator=

(

const SpacePoint &

r

)

operator==()

bool SpacePoint::operator== ( const SpacePoint &  v ) const

inline

setCoord() [1/3]

void SpacePoint::setCoord

(

const VectorDouble &

coord

)

setCoord() [2/3]

void SpacePoint::setCoord

(

double

coord

)

setCoord() [3/3]

void SpacePoint::setCoord ( int  i, double  val  )

inline

setCoordFromAngle()

void SpacePoint::setCoordFromAngle

(

const VectorDouble &

angles

)

Initialize coordinates from angles /// TODO : to be removed.

Initialize point coordinates from angles

TODO : initialize coordinates from angles for more than 2D & valid only for space RN ? To be kept ?

setFFFF()

void SpacePoint::setFFFF

(

)

Fill with TEST values to simulate a missing Space Point.

toString()

String SpacePoint::toString ( const AStringFormat *  strfmt = nullptr ) const

overridevirtual

Convert space point to string.

Reimplemented from ASpaceObject.

Reimplemented in SpaceTarget.

---

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

• include/Space/SpacePoint.hpp
• src/Space/SpacePoint.cpp