IParameterized Class Reference

Inheritance diagram for IParameterized:

Collaboration diagram for IParameterized:

Public Member Functions
	IParameterized (const std::string &name="")
	IParameterized (const IParameterized &other)
virtual	~IParameterized ()
IParameterized &	operator= (const IParameterized &other)=delete
ParameterPool *	parameterPool () const
virtual ParameterPool *	createParameterTree () const
std::string	parametersToString () const
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
virtual void	onChange ()
void	removeParameter (const std::string &name)
void	removeVector (const std::string &base_name)
void	setName (const std::string &name)
const std::string &	getName () const

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

Detailed Description

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

Definition at line 28 of file IParameterized.h.

Constructor & Destructor Documentation

IParameterized() [1/2]

IParameterized::IParameterized

(

const std::string &

name = ""

)

Definition at line 23 of file IParameterized.cpp.

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

IParameterized() [2/2]

IParameterized::IParameterized

(

const IParameterized &

other

)

Definition at line 25 of file IParameterized.cpp.

                                                          : IParameterized(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:

~IParameterized()

IParameterized::~IParameterized ( )

virtualdefault

Member Function Documentation

operator=()

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

delete

parameterPool()

ParameterPool* IParameterized::parameterPool ( ) const

inline

Returns pointer to the parameter pool.

Definition at line 38 of file IParameterized.h.

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

References m_pool.

Referenced by pyfmt2::argumentList(), SampleBuilderNode::borrow_builder_parameters(), INode::createParameterTree(), INode::INode(), IParameterized(), anonymous_namespace{NodeUtils.cpp}::poolToString(), SampleBuilderNode::reset(), and IDistribution1D::setUnits().

createParameterTree()

ParameterPool * IParameterized::createParameterTree ( ) const

virtual

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

Reimplemented in INode.

Definition at line 33 of file IParameterized.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:

parametersToString()

std::string IParameterized::parametersToString

(

)

const

Returns multiline string representing available parameters.

Definition at line 40 of file IParameterized.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 & IParameterized::registerParameter	(	const std::string &	name,
		double *	parpointer
	)

Definition at line 48 of file IParameterized.cpp.

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

References getName(), m_pool, and onChange().

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

Here is the call graph for this function:

registerVector()

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

Definition at line 54 of file IParameterized.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 registerParameter(), RealParameter::setUnit(), XComponentName(), YComponentName(), and ZComponentName().

Referenced by Beam::Beam(), DetectionProperties::DetectionProperties(), InterferenceFunctionTwin::InterferenceFunctionTwin(), MultiLayer::MultiLayer(), Lattice::registerBasisVectors(), and IParticle::registerPosition().

Here is the call graph for this function:

setParameterValue()

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

Definition at line 62 of file IParameterized.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, and ParameterPool::setMatchedParametersValue().

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

Here is the call graph for this function:

setVectorValue()

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

Definition at line 75 of file IParameterized.cpp.

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

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

Here is the call graph for this function:

parameter()

RealParameter * IParameterized::parameter

(

const std::string &

name

)

const

Returns parameter with given 'name'.

Definition at line 83 of file IParameterized.cpp.

{
    return m_pool->parameter(name);
}

References m_pool.

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

onChange()

virtual void IParameterized::onChange ( )

inlinevirtual

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

Reimplemented in IProfileRipple, 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, InterferenceFunction3DLattice, InterferenceFunction2DLattice, Lattice, and Lattice2D.

Definition at line 58 of file IParameterized.h.

{}

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

removeParameter()

void IParameterized::removeParameter

(

const std::string &

name

)

Definition at line 88 of file IParameterized.cpp.

{
    m_pool->removeParameter(name);
}

References m_pool.

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

removeVector()

void IParameterized::removeVector

(

const std::string &

base_name

)

Definition at line 93 of file IParameterized.cpp.

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

References removeParameter(), XComponentName(), YComponentName(), and ZComponentName().

Referenced by IParticle::registerPosition().

Here is the call graph for this function:

XComponentName()

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

static

Definition at line 100 of file IParameterized.cpp.

{
    return base_name + "X";
}

Referenced by Lattice::registerBasisVectors(), IParticle::registerPosition(), registerVector(), removeVector(), and setVectorValue().

YComponentName()

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

static

Definition at line 105 of file IParameterized.cpp.

{
    return base_name + "Y";
}

Referenced by registerVector(), removeVector(), and setVectorValue().

ZComponentName()

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

static

Definition at line 110 of file IParameterized.cpp.

{
    return base_name + "Z";
}

Referenced by registerVector(), removeVector(), and setVectorValue().

setName()

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

inline

Definition at line 68 of file IParameterized.h.

{ m_name = name; }

References m_name.

Referenced by BasicLattice::BasicLattice(), Beam::Beam(), Layer::clone(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), LayersWithAbsorptionBuilder::createSampleByIndex(), Basic2DParaCrystalBuilder::createSampleByIndex(), ParticleInVacuumBuilder::createSampleByIndex(), SimpleMagneticRotationBuilder::createSampleByIndex(), Crystal::Crystal(), DetectionProperties::DetectionProperties(), DistributionHandler::DistributionHandler(), FormFactorBAPol::FormFactorBAPol(), FormFactorCoreShell::FormFactorCoreShell(), FormFactorCrystal::FormFactorCrystal(), FormFactorDecoratorMaterial::FormFactorDecoratorMaterial(), FormFactorDecoratorPositionFactor::FormFactorDecoratorPositionFactor(), FormFactorDecoratorRotation::FormFactorDecoratorRotation(), FormFactorDWBA::FormFactorDWBA(), FormFactorDWBAPol::FormFactorDWBAPol(), FormFactorWeighted::FormFactorWeighted(), HexagonalLattice::HexagonalLattice(), IDetector::IDetector(), DepthProbeSimulation::initialize(), GISASSimulation::initialize(), OffSpecSimulation::initialize(), SpecularSimulation::initialize(), SpecularDetector1D::initialize(), MesoCrystal::initialize(), Particle::initialize(), ParticleComposition::initialize(), 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(), Lattice::Lattice(), Layer::Layer(), LayerInterface::LayerInterface(), LayerRoughness::LayerRoughness(), MultiLayer::MultiLayer(), Beam::operator=(), SampleBuilderNode::operator=(), ParticleCoreShell::ParticleCoreShell(), ParticleDistribution::ParticleDistribution(), ParticleLayout::ParticleLayout(), RectangularDetector::RectangularDetector(), SampleBuilderNode::reset(), ResolutionFunction2DGaussian::ResolutionFunction2DGaussian(), SampleBuilderNode::SampleBuilderNode(), SampleBuilderNode::setSBN(), SphericalDetector::SphericalDetector(), and SquareLattice::SquareLattice().

getName()

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

inline

Definition at line 69 of file IParameterized.h.

{ return m_name; }

References m_name.

Referenced by Beam::Beam(), Layer::clone(), IFormFactorBorn::computeSlicingEffects(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), INode::copyNumber(), createParameterTree(), IFormFactor::createSlicedFormFactor(), SampleToPython::defineFormFactors(), SampleToPython::defineInterferenceFunctions(), INode::displayName(), IDetector::IDetector(), Instrument::Instrument(), IParameterized(), Beam::operator=(), SampleBuilderNode::operator=(), anonymous_namespace{ParticleLayout.cpp}::particleDensityIsProvidedByInterference(), registerParameter(), SampleBuilderNode::SampleBuilderNode(), and IFormFactor::sliceFormFactor().

Member Data Documentation

m_name

std::string IParameterized::m_name

private

Definition at line 72 of file IParameterized.h.

Referenced by getName(), and setName().

m_pool

std::unique_ptr<ParameterPool> IParameterized::m_pool

private

parameter pool (kind of pointer-to-implementation)

Definition at line 73 of file IParameterized.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/IParameterized.h
• /home/www/ba/Param/Base/IParameterized.cpp