1.4.0
CCC
 
ASpaceObject Class Referenceabstract

#include <ASpaceObject.hpp>

Inheritance diagram for ASpaceObject:
AStringable ACov ANeigh CovContext DirParam SpacePoint ACovAnisoList CovAniso NeighBench NeighCell NeighImage NeighMoving NeighUnique SpaceTarget

Detailed Description

This class is the base class for all objects that need to know what is its space definition. All ASpaceObject can access to the number of space dimensions and can ask to calculate a distance between two ASpaceObjects.

This class also stores a unique (static) default global space that will be used as default space when creating a ASpaceObject (without a predefined space). It is possible to modify the default space definition at any time. Space definition of pre-existing ASpaceObjects remains the same. (no more shared pointer)

Public Member Functions

 ASpaceObject (const ASpace *space=nullptr)
 
 ASpaceObject (const ASpace &space)
 
 ASpaceObject (const ASpaceObject &r)
 
ASpaceObjectoperator= (const ASpaceObject &r)
 
virtual ~ASpaceObject ()
 
virtual String toString (const AStringFormat *strfmt=nullptr) const override
 AStringable interface. More...
 
const ASpacegetSpace () 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...
 
virtual bool isConsistent (const ASpace *space) const =0
 Indicate if I am consistent with the provided space. More...
 
unsigned int getNDim (int ispace=-1) const
 Shortcuts to ASpace methods. More...
 
const VectorDoublegetOrigin (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...
 
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, 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)
 
AStringableoperator= (const AStringable &r)
 
virtual ~AStringable ()
 
virtual void display (const AStringFormat *strfmt=nullptr) const final
 
virtual void display (int level) const final
 

Constructor & Destructor Documentation

◆ ASpaceObject() [1/3]

ASpaceObject::ASpaceObject ( const ASpace space = nullptr)

◆ ASpaceObject() [2/3]

ASpaceObject::ASpaceObject ( const ASpace space)

◆ ASpaceObject() [3/3]

ASpaceObject::ASpaceObject ( const ASpaceObject r)

◆ ~ASpaceObject()

ASpaceObject::~ASpaceObject ( )
virtual

Member Function Documentation

◆ getDistance()

double ASpaceObject::getDistance ( const SpacePoint p1,
const SpacePoint p2,
int  ispace = 0 
) const

Return the distance between two space points for the current space context.

◆ getDistance1D()

double ASpaceObject::getDistance1D ( const SpacePoint p1,
const SpacePoint p2,
int  idim 
) const

Return the distance along one direction between two space points.

◆ getDistances()

VectorDouble ASpaceObject::getDistances ( const SpacePoint p1,
const SpacePoint p2 
) const

Return all the distances (space composits) between two space points for the current space context.

◆ getIncrement()

VectorDouble ASpaceObject::getIncrement ( const SpacePoint p1,
const SpacePoint p2,
int  ispace = 0 
) const

Return the increment vector between two space points for the current space context.

◆ getNDim()

unsigned int ASpaceObject::getNDim ( int  ispace = -1) const

Shortcuts to ASpace methods.

Return the number of dimension of the current space context

◆ getOrigin()

const VectorDouble & ASpaceObject::getOrigin ( int  ispace = -1) const

Return the current space context origin coordinates.

◆ getSpace()

const ASpace* ASpaceObject::getSpace ( ) const
inline

Accessor to the current object space context.

◆ getUnitaryVector()

VectorDouble ASpaceObject::getUnitaryVector ( ) const

Return unitary vector for the current space context.

◆ isConsistent() [1/2]

bool ASpaceObject::isConsistent ( ) const
inline

Indicate if I am consistent with my current space context.

◆ isConsistent() [2/2]

virtual bool ASpaceObject::isConsistent ( const ASpace space) const
pure virtual

Indicate if I am consistent with the provided space.

Implemented in DirParam, SpacePoint, ANeigh, CovContext, CovAniso, and ACovAnisoList.

◆ operator=()

ASpaceObject & ASpaceObject::operator= ( const ASpaceObject r)

◆ toString()

String ASpaceObject::toString ( const AStringFormat strfmt = nullptr) const
overridevirtual

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