IParticle Class Reference

Pure virtual base class for Particle, ParticleComposition, ParticleCoreShell, MesoCrystal. More...

Inheritance diagram for IParticle:

Public Member Functions
IParticle *	clone () const override=0
	Returns a clone of this ISample object.
virtual IFormFactor *	createFormFactor () const
	Creates a form factor for this particle.
virtual SlicedParticle	createSlicedParticle (ZLimits limits) const
	Creates a sliced form factor for this particle.
kvector_t	position () const
	Returns particle position.
void	setPosition (kvector_t position)
	Sets relative position of the particle's reference point in the coordinate system of parent. More...
void	setPosition (double x, double y, double z)
	Sets relative position of the particle's reference point in the coordinate system of parent. More...
void	translate (kvector_t translation) override final
	Translates the particle.
const IRotation *	rotation () const
	Returns rotation object.
void	setRotation (const IRotation &rotation)
	Sets transformation.
void	rotate (const IRotation &rotation) override final
	Rotates the particle.
std::vector< const INode * >	getChildren () const override
	Returns a vector of children (const).
void	registerAbundance (bool make_registered=true)
void	registerPosition (bool make_registered=true)
	Registers the three components of its position.
virtual SafePointerVector< IParticle >	decompose () const
	Decompose in constituent IParticle objects.
virtual ParticleLimits	bottomTopZ () const
	Top and bottom z-coordinate.
Public Member Functions inherited from IAbstractParticle
	IAbstractParticle (const NodeMeta &meta, const std::vector< double > &PValues)
virtual void	accept (INodeVisitor *visitor) const
	Calls the INodeVisitor's visit method.
double	abundance () const
void	setAbundance (double abundance)
	Sets particle abundance. More...
Public Member Functions inherited from ISample
	ISample (const NodeMeta &meta, const std::vector< double > &PValues)
virtual const Material *	material () const
	Returns nullptr, unless overwritten to return a specific material.
std::vector< const Material * >	containedMaterials () const
	Returns set of unique materials contained in this ISample.
Public Member Functions inherited from ICloneable
	ICloneable (const ICloneable &)=delete
	ICloneable (ICloneable &&)=default
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py)
Public Member Functions inherited from INode
	INode (const NodeMeta &meta, const std::vector< double > &PValues)
virtual std::string	treeToString () const
	Returns multiline string representing tree structure below the node.
void	registerChild (INode *node)
virtual void	setParent (const INode *newParent)
const INode *	parent () const
INode *	parent ()
int	copyNumber (const INode *node) const
	Returns copyNumber of child, which takes into account existence of children with same name.
std::string	displayName () const
	Returns display name, composed from the name of node and it's copy number.
ParameterPool *	createParameterTree () const
	Creates new parameter pool, with all local parameters and those of its children.
Public Member Functions inherited from IParameterized
	IParameterized (const std::string &name="")
	IParameterized (const IParameterized &other)
IParameterized &	operator= (const IParameterized &other)=delete
ParameterPool *	parameterPool () const
	Returns pointer to the parameter pool.
std::string	parametersToString () const
	Returns multiline string representing available parameters.
RealParameter &	registerParameter (const std::string &name, double *parpointer)
void	registerVector (const std::string &base_name, kvector_t *p_vec, const std::string &units="nm")
void	setParameterValue (const std::string &name, double value)
void	setVectorValue (const std::string &base_name, kvector_t value)
RealParameter *	parameter (const std::string &name) const
	Returns parameter with given 'name'.
virtual void	onChange ()
	Action to be taken in inherited class when a parameter has changed.
void	removeParameter (const std::string &name)
void	removeVector (const std::string &base_name)
void	setName (const std::string &name)
const std::string &	getName () const

Protected Member Functions
IRotation *	createComposedRotation (const IRotation *p_rotation) const
	Creates a composed IRotation object.
kvector_t	composedTranslation (const IRotation *p_rotation, kvector_t translation) const
	Gets a composed translation vector.
void	registerParticleProperties ()
	Registers abundance and position.

Protected Attributes
kvector_t	m_position
std::unique_ptr< IRotation >	mP_rotation
Protected Attributes inherited from IAbstractParticle
double	m_abundance {1.0}
Protected Attributes inherited from INode
const size_t	m_NP
std::vector< double >	m_P

Additional Inherited Members
Static Public Member Functions inherited from IParameterized
static std::string	XComponentName (const std::string &base_name)
static std::string	YComponentName (const std::string &base_name)
static std::string	ZComponentName (const std::string &base_name)

Detailed Description

Pure virtual base class for Particle, ParticleComposition, ParticleCoreShell, MesoCrystal.

Provides position/rotation and form factor. Abundance is inherited from IAbstractParticle.

Definition at line 32 of file IParticle.h.

Member Function Documentation

setPosition() [1/2]

void IParticle::setPosition ( kvector_t  position )

inline

Sets relative position of the particle's reference point in the coordinate system of parent.

Parameters

position

relative position vector (components are in nanometers)

Definition at line 50 of file IParticle.h.

setPosition() [2/2]

void IParticle::setPosition ( double  x, double  y, double  z  )

inline

Sets relative position of the particle's reference point in the coordinate system of parent.

Parameters

x	x-coordinate in nanometers
y	y-coordinate in nanometers
z	z-coordinate in nanometers

Definition at line 57 of file IParticle.h.

---

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

• /home/www/ba/Sample/Particle/IParticle.h
• /home/www/ba/Sample/Particle/IParticle.cpp