From aec791564a6362d382f6a35a70416f5f6bce9799 Mon Sep 17 00:00:00 2001 From: "Joachim Wuttke (h)" <j.wuttke@fz-juelich.de> Date: Thu, 2 Dec 2021 22:53:42 +0100 Subject: [PATCH] regenerate --- auto/Wrap/doxygenParam.i | 3 - auto/Wrap/doxygenSample.i | 96 ++++++++------------------- auto/Wrap/libBornAgainSample.py | 32 ++++++--- auto/Wrap/libBornAgainSample_wrap.cpp | 30 +++++++-- 4 files changed, 73 insertions(+), 88 deletions(-) diff --git a/auto/Wrap/doxygenParam.i b/auto/Wrap/doxygenParam.i index d1b50863ef6..0bb00b3e70f 100644 --- a/auto/Wrap/doxygenParam.i +++ b/auto/Wrap/doxygenParam.i @@ -727,9 +727,6 @@ C++ includes: INodeVisitor.h %feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const HexagonalLattice2D *) "; -%feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const IAbstractParticle *) -"; - %feature("docstring") INodeVisitor::visit "virtual void INodeVisitor::visit(const IBornFF *) "; diff --git a/auto/Wrap/doxygenSample.i b/auto/Wrap/doxygenSample.i index 89cbd94c42e..a0b9d414534 100644 --- a/auto/Wrap/doxygenSample.i +++ b/auto/Wrap/doxygenSample.i @@ -2526,58 +2526,6 @@ C++ includes: Lattice2D.h "; -// File: classIAbstractParticle.xml -%feature("docstring") IAbstractParticle " - -Interface for a generic particle. - -Inherited by IParticle. - -C++ includes: IAbstractParticle.h -"; - -%feature("docstring") IAbstractParticle::IAbstractParticle "IAbstractParticle::IAbstractParticle()=default -"; - -%feature("docstring") IAbstractParticle::IAbstractParticle "IAbstractParticle::IAbstractParticle(const NodeMeta &meta, const std::vector< double > &PValues) -"; - -%feature("docstring") IAbstractParticle::~IAbstractParticle "IAbstractParticle::~IAbstractParticle() override=default -"; - -%feature("docstring") IAbstractParticle::clone "IAbstractParticle* IAbstractParticle::clone() const override=0 - -Returns a clone of this ISampleNode object. -"; - -%feature("docstring") IAbstractParticle::accept "void IAbstractParticle::accept(INodeVisitor *visitor) const override -"; - -%feature("docstring") IAbstractParticle::abundance "double IAbstractParticle::abundance() const -"; - -%feature("docstring") IAbstractParticle::setAbundance "void IAbstractParticle::setAbundance(double abundance) - -Sets particle abundance. - -Parameters: ------------ - -abundance: -proportion of this type of particles normalized to the total number of particles in the layout. -"; - -%feature("docstring") IAbstractParticle::translate "virtual void IAbstractParticle::translate(R3 translation)=0 - -Translates the particle with the given vector. -"; - -%feature("docstring") IAbstractParticle::rotate "virtual void IAbstractParticle::rotate(const IRotation &rotation)=0 - -Applies the given rotation to the particle. -"; - - // File: classIBornFF.xml %feature("docstring") IBornFF " @@ -3743,7 +3691,7 @@ Returns a clone of this ISampleNode object. // File: classIParticle.xml %feature("docstring") IParticle " -Abstract base class for Particle, ParticleComposition, ParticleCoreShell, MesoCrystal. Provides position/rotation and form factor. Abundance is inherited from IAbstractParticle. +Abstract base class for Particle, ParticleComposition, ParticleCoreShell, MesoCrystal. Provides position/rotation and form factor. Abundance is inherited from IParticle. C++ includes: IParticle.h "; @@ -3766,6 +3714,20 @@ Creates a form factor for this particle. Creates a sliced form factor for this particle. "; +%feature("docstring") IParticle::abundance "double IParticle::abundance() const +"; + +%feature("docstring") IParticle::setAbundance "void IParticle::setAbundance(double abundance) + +Sets particle abundance. + +Parameters: +----------- + +abundance: +proportion of this type of particles normalized to the total number of particles in the layout. +"; + %feature("docstring") IParticle::position "R3 IParticle::position() const Returns particle position. @@ -3799,7 +3761,7 @@ z: z-coordinate in nanometers "; -%feature("docstring") IParticle::translate "void IParticle::translate(R3 translation) override +%feature("docstring") IParticle::translate "void IParticle::translate(R3 translation) Translates the particle. "; @@ -3814,7 +3776,7 @@ Returns rotation object. Sets transformation. "; -%feature("docstring") IParticle::rotate "void IParticle::rotate(const IRotation &rotation) override +%feature("docstring") IParticle::rotate "void IParticle::rotate(const IRotation &rotation) Rotates the particle. "; @@ -5003,7 +4965,7 @@ C++ includes: ParticleLayout.h %feature("docstring") ParticleLayout::ParticleLayout "ParticleLayout::ParticleLayout() "; -%feature("docstring") ParticleLayout::ParticleLayout "ParticleLayout::ParticleLayout(const IAbstractParticle &particle, double abundance=-1.0) +%feature("docstring") ParticleLayout::ParticleLayout "ParticleLayout::ParticleLayout(const IParticle &particle, double abundance=-1.0) "; %feature("docstring") ParticleLayout::~ParticleLayout "ParticleLayout::~ParticleLayout() override @@ -5017,7 +4979,7 @@ Returns a clone of this ISampleNode object. %feature("docstring") ParticleLayout::accept "void ParticleLayout::accept(INodeVisitor *visitor) const override "; -%feature("docstring") ParticleLayout::addParticle "void ParticleLayout::addParticle(const IAbstractParticle &particle, double abundance=-1.0, R3 position={}, const IRotation &rotation=IdentityRotation()) +%feature("docstring") ParticleLayout::addParticle "void ParticleLayout::addParticle(const IParticle &particle, double abundance=-1.0, R3 position={}, const IRotation &rotation=IdentityRotation()) Adds particle to the layout with abundance, position and the rotation defined. @@ -5039,7 +5001,7 @@ rotation: %feature("docstring") ParticleLayout::particles "SafePointerVector< IParticle > ParticleLayout::particles() const -Returns information on all particles (type and abundance) and generates new particles if an IAbstractParticle denotes a collection +Returns information on all particles (type and abundance) and generates new particles if an IParticle denotes a collection "; %feature("docstring") ParticleLayout::interferenceFunction "const IInterference * ParticleLayout::interferenceFunction() const @@ -5475,25 +5437,25 @@ C++ includes: ZLimits.h // File: namespace_0d16.xml -// File: namespace_0d175.xml +// File: namespace_0d173.xml // File: namespace_0d2.xml -// File: namespace_0d203.xml +// File: namespace_0d201.xml -// File: namespace_0d216.xml +// File: namespace_0d214.xml -// File: namespace_0d226.xml +// File: namespace_0d224.xml -// File: namespace_0d248.xml +// File: namespace_0d246.xml -// File: namespace_0d261.xml +// File: namespace_0d259.xml // File: namespace_0d36.xml @@ -6408,12 +6370,6 @@ magnetization (in A/m) // File: FormFactorWeighted_8h.xml -// File: IAbstractParticle_8cpp.xml - - -// File: IAbstractParticle_8h.xml - - // File: IParticle_8cpp.xml diff --git a/auto/Wrap/libBornAgainSample.py b/auto/Wrap/libBornAgainSample.py index 99e6d042c59..e00d5737128 100644 --- a/auto/Wrap/libBornAgainSample.py +++ b/auto/Wrap/libBornAgainSample.py @@ -4395,7 +4395,7 @@ class IParticle(ISampleNode): r""" - Abstract base class for Particle, ParticleComposition, ParticleCoreShell, MesoCrystal. Provides position/rotation and form factor. Abundance is inherited from IAbstractParticle. + Abstract base class for Particle, ParticleComposition, ParticleCoreShell, MesoCrystal. Provides position/rotation and form factor. Abundance is inherited from IParticle. C++ includes: IParticle.h @@ -4439,11 +4439,27 @@ class IParticle(ISampleNode): return _libBornAgainSample.IParticle_createSlicedParticle(self, limits) def abundance(self): - r"""abundance(IParticle self) -> double""" + r""" + abundance(IParticle self) -> double + double IParticle::abundance() const + + """ return _libBornAgainSample.IParticle_abundance(self) def setAbundance(self, abundance): - r"""setAbundance(IParticle self, double abundance)""" + r""" + setAbundance(IParticle self, double abundance) + void IParticle::setAbundance(double abundance) + + Sets particle abundance. + + Parameters: + ----------- + + abundance: + proportion of this type of particles normalized to the total number of particles in the layout. + + """ return _libBornAgainSample.IParticle_setAbundance(self, abundance) def position(self): @@ -4482,7 +4498,7 @@ class IParticle(ISampleNode): def translate(self, translation): r""" translate(IParticle self, R3 translation) - void IParticle::translate(R3 translation) override + void IParticle::translate(R3 translation) Translates the particle. @@ -4512,7 +4528,7 @@ class IParticle(ISampleNode): def rotate(self, rotation): r""" rotate(IParticle self, IRotation rotation) - void IParticle::rotate(const IRotation &rotation) override + void IParticle::rotate(const IRotation &rotation) Rotates the particle. @@ -8203,7 +8219,7 @@ class ParticleLayout(ISampleNode): r""" __init__(ParticleLayout self) -> ParticleLayout __init__(ParticleLayout self, IParticle particle, double abundance=-1.0) -> ParticleLayout - ParticleLayout::ParticleLayout(const IAbstractParticle &particle, double abundance=-1.0) + ParticleLayout::ParticleLayout(const IParticle &particle, double abundance=-1.0) """ _libBornAgainSample.ParticleLayout_swiginit(self, _libBornAgainSample.new_ParticleLayout(*args)) @@ -8230,7 +8246,7 @@ class ParticleLayout(ISampleNode): def addParticle(self, *args): r""" addParticle(ParticleLayout self, IParticle particle, double abundance=-1.0, R3 position={}, IRotation rotation=IdentityRotation()) - void ParticleLayout::addParticle(const IAbstractParticle &particle, double abundance=-1.0, R3 position={}, const IRotation &rotation=IdentityRotation()) + void ParticleLayout::addParticle(const IParticle &particle, double abundance=-1.0, R3 position={}, const IRotation &rotation=IdentityRotation()) Adds particle to the layout with abundance, position and the rotation defined. @@ -8257,7 +8273,7 @@ class ParticleLayout(ISampleNode): particles(ParticleLayout self) -> SafePointerVector< IParticle > SafePointerVector< IParticle > ParticleLayout::particles() const - Returns information on all particles (type and abundance) and generates new particles if an IAbstractParticle denotes a collection + Returns information on all particles (type and abundance) and generates new particles if an IParticle denotes a collection """ return _libBornAgainSample.ParticleLayout_particles(self) diff --git a/auto/Wrap/libBornAgainSample_wrap.cpp b/auto/Wrap/libBornAgainSample_wrap.cpp index c4e4e3596ed..a5e5ef68faa 100644 --- a/auto/Wrap/libBornAgainSample_wrap.cpp +++ b/auto/Wrap/libBornAgainSample_wrap.cpp @@ -72527,8 +72527,24 @@ static PyMethodDef SwigMethods[] = { "Creates a sliced form factor for this particle. \n" "\n" ""}, - { "IParticle_abundance", _wrap_IParticle_abundance, METH_O, "IParticle_abundance(IParticle self) -> double"}, - { "IParticle_setAbundance", _wrap_IParticle_setAbundance, METH_VARARGS, "IParticle_setAbundance(IParticle self, double abundance)"}, + { "IParticle_abundance", _wrap_IParticle_abundance, METH_O, "\n" + "IParticle_abundance(IParticle self) -> double\n" + "double IParticle::abundance() const\n" + "\n" + ""}, + { "IParticle_setAbundance", _wrap_IParticle_setAbundance, METH_VARARGS, "\n" + "IParticle_setAbundance(IParticle self, double abundance)\n" + "void IParticle::setAbundance(double abundance)\n" + "\n" + "Sets particle abundance.\n" + "\n" + "Parameters:\n" + "-----------\n" + "\n" + "abundance: \n" + "proportion of this type of particles normalized to the total number of particles in the layout. \n" + "\n" + ""}, { "IParticle_position", _wrap_IParticle_position, METH_O, "\n" "IParticle_position(IParticle self) -> R3\n" "R3 IParticle::position() const\n" @@ -72558,7 +72574,7 @@ static PyMethodDef SwigMethods[] = { ""}, { "IParticle_translate", _wrap_IParticle_translate, METH_VARARGS, "\n" "IParticle_translate(IParticle self, R3 translation)\n" - "void IParticle::translate(R3 translation) override\n" + "void IParticle::translate(R3 translation)\n" "\n" "Translates the particle. \n" "\n" @@ -72579,7 +72595,7 @@ static PyMethodDef SwigMethods[] = { ""}, { "IParticle_rotate", _wrap_IParticle_rotate, METH_VARARGS, "\n" "IParticle_rotate(IParticle self, IRotation rotation)\n" - "void IParticle::rotate(const IRotation &rotation) override\n" + "void IParticle::rotate(const IRotation &rotation)\n" "\n" "Rotates the particle. \n" "\n" @@ -74667,7 +74683,7 @@ static PyMethodDef SwigMethods[] = { { "new_ParticleLayout", _wrap_new_ParticleLayout, METH_VARARGS, "\n" "ParticleLayout()\n" "ParticleLayout(IParticle particle, double abundance=-1.0)\n" - "ParticleLayout::ParticleLayout(const IAbstractParticle &particle, double abundance=-1.0)\n" + "ParticleLayout::ParticleLayout(const IParticle &particle, double abundance=-1.0)\n" "\n" ""}, { "delete_ParticleLayout", _wrap_delete_ParticleLayout, METH_O, "\n" @@ -74689,7 +74705,7 @@ static PyMethodDef SwigMethods[] = { ""}, { "ParticleLayout_addParticle", _wrap_ParticleLayout_addParticle, METH_VARARGS, "\n" "ParticleLayout_addParticle(ParticleLayout self, IParticle particle, double abundance=-1.0, R3 position={}, IRotation rotation=IdentityRotation())\n" - "void ParticleLayout::addParticle(const IAbstractParticle &particle, double abundance=-1.0, R3 position={}, const IRotation &rotation=IdentityRotation())\n" + "void ParticleLayout::addParticle(const IParticle &particle, double abundance=-1.0, R3 position={}, const IRotation &rotation=IdentityRotation())\n" "\n" "Adds particle to the layout with abundance, position and the rotation defined.\n" "\n" @@ -74713,7 +74729,7 @@ static PyMethodDef SwigMethods[] = { "ParticleLayout_particles(ParticleLayout self) -> SafePointerVector< IParticle >\n" "SafePointerVector< IParticle > ParticleLayout::particles() const\n" "\n" - "Returns information on all particles (type and abundance) and generates new particles if an IAbstractParticle denotes a collection \n" + "Returns information on all particles (type and abundance) and generates new particles if an IParticle denotes a collection \n" "\n" ""}, { "ParticleLayout_interferenceFunction", _wrap_ParticleLayout_interferenceFunction, METH_O, "\n" -- GitLab