AShape Class Reference

#include <AShape.hpp>

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

Constructor & Destructor Documentation

AShape() [1/2]

AShape::AShape

(

)

AShape() [2/2]

AShape::AShape

(

const AShape &

r

)

~AShape()

AShape::~AShape ( )

virtual

Member Function Documentation

belongObject()

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

pure virtual

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

generateObject()

virtual BooleanObject * AShape::generateObject ( int  ndim = 3 )

pure virtual

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

generateParam()

double AShape::generateParam

(

int

ipar

)

const

getFactorX2Y()

double AShape::getFactorX2Y ( ) const

inline

getFactorX2Z()

double AShape::getFactorX2Z ( ) const

inline

getFactorY2Z()

double AShape::getFactorY2Z ( ) const

inline

getFlagCutZ()

virtual bool AShape::getFlagCutZ ( ) const

pure virtual

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

getNParams()

virtual int AShape::getNParams ( ) const

pure virtual

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

getParam() [1/2]

const ShapeParameter & AShape::getParam

(

int

ipar

)

const

getParam() [2/2]

double AShape::getParam	(	int	ipar,
		int	iarg
	)		const

getParamName()

String AShape::getParamName

(

int

ipar

)

const

getProportion()

double AShape::getProportion ( ) const

inline

getType()

virtual EShape AShape::getType ( ) const

pure virtual

Interface for AShape.

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

initParams()

void AShape::initParams

(

int

count

)

operator=()

AShape & AShape::operator=

(

const AShape &

r

)

setFactorX2Y()

void AShape::setFactorX2Y ( double  factorX2Y )

inline

setFactorX2Z()

void AShape::setFactorX2Z ( double  factorX2Z )

inline

setFactorY2Z()

void AShape::setFactorY2Z ( double  factorY2Z )

inline

setLaw()

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

setParam()

void AShape::setParam	(	int	ipar,
		int	iarg,
		double	value
	)

setParamDefault()

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

setParamName()

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

setProportion()

void AShape::setProportion ( double  proportion )

inline

toString()

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

overridevirtual

Interface to AStringable.

Reimplemented from AStringable.

---

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

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