gstlrn::SpaceTarget Class Reference

#include <SpaceTarget.hpp>

Inheritance diagram for gstlrn::SpaceTarget:

Public Member Functions
	SpaceTarget (const ASpaceSharedPtr &space=ASpaceSharedPtr(), bool checkExtend=true, bool checkCode=true, bool checkDate=true)
	SpaceTarget (const SpaceTarget &r)
SpaceTarget &	operator= (const SpaceTarget &r)
virtual	~SpaceTarget ()
const SpacePoint &	getCoordAsSP () const
const &	getExtend () const
double	getExtend (Id idim) const
void	setExtend (const 1 &extend)
void	setExtend (Id i, double val)
const double *	getExtendP () const
double *	getExtendPM ()
void	setCode (double code)
void	setDate (double date)
double	getCode () const
double	getDate () const
bool	checkExtend () const
bool	checkCode () const
bool	checkDate () const
String	toString (const AStringFormat *strfmt=nullptr) const override
	Convert space point to string.
Public Member Functions inherited from gstlrn::SpacePoint
	SpacePoint (const ASpaceSharedPtr &space=ASpaceSharedPtr())
	SpacePoint (const SpacePoint &r)
	SpacePoint (const 1 &coord, Id iech=-1, const ASpaceSharedPtr &space=ASpaceSharedPtr())
SpacePoint &	operator= (const SpacePoint &r)
virtual	~SpacePoint ()
SpacePoint	spacePointOnSubspace (Id ispace=-1) const
bool	operator== (const SpacePoint &v) const
	TODO : should also test the space definition.
constvect	getCoordsView () const
vect	getCoordsView ()
const &	getCoords () const
&	getCoordsUnprotected ()
double	getCoord (Id idim) const
void	setCoord (double coord)
void	setCoord (Id i, double val)
void	setCoords (const 1 &coord)
void	setCoords (const double *coord, Id size)
void	setIech (Id iech) const
void	setProjected (bool status)
Id	getIech () const
bool	isProjected () const
bool	isConsistent (const ASpace *space) const override
	Return true if the point is consistent with the provided space.
void	move (const 1 &vec)
	Move me by the given vector.
double	getDistance (const SpacePoint &pt, Id ispace=-1) const
	Return the distance between 'this' and another point.
	getDistances (const SpacePoint &pt) const
	Return all the distance (space composits) between 'this' and another point.
	getIncrement (const SpacePoint &pt, Id ispace=-1) const
	Return the increment vector between 'this' and another point.
void	getIncrementInPlace (1 &inc, const SpacePoint &pt, Id ispace=-1) const
void	setFFFF ()
	Fill with TEST values to simulate a missing Space Point.
bool	isFFFF () const
	Check if the SpacePoint is actually defined.
double	getCosineToDirection (const SpacePoint &T2, const 1 &codir) const
	Return the cosine of the angle between the bipoint and a reference direction.
double	getOrthogonalDistance (const SpacePoint &P2, const 1 &codir) const
	Return the orthogonal distance between a bipair and a reference direction.
void	setCoordFromAngle (const 1 &angles)
	Initialize coordinates from angles /// TODO : to be removed.
Public Member Functions inherited from gstlrn::ASpaceObject
	ASpaceObject (const ASpaceSharedPtr &space=ASpaceSharedPtr())
	ASpaceObject (const ASpaceObject &r)
ASpaceObject &	operator= (const ASpaceObject &r)
virtual	~ASpaceObject ()
ASpaceSharedPtr	getSpace () const
	Accessor to the current object space context.
bool	isConsistent () const
	Indicate if I am consistent with my current space context.
void	setSpace (ASpaceSharedPtr &&space)
	getUnitaryVector () const
	Return unitary vector for the current space context.
bool	isConsistent (const ASpaceSharedPtr &space) const
	Indicate if I am consistent with the provided space.
size_t	getNDim (Id ispace=-1) const
	Shortcuts to ASpace methods.
const &	getOrigin (Id ispace=-1) const
	Return the current space context origin coordinates.
double	getDistance (const SpacePoint &p1, const SpacePoint &p2, Id ispace=0) const
	Return the distance between two space points for the current space context.
	getDistances (const SpacePoint &p1, const SpacePoint &p2) const
	Return all the distances (space composits) between two space points for the current space context.
	getIncrement (const SpacePoint &p1, const SpacePoint &p2, Id ispace=0) const
	Return the increment vector between two space points for the current space context.
void	getIncrementInPlace (const SpacePoint &p1, const SpacePoint &p2, 1 &ptemp, Id ispace=-1) const
Public Member Functions inherited from gstlrn::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 (Id level) const final

Static Public Member Functions
static SpaceTarget *	create (const 1 &center=1(), const 1 &extend=1(), double code=TEST, double date=TEST, const ASpaceSharedPtr &space=ASpaceSharedPtr())

Constructor & Destructor Documentation

SpaceTarget() [1/2]

gstlrn::SpaceTarget::SpaceTarget	(	const ASpaceSharedPtr &	space = ASpaceSharedPtr(),
		bool	checkExtend = true,
		bool	checkCode = true,
		bool	checkDate = true
	)

SpaceTarget() [2/2]

gstlrn::SpaceTarget::SpaceTarget

(

const SpaceTarget &

r

)

~SpaceTarget()

gstlrn::SpaceTarget::~SpaceTarget ( )

virtual

Member Function Documentation

checkCode()

bool gstlrn::SpaceTarget::checkCode ( ) const

inline

checkDate()

bool gstlrn::SpaceTarget::checkDate ( ) const

inline

checkExtend()

bool gstlrn::SpaceTarget::checkExtend ( ) const

inline

create()

SpaceTarget * gstlrn::SpaceTarget::create ( const 1 &  center = 1(), const 1 &  extend = 1(), double  code = TEST, double  date = TEST, const ASpaceSharedPtr &  space = ASpaceSharedPtr()  )

static

getCode()

double gstlrn::SpaceTarget::getCode ( ) const

inline

getCoordAsSP()

const SpacePoint & gstlrn::SpaceTarget::getCoordAsSP ( ) const

inline

getDate()

double gstlrn::SpaceTarget::getDate ( ) const

inline

getExtend() [1/2]

const & gstlrn::SpaceTarget::getExtend ( ) const

inline

getExtend() [2/2]

double gstlrn::SpaceTarget::getExtend ( Id  idim ) const

inline

getExtendP()

const double * gstlrn::SpaceTarget::getExtendP ( ) const

inline

getExtendPM()

double * gstlrn::SpaceTarget::getExtendPM ( )

inline

operator=()

SpaceTarget & gstlrn::SpaceTarget::operator=

(

const SpaceTarget &

r

)

setCode()

void gstlrn::SpaceTarget::setCode ( double  code )

inline

setDate()

void gstlrn::SpaceTarget::setDate ( double  date )

inline

setExtend() [1/2]

void gstlrn::SpaceTarget::setExtend ( const 1 &  extend )

inline

setExtend() [2/2]

void gstlrn::SpaceTarget::setExtend ( Id  i, double  val  )

inline

toString()

String gstlrn::SpaceTarget::toString ( const AStringFormat *  strfmt = nullptr ) const

overridevirtual

Convert space point to string.

Reimplemented from gstlrn::SpacePoint.

---

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

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