IParametricComponent Class Reference

Manages a local parameter pool, and a tree of child pools. More...

Inheritance diagram for IParametricComponent:

Collaboration diagram for IParametricComponent:

Public Member Functions
	IParametricComponent (const IParametricComponent &other)
	IParametricComponent (const std::string &name="")
virtual	~IParametricComponent ()
virtual ParameterPool *	createParameterTree () const
	Creates new parameter pool, with all local parameters and those of its children. More...
const std::string &	getName () const
virtual void	onChange ()
	Action to be taken in inherited class when a parameter has changed. More...
IParametricComponent &	operator= (const IParametricComponent &other)=delete
RealParameter *	parameter (const std::string &name) const
	Returns parameter with given 'name'. More...
ParameterPool *	parameterPool () const
	Returns pointer to the parameter pool. More...
std::string	parametersToString () const
	Returns multiline string representing available parameters. More...
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	removeParameter (const std::string &name)
void	removeVector (const std::string &base_name)
void	setName (const std::string &name)
void	setParameterValue (const std::string &name, double value)
void	setVectorValue (const std::string &base_name, kvector_t value)

Static Public Member Functions
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)

Private Attributes
std::string	m_name
std::unique_ptr< ParameterPool >	m_pool
	parameter pool (kind of pointer-to-implementation) More...

Detailed Description

Manages a local parameter pool, and a tree of child pools.

Definition at line 30 of file IParametricComponent.h.

Constructor & Destructor Documentation

IParametricComponent() [1/2]

IParametricComponent::IParametricComponent

(

const std::string &

name = ""

)

Definition at line 22 of file IParametricComponent.cpp.

    : m_name{name}, m_pool{new ParameterPool}
{
}

IParametricComponent() [2/2]

IParametricComponent::IParametricComponent

(

const IParametricComponent &

other

)

Definition at line 27 of file IParametricComponent.cpp.

    : IParametricComponent(other.getName())
{
    if (!other.parameterPool()->empty())
        throw std::runtime_error("BUG: not prepared to copy parameters of " + getName());
}

References ParameterPool::empty(), getName(), and parameterPool().

Here is the call graph for this function:

~IParametricComponent()

IParametricComponent::~IParametricComponent ( )

virtualdefault

Member Function Documentation

createParameterTree()

ParameterPool * IParametricComponent::createParameterTree ( ) const

virtual

Creates new parameter pool, with all local parameters and those of its children.

Reimplemented in INode.

Definition at line 36 of file IParametricComponent.cpp.

{
    auto* result = new ParameterPool;
    m_pool->copyToExternalPool("/" + getName() + "/", result);
    return result;
}

References getName(), and m_pool.

Referenced by parametersToString(), ParameterUtils::poolParameterUnits(), and setParameterValue().

Here is the call graph for this function:

getName()

const std::string& IParametricComponent::getName ( ) const

inline

Definition at line 70 of file IParametricComponent.h.

{ return m_name; }

References m_name.

Referenced by Beam::Beam(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), IDetector::IDetector(), Instrument::Instrument(), IParametricComponent(), SampleBuilderNode::SampleBuilderNode(), Layer::clone(), INode::copyNumber(), createParameterTree(), IFormFactor::createSlicedFormFactor(), SampleToPython::defineInterferenceFunctions(), INode::displayName(), Beam::operator=(), SampleBuilderNode::operator=(), GUIObjectBuilder::populateInstrumentModel(), PyImportAssistant::populateModels(), GUIDomainSampleVisitor::populateSampleModel(), registerParameter(), IFormFactor::sliceFormFactor(), and GUIDomainSampleVisitor::visit().

onChange()

virtual void IParametricComponent::onChange ( )

inlinevirtual

Action to be taken in inherited class when a parameter has changed.

