BoxClipGeometryDecorator Class Reference

#include <BoxClipGeometryDecorator.hpp>

Inheritance diagram for BoxClipGeometryDecorator:

Public Member Functions
int	dimension () const override
bool	inside (Position bfr) const override
double	maxX () const
double	maxY () const
double	maxZ () const
double	minX () const
double	minY () const
double	minZ () const
void	setupSelfBefore () override
Public Member Functions inherited from ClipGeometryDecorator
double	density (Position bfr) const override
Position	generatePosition () const override
Geometry *	geometry () const
Remove	remove () const
double	SigmaX () const override
double	SigmaY () const override
double	SigmaZ () const override
Public Member Functions inherited from SimulationItem
template<class T>
T *	find (bool setup=true) const
template<class T>
T *	interface (int levels=-999999, bool setup=true) const
virtual string	itemName () const
void	setup ()
string	typeAndName () const
Public Member Functions inherited from Item
	Item (const Item &)=delete
virtual	~Item ()
void	addChild (Item *child)
const vector< Item * > &	children () const
virtual void	clearItemListProperty (const PropertyDef *property)
void	destroyChild (Item *child)
virtual bool	getBoolProperty (const PropertyDef *property) const
virtual vector< double >	getDoubleListProperty (const PropertyDef *property) const
virtual double	getDoubleProperty (const PropertyDef *property) const
virtual string	getEnumProperty (const PropertyDef *property) const
virtual int	getIntProperty (const PropertyDef *property) const
virtual vector< Item * >	getItemListProperty (const PropertyDef *property) const
virtual Item *	getItemProperty (const PropertyDef *property) const
virtual string	getStringProperty (const PropertyDef *property) const
int	getUtilityProperty (string name) const
virtual void	insertIntoItemListProperty (const PropertyDef *property, int index, Item *item)
Item &	operator= (const Item &)=delete
Item *	parent () const
virtual void	removeFromItemListProperty (const PropertyDef *property, int index)
virtual void	setBoolProperty (const PropertyDef *property, bool value)
virtual void	setDoubleListProperty (const PropertyDef *property, vector< double > value)
virtual void	setDoubleProperty (const PropertyDef *property, double value)
virtual void	setEnumProperty (const PropertyDef *property, string value)
virtual void	setIntProperty (const PropertyDef *property, int value)
virtual void	setItemProperty (const PropertyDef *property, Item *item)
virtual void	setStringProperty (const PropertyDef *property, string value)
void	setUtilityProperty (string name, int value)
virtual string	type () const

Protected Member Functions
	BoxClipGeometryDecorator ()
Protected Member Functions inherited from ClipGeometryDecorator
	ClipGeometryDecorator ()
double	norm () const
void	setupSelfAfter () override
Protected Member Functions inherited from Geometry
	Geometry ()
Random *	random () const
void	setupSelfBefore () override
Protected Member Functions inherited from SimulationItem
	SimulationItem ()
virtual bool	offersInterface (const std::type_info &interfaceTypeInfo) const
Protected Member Functions inherited from Item
	Item ()

Private Types
using	BaseType
using	ItemType

Private Attributes
Box	_box
double	_maxX
double	_maxY
double	_maxZ
double	_minX
double	_minY
double	_minZ

Friends
class	ItemRegistry

Additional Inherited Members
Public Types inherited from ClipGeometryDecorator
enum class	Remove : int { Inside , Outside }

Detailed Description

The BoxClipGeometryDecorator class is a decorator that adjusts another geometry by setting the density equal to zero inside or outside a given cuboidal bounding box.

When an item of this type is used, the names provided by the conditional value expression "Dimension3" are inserted into the name sets used for evaluating Boolean expressions.

Constructor & Destructor Documentation

BoxClipGeometryDecorator()

BoxClipGeometryDecorator::BoxClipGeometryDecorator ( )

inlineprotected

Default constructor for concrete Item subclass BoxClipGeometryDecorator: "a decorator that clips another geometry using a cubodial box".

Member Function Documentation

dimension()

int BoxClipGeometryDecorator::dimension ( ) const

overridevirtual

This function returns the dimension of the geometry, which is 3 for this class since a box has no specific symmetry.

Implements Geometry.

inside()

bool BoxClipGeometryDecorator::inside ( Position bfr ) const

overridevirtual

This function returns true if the specified position is inside the box defined by the properties of this class.

Implements ClipGeometryDecorator.

maxX()

double BoxClipGeometryDecorator::maxX ( ) const

inline

This function returns the value of the discoverable double property maxX: "the end point of the box in the X direction".

This property represents a physical quantity of type "length".

maxY()

double BoxClipGeometryDecorator::maxY ( ) const

inline

This function returns the value of the discoverable double property maxY: "the end point of the box in the Y direction".

This property represents a physical quantity of type "length".

maxZ()

double BoxClipGeometryDecorator::maxZ ( ) const

inline

This function returns the value of the discoverable double property maxZ: "the end point of the box in the Z direction".

This property represents a physical quantity of type "length".

minX()

double BoxClipGeometryDecorator::minX ( ) const

inline

This function returns the value of the discoverable double property minX: "the start point of the box in the X direction".

This property represents a physical quantity of type "length".

minY()

double BoxClipGeometryDecorator::minY ( ) const

inline

This function returns the value of the discoverable double property minY: "the start point of the box in the Y direction".

This property represents a physical quantity of type "length".

minZ()

double BoxClipGeometryDecorator::minZ ( ) const

inline

This function returns the value of the discoverable double property minZ: "the start point of the box in the Z direction".

This property represents a physical quantity of type "length".

setupSelfBefore()

void BoxClipGeometryDecorator::setupSelfBefore ( )

overridevirtual

This function verifies that the box has a positive volume.

Reimplemented from SimulationItem.

---

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

• BoxClipGeometryDecorator.hpp