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 |
| double | getCoord (int idim) const |
| void | setCoord (double coord) |
| void | setCoord (const VectorDouble &coord) |
| 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... | |
| VectorDouble | getIncrement (const SpacePoint &pt) const |
| Return the increment vector between me and another point. 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... | |
| 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 |
Protected Attributes | |
| VectorDouble | _coord |
| Points coordinates (whatever the space context) More... | |
| Protected Attributes inherited from ASpaceObject | |
| const ASpace * | _space |
| Current space context of the object. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from ASpaceObject | |
| void | setNDim (int ndim) |
| Modify the Space dimension of an already created item (To be used only during creation ... in particular when reading NF) More... | |
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()
|
virtual |
Member Function Documentation
◆ getCoord() [1/2]
|
inline |
◆ getCoord() [2/2]
|
inline |
◆ getDistance()
| double SpacePoint::getDistance | ( | const SpacePoint & | pt | ) | const |
Return the distance between me and another point.
◆ getIncrement()
| VectorDouble SpacePoint::getIncrement | ( | const SpacePoint & | pt | ) | const |
Return the increment vector between me and another point.
◆ isConsistent()
|
overridevirtual |
Return true if the point is consistent with the provided space.
Implements ASpaceObject.
◆ move()
| void SpacePoint::move | ( | const VectorDouble & | vec | ) |
Move me by the given vector.
◆ operator=()
| SpacePoint & SpacePoint::operator= | ( | const SpacePoint & | r | ) |
◆ operator==()
|
inline |
◆ setCoord() [1/2]
| void SpacePoint::setCoord | ( | double | coord | ) |
◆ setCoord() [2/2]
| void SpacePoint::setCoord | ( | const VectorDouble & | coord | ) |
◆ 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 ?
◆ toString()
|
overridevirtual |
Convert space point to string.
Reimplemented from ASpaceObject.
Member Data Documentation
◆ _coord
|
protected |
Points coordinates (whatever the space context)
The documentation for this class was generated from the following files:
- include/Space/SpacePoint.hpp
- src/Space/SpacePoint.cpp