Reimplemented in IProfileRipple, Lattice3D, InterferenceFunction3DLattice, InterferenceFunction2DLattice, FormFactorSphereLogNormalRadius, FormFactorSphereGaussianRadius, FormFactorGaussSphere, ISawtoothRipple, ICosineRipple, IProfileRectangularRipple, FormFactorTruncatedSpheroid, FormFactorTruncatedSphere, FormFactorTruncatedCube, FormFactorTetrahedron, FormFactorPyramid, FormFactorPrism6, FormFactorPrism3, FormFactorLongBoxLorentz, FormFactorLongBoxGauss, FormFactorIcosahedron, FormFactorHollowSphere, FormFactorHemiEllipsoid, FormFactorFullSpheroid, FormFactorFullSphere, FormFactorEllipsoidalCylinder, FormFactorDodecahedron, FormFactorCylinder, FormFactorCuboctahedron, FormFactorCone6, FormFactorCone, FormFactorCantellatedCube, FormFactorBox, FormFactorAnisoPyramid, and Lattice2D.

Definition at line 59 of file IParametricComponent.h.

{}

Referenced by Lattice2D::onChange(), and registerParameter().

operator=()

IParametricComponent& IParametricComponent::operator= ( const IParametricComponent &  other )

delete

parameter()

RealParameter * IParametricComponent::parameter

(

const std::string &

name

)

const

Returns parameter with given 'name'.

Definition at line 86 of file IParametricComponent.cpp.

{
    return m_pool->parameter(name);
}

References m_pool, and RealSpace::Particles::name().

Referenced by DepthProbeSimulation::initialize(), SpecularSimulation::initialize(), Lattice3D::initialize(), IParticle::registerAbundance(), ParticleLayout::registerParticleDensity(), IParticle::registerPosition(), Layer::registerThickness(), Lattice2D::setRotationEnabled(), and DistributionLogNormal::setUnits().

Here is the call graph for this function:

parameterPool()

ParameterPool* IParametricComponent::parameterPool ( ) const

inline

Returns pointer to the parameter pool.

Definition at line 39 of file IParametricComponent.h.

{ return m_pool.get(); } // has non-const usages!

References m_pool.

Referenced by INode::INode(), IParametricComponent(), pyfmt2::argumentList(), SampleBuilderNode::borrow_builder_parameters(), SampleBuilderNode::reset(), and IDistribution1D::setUnits().

parametersToString()

std::string IParametricComponent::parametersToString

(

)

const

Returns multiline string representing available parameters.

Definition at line 43 of file IParametricComponent.cpp.

{
    std::ostringstream result;
    std::unique_ptr<ParameterPool> P_pool(createParameterTree());
    result << *P_pool << "\n";
    return result.str();
}

References createParameterTree().

Here is the call graph for this function:

registerParameter()

RealParameter & IParametricComponent::registerParameter	(	const std::string &	name,
		double *	parpointer
	)

Definition at line 51 of file IParametricComponent.cpp.

{
    return m_pool->addParameter(
        new RealParameter(name, data, getName(), [&]() -> void { onChange(); }));
}

References getName(), m_pool, RealSpace::Particles::name(), and onChange().

Referenced by BasicLattice2D::BasicLattice2D(), Beam::Beam(), CylindersInBABuilder::CylindersInBABuilder(), DetectionProperties::DetectionProperties(), HexagonalLattice2D::HexagonalLattice2D(), IInterferenceFunction::IInterferenceFunction(), INode::INode(), InterferenceFunction1DLattice::InterferenceFunction1DLattice(), InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(), InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(), InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(), InterferenceFunctionTwin::InterferenceFunctionTwin(), Lattice2D::Lattice2D(), LayerRoughness::LayerRoughness(), MultiLayer::MultiLayer(), ParticleDistribution::ParticleDistribution(), PlainMultiLayerBySLDBuilder::PlainMultiLayerBySLDBuilder(), ResolutionFunction2DGaussian::ResolutionFunction2DGaussian(), ResonatorBuilder::ResonatorBuilder(), SquareLattice2D::SquareLattice2D(), TriangularRippleBuilder::TriangularRippleBuilder(), IParticle::registerAbundance(), ParticleLayout::registerParticleDensity(), Layer::registerThickness(), registerVector(), ParticleLayout::registerWeight(), and Lattice2D::setRotationEnabled().

