gstlrn::AShape Class Reference

#include <AShape.hpp>

Inheritance diagram for gstlrn::AShape:

Detailed Description

Class defining the generic shape of the objects for Boolean Model

Public Member Functions
	AShape ()
	AShape (const AShape &r)
AShape &	operator= (const AShape &r)
virtual	~AShape ()
String	toString (const AStringFormat *strfmt=nullptr) const override
	Interface to AStringable.
virtual EShape	getType () const =0
	Interface for AShape.
virtual Id	getNParams () const =0
virtual bool	getFlagCutZ () const =0
virtual BooleanObject *	generateObject (Id ndim=3)=0
virtual bool	belongObject (const 1 &coor, const BooleanObject *object) const =0
double	getFactorX2Y () const
double	getFactorX2Z () const
double	getFactorY2Z () const
double	getProportion () const
String	getParamName (Id ipar) const
double	getParam (Id ipar, Id iarg) const
const ShapeParameter &	getParam (Id ipar) const
void	setFactorX2Y (double factorX2Y)
void	setFactorX2Z (double factorX2Z)
void	setFactorY2Z (double factorY2Z)
void	setProportion (double proportion)
void	setParamName (Id ipar, const String &name)
void	setParam (Id ipar, Id iarg, double value)
void	setParamDefault (Id ipar, const String &name, double value)
void	setLaw (Id ipar, const ELaw &law)
void	initParams (Id count)
double	generateParam (Id ipar) 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
Public Member Functions inherited from gstlrn::ICloneable
	ICloneable ()
virtual	~ICloneable ()
virtual ICloneable *	clone () const =0
std::shared_ptr< ICloneable >	cloneShared () const
std::unique_ptr< ICloneable >	cloneUnique () const

Constructor & Destructor Documentation

AShape() [1/2]

gstlrn::AShape::AShape

(

)

AShape() [2/2]

gstlrn::AShape::AShape

(

const AShape &

r

)

~AShape()

gstlrn::AShape::~AShape ( )

virtual

Member Function Documentation

belongObject()

virtual bool gstlrn::AShape::belongObject ( const 1 &  coor, const BooleanObject *  object  ) const

pure virtual

Implemented in gstlrn::ShapeEllipsoid, gstlrn::ShapeHalfEllipsoid, gstlrn::ShapeHalfParaboloid, gstlrn::ShapeHalfSinusoid, gstlrn::ShapeParaboloid, and gstlrn::ShapeParallelepiped.

generateObject()

virtual BooleanObject * gstlrn::AShape::generateObject ( Id  ndim = 3 )

pure virtual

Implemented in gstlrn::ShapeEllipsoid, gstlrn::ShapeHalfEllipsoid, gstlrn::ShapeHalfParaboloid, gstlrn::ShapeHalfSinusoid, gstlrn::ShapeParaboloid, and gstlrn::ShapeParallelepiped.

generateParam()

double gstlrn::AShape::generateParam

(

Id

ipar

)

const

getFactorX2Y()

double gstlrn::AShape::getFactorX2Y ( ) const

inline

getFactorX2Z()

double gstlrn::AShape::getFactorX2Z ( ) const

inline

getFactorY2Z()

double gstlrn::AShape::getFactorY2Z ( ) const

inline

getFlagCutZ()

virtual bool gstlrn::AShape::getFlagCutZ ( ) const

pure virtual

Implemented in gstlrn::ShapeEllipsoid, gstlrn::ShapeHalfEllipsoid, gstlrn::ShapeHalfParaboloid, gstlrn::ShapeHalfSinusoid, gstlrn::ShapeParaboloid, and gstlrn::ShapeParallelepiped.

getNParams()

virtual Id gstlrn::AShape::getNParams ( ) const

pure virtual

Implemented in gstlrn::ShapeEllipsoid, gstlrn::ShapeHalfEllipsoid, gstlrn::ShapeHalfParaboloid, gstlrn::ShapeHalfSinusoid, gstlrn::ShapeParaboloid, and gstlrn::ShapeParallelepiped.

getParam() [1/2]

const ShapeParameter & gstlrn::AShape::getParam

(

Id

ipar

)

const

getParam() [2/2]

double gstlrn::AShape::getParam	(	Id	ipar,
		Id	iarg
	)		const

getParamName()

String gstlrn::AShape::getParamName

(

Id

ipar

)

const

getProportion()

double gstlrn::AShape::getProportion ( ) const

inline

getType()

virtual EShape gstlrn::AShape::getType ( ) const

pure virtual

Interface for AShape.

Implemented in gstlrn::ShapeEllipsoid, gstlrn::ShapeHalfEllipsoid, gstlrn::ShapeHalfParaboloid, gstlrn::ShapeHalfSinusoid, gstlrn::ShapeParaboloid, and gstlrn::ShapeParallelepiped.

initParams()

void gstlrn::AShape::initParams

(

Id

count

)

operator=()

AShape & gstlrn::AShape::operator=

(

const AShape &

r

)

setFactorX2Y()

void gstlrn::AShape::setFactorX2Y ( double  factorX2Y )

inline

setFactorX2Z()

void gstlrn::AShape::setFactorX2Z ( double  factorX2Z )

inline

setFactorY2Z()

void gstlrn::AShape::setFactorY2Z ( double  factorY2Z )

inline

setLaw()

void gstlrn::AShape::setLaw	(	Id	ipar,
		const ELaw &	law
	)

setParam()

void gstlrn::AShape::setParam	(	Id	ipar,
		Id	iarg,
		double	value
	)

setParamDefault()

void gstlrn::AShape::setParamDefault	(	Id	ipar,
		const String &	name,
		double	value
	)

setParamName()

void gstlrn::AShape::setParamName	(	Id	ipar,
		const String &	name
	)

setProportion()

void gstlrn::AShape::setProportion ( double  proportion )

inline

toString()

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

overridevirtual

Interface to AStringable.

Reimplemented from gstlrn::AStringable.

---

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

• include/Boolean/AShape.hpp
• src/Boolean/AShape.cpp