#include <SpacePoint.hpp>

Inheritance diagram for SpacePoint:

Public Member Functions
	SpacePoint (const ASpace *space=nullptr)

	SpacePoint (const SpacePoint &r)

	SpacePoint (const VectorDouble &coord, int iech=-1, const ASpace *space=nullptr)

SpacePoint &	operator= (const SpacePoint &r)

virtual	~SpacePoint ()

SpacePoint	spacePointOnSubspace (int ispace=-1) const

bool	operator== (const SpacePoint &v) const
	TODO : should aslo test the space definition. More...

constvect	getCoords () const

vect	getCoordRef ()

double	getCoord (int idim) const

void	setCoord (double coord)

void	setCoord (int i, double val)

void	setCoords (const VectorDouble &coord)

void	setCoords (const double *coord, int size)

void	setIech (int iech) const

int	getIech () const

void	setTarget (bool target) const

bool	isTarget () const

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, int ispace=-1) const
	Return the distance between me and another point. More...

VectorDouble	getDistances (const SpacePoint &pt) const
	Return all the distance (space composits) between me and another point. More...

VectorDouble	getIncrement (const SpacePoint &pt, int ispace=-1) 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 (int ispace=-1) const
	Shortcuts to ASpace methods. More...

const VectorDouble &	getOrigin (int ispace=-1) const
	Return the current space context origin coordinates. More...

double	getDistance (const SpacePoint &p1, const SpacePoint &p2, int ispace=0) const
	Return the distance between two space points for the current space context. More...

VectorDouble	getDistances (const SpacePoint &p1, const SpacePoint &p2) const
	Return all the distances (space composits) between two space points for the current space context. More...

VectorDouble	getIncrement (const SpacePoint &p1, const SpacePoint &p2, int ispace=0) 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,
		int	iech = `-1`,
		const ASpace *	space = `nullptr`
	)

◆ ~SpacePoint()

SpacePoint::~SpacePoint ( )

virtual

Member Function Documentation

◆ getCoord()

double SpacePoint::getCoord ( int idim ) const

◆ getCoordRef()

vect SpacePoint::getCoordRef ( )

inline

◆ getCoords()

constvect SpacePoint::getCoords ( ) const

◆ 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,
		int	ispace = `-1`
	)		const

Return the distance between me and another point.

◆ getDistances()

VectorDouble SpacePoint::getDistances ( const SpacePoint & pt ) const

Return all the distance (space composits) between me and another point.

◆ getIech()

int SpacePoint::getIech ( ) const

inline

◆ getIncrement()

VectorDouble SpacePoint::getIncrement	(	const SpacePoint &	pt,
		int	ispace = `-1`
	)		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.

◆ isTarget()

bool SpacePoint::isTarget ( ) const

inline

◆ 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

TODO : should aslo test the space definition.

◆ setCoord() [1/2]

void SpacePoint::setCoord ( double coord )

◆ setCoord() [2/2]

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 ?

◆ setCoords() [1/2]

void SpacePoint::setCoords	(	const double *	coord,
		int	size
	)

◆ setCoords() [2/2]

void SpacePoint::setCoords ( const VectorDouble & coord )

◆ setFFFF()

void SpacePoint::setFFFF ( )

Fill with TEST values to simulate a missing Space Point.

◆ setIech()

void SpacePoint::setIech ( int iech ) const

inline

◆ setTarget()

void SpacePoint::setTarget ( bool target ) const

inline

◆ spacePointOnSubspace()

SpacePoint SpacePoint::spacePointOnSubspace ( int ispace = -1 ) const

TODO : Memory copies

◆ 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

Public Member Functions

Constructor & Destructor Documentation

◆ SpacePoint() [1/3]

◆ SpacePoint() [2/3]

◆ SpacePoint() [3/3]

◆ ~SpacePoint()

Member Function Documentation

◆ getCoord()

◆ getCoordRef()

◆ getCoords()

◆ getCosineToDirection()

◆ getDistance()

◆ getDistances()

◆ getIech()

◆ getIncrement()

◆ getOrthogonalDistance()

◆ isConsistent()

◆ isFFFF()

◆ isTarget()

◆ move()

◆ operator=()

◆ operator==()

◆ setCoord() [1/2]

◆ setCoord() [2/2]

◆ setCoordFromAngle()

◆ setCoords() [1/2]

◆ setCoords() [2/2]

◆ setFFFF()

◆ setIech()

◆ setTarget()

◆ spacePointOnSubspace()

◆ toString()