Here is the call graph for this function:

registerVector()

void IParametricComponent::registerVector	(	const std::string &	base_name,
		kvector_t *	p_vec,
		const std::string &	units = "nm"
	)

Definition at line 57 of file IParametricComponent.cpp.

{
    registerParameter(XComponentName(base_name), &((*p_vec)[0])).setUnit(units);
    registerParameter(YComponentName(base_name), &((*p_vec)[1])).setUnit(units);
    registerParameter(ZComponentName(base_name), &((*p_vec)[2])).setUnit(units);
}

References ModelView::Utils::base_name(), registerParameter(), RealParameter::setUnit(), XComponentName(), YComponentName(), and ZComponentName().

Referenced by Beam::Beam(), DetectionProperties::DetectionProperties(), InterferenceFunctionTwin::InterferenceFunctionTwin(), MultiLayer::MultiLayer(), Lattice3D::initialize(), and IParticle::registerPosition().

Here is the call graph for this function:

removeParameter()

void IParametricComponent::removeParameter

(

const std::string &

name

)

Definition at line 91 of file IParametricComponent.cpp.

{
    m_pool->removeParameter(name);
}

References m_pool, and RealSpace::Particles::name().

Referenced by IParticle::registerAbundance(), ParticleLayout::registerParticleDensity(), Layer::registerThickness(), removeVector(), and Lattice2D::setRotationEnabled().

Here is the call graph for this function:

removeVector()

void IParametricComponent::removeVector

(

const std::string &

base_name

)

Definition at line 96 of file IParametricComponent.cpp.

{
    removeParameter(XComponentName(base_name));
    removeParameter(YComponentName(base_name));
    removeParameter(ZComponentName(base_name));
}

References ModelView::Utils::base_name(), removeParameter(), XComponentName(), YComponentName(), and ZComponentName().

Referenced by IParticle::registerPosition().

Here is the call graph for this function:

setName()

void IParametricComponent::setName ( const std::string &  name )

inline

Definition at line 69 of file IParametricComponent.h.

{ m_name = name; }

References m_name, and RealSpace::Particles::name().

Referenced by BasicLattice2D::BasicLattice2D(), Beam::Beam(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), Crystal::Crystal(), DetectionProperties::DetectionProperties(), DistributionHandler::DistributionHandler(), FormFactorCoreShell::FormFactorCoreShell(), FormFactorCrystal::FormFactorCrystal(), FormFactorDecoratorMaterial::FormFactorDecoratorMaterial(), FormFactorDecoratorPositionFactor::FormFactorDecoratorPositionFactor(), FormFactorDecoratorRotation::FormFactorDecoratorRotation(), FormFactorWeighted::FormFactorWeighted(), HexagonalLattice2D::HexagonalLattice2D(), IDetector::IDetector(), INode::INode(), Instrument::Instrument(), InterferenceFunction1DLattice::InterferenceFunction1DLattice(), InterferenceFunction2DLattice::InterferenceFunction2DLattice(), InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(), InterferenceFunction2DSuperLattice::InterferenceFunction2DSuperLattice(), InterferenceFunction3DLattice::InterferenceFunction3DLattice(), InterferenceFunctionFinite2DLattice::InterferenceFunctionFinite2DLattice(), InterferenceFunctionFinite3DLattice::InterferenceFunctionFinite3DLattice(), InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(), InterferenceFunctionNone::InterferenceFunctionNone(), InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(), InterferenceFunctionTwin::InterferenceFunctionTwin(), ISampleBuilder::ISampleBuilder(), IsGISAXSDetector::IsGISAXSDetector(), Lattice3D::Lattice3D(), Layer::Layer(), LayerInterface::LayerInterface(), LayerRoughness::LayerRoughness(), MultiLayer::MultiLayer(), ParticleCoreShell::ParticleCoreShell(), ParticleDistribution::ParticleDistribution(), ParticleLayout::ParticleLayout(), RectangularDetector::RectangularDetector(), ResolutionFunction2DGaussian::ResolutionFunction2DGaussian(), SampleBuilderNode::SampleBuilderNode(), SphericalDetector::SphericalDetector(), SquareLattice2D::SquareLattice2D(), Layer::clone(), LayersWithAbsorptionBuilder::createSampleByIndex(), Basic2DParaCrystalBuilder::createSampleByIndex(), ParticleInVacuumBuilder::createSampleByIndex(), SimpleMagneticRotationBuilder::createSampleByIndex(), DepthProbeSimulation::initialize(), GISASSimulation::initialize(), OffSpecularSimulation::initialize(), SpecularSimulation::initialize(), SpecularDetector1D::initialize(), MesoCrystal::initialize(), Particle::initialize(), ParticleComposition::initialize(), Beam::operator=(), SampleBuilderNode::operator=(), SampleBuilderNode::reset(), and SampleBuilderNode::setSBN().

Here is the call graph for this function:

setParameterValue()

void IParametricComponent::setParameterValue	(	const std::string &	name,
		double	value
	)

Definition at line 65 of file IParametricComponent.cpp.

{
    if (name.find('*') == std::string::npos && name.find('/') == std::string::npos) {
        m_pool->setParameterValue(name, value);
    } else {
        std::unique_ptr<ParameterPool> P_pool{createParameterTree()};
        if (name.find('*') != std::string::npos)
            P_pool->setMatchedParametersValue(name, value);
        else
            P_pool->setParameterValue(name, value);
    }
}

References createParameterTree(), m_pool, RealSpace::Particles::name(), and ParameterPool::setMatchedParametersValue().

Referenced by AsymRippleBuilder::buildSample(), and setVectorValue().

Here is the call graph for this function:

setVectorValue()

void IParametricComponent::setVectorValue	(	const std::string &	base_name,
		kvector_t	value
	)

Definition at line 78 of file IParametricComponent.cpp.

{
    setParameterValue(XComponentName(base_name), value.x());
    setParameterValue(YComponentName(base_name), value.y());
    setParameterValue(ZComponentName(base_name), value.z());
}

References ModelView::Utils::base_name(), setParameterValue(), BasicVector3D< T >::x(), XComponentName(), BasicVector3D< T >::y(), YComponentName(), BasicVector3D< T >::z(), and ZComponentName().

Here is the call graph for this function:

XComponentName()

std::string IParametricComponent::XComponentName ( const std::string &  base_name )

static

Definition at line 103 of file IParametricComponent.cpp.

{
    return base_name + "X";
}

References ModelView::Utils::base_name().

Referenced by Lattice3D::initialize(), IParticle::registerPosition(), registerVector(), removeVector(), setVectorValue(), and VectorParameterTranslator::translate().

Here is the call graph for this function:

YComponentName()

std::string IParametricComponent::YComponentName ( const std::string &  base_name )

static

Definition at line 108 of file IParametricComponent.cpp.

{
    return base_name + "Y";
}

References ModelView::Utils::base_name().

Referenced by registerVector(), removeVector(), setVectorValue(), and VectorParameterTranslator::translate().

Here is the call graph for this function:

ZComponentName()

std::string IParametricComponent::ZComponentName ( const std::string &  base_name )

static

Definition at line 113 of file IParametricComponent.cpp.

{
    return base_name + "Z";
}

References ModelView::Utils::base_name().

Referenced by registerVector(), removeVector(), setVectorValue(), and VectorParameterTranslator::translate().

Here is the call graph for this function:

Member Data Documentation

m_name

std::string IParametricComponent::m_name

private

Definition at line 73 of file IParametricComponent.h.

Referenced by getName(), and setName().

m_pool

std::unique_ptr<ParameterPool> IParametricComponent::m_pool

private

parameter pool (kind of pointer-to-implementation)

Definition at line 74 of file IParametricComponent.h.

Referenced by createParameterTree(), parameter(), parameterPool(), registerParameter(), removeParameter(), and setParameterValue().

---

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

• /home/www/ba/Param/Base/IParametricComponent.h
• /home/www/ba/Param/Base/IParametricComponent.cpp