RealParameter Class Reference

Wraps a parameter of type double. More...

Inheritance diagram for RealParameter:

Collaboration diagram for RealParameter:

Public Member Functions
	RealParameter (const std::string &name, double *par, const std::string &parent_name="", const std::function< void()> &onChange=std::function< void()>(), const RealLimits &limits=RealLimits::limitless(), const Attributes &attr=Attributes::free())
virtual	~RealParameter ()=default
RealParameter *	clone (const std::string &new_name="") const
double &	getData () const
const std::string &	getName () const
bool	hasSameData (const IParameter &other)
	Returns true if two parameters are pointing to the same raw data. More...
virtual bool	isNull () const
	Returns true if wrapped parameter was not initialized with proper real value. More...
RealLimits	limits () const
void	setData (double &data)
RealParameter &	setLimited (double lower, double upper)
RealParameter &	setLimits (const RealLimits &limits)
RealParameter &	setNonnegative ()
RealParameter &	setPositive ()
RealParameter &	setUnit (const std::string &name)
void	setValue (double value)
	Sets value of wrapped parameter and emit signal. More...
std::string	unit () const
double	value () const
	Returns value of wrapped parameter. More...

Protected Member Functions
std::string	fullName () const
	For use in error messages. More...

Protected Attributes
Attributes	m_attr
double *	m_data
RealLimits	m_limits
const std::string	m_name
const std::function< void()>	m_onChange
const std::string	m_parent_name
Unit	m_unit

Detailed Description

Wraps a parameter of type double.

In addition to name and on-change callback held by the parent class IParameter, this class holds Limits, Attributes (currently only fixed or not), and a Unit.

Definition at line 31 of file RealParameter.h.

Constructor & Destructor Documentation

RealParameter()

RealParameter::RealParameter	(	const std::string &	name,
		double *	par,
		const std::string &	parent_name = "",
		const std::function< void()> &	onChange = std::function<void()>(),
		const RealLimits &	limits = RealLimits::limitless(),
		const Attributes &	attr = Attributes::free()
	)

Definition at line 18 of file RealParameter.cpp.

    : IParameter<double>(name, par, parent_name, onChange), m_limits(limits), m_attr(attr)
{
    if (!m_limits.isInRange(value())) {
        std::ostringstream message;
        message << "Cannot initialize parameter " << fullName() << " with value " << value()
                << ": out of bounds [" << limits << "]\n";
        throw std::runtime_error(message.str());
    }
}

References IParameter< double >::fullName(), RealLimits::isInRange(), limits(), m_limits, and value().

Referenced by clone().

Here is the call graph for this function:

~RealParameter()

virtual RealParameter::~RealParameter ( )

virtualdefault

Member Function Documentation

clone()

RealParameter * RealParameter::clone ( const std::string &  new_name = "" ) const

virtual

Implements IParameter< double >.

Definition at line 31 of file RealParameter.cpp.

{
    auto* ret = new RealParameter(new_name != "" ? new_name : getName(), m_data, m_parent_name,
                                  m_onChange, m_limits);
    ret->setUnit(unit());
    return ret;
}

References RealParameter(), IParameter< double >::getName(), IParameter< double >::m_data, m_limits, IParameter< double >::m_onChange, IParameter< double >::m_parent_name, and unit().

Referenced by ParameterPool::copyToExternalPool().

Here is the call graph for this function:

fullName()

std::string IParameter< double >::fullName ( ) const

inlineprotectedinherited

For use in error messages.

Definition at line 58 of file IParameter.h.

{ return m_parent_name + "/" + m_name; }

getData()

double & IParameter< double >::getData ( ) const

inlineinherited

Definition at line 41 of file IParameter.h.

{ return *m_data; }

getName()

const std::string& IParameter< double >::getName ( ) const

inlineinherited

Definition at line 49 of file IParameter.h.

{ return m_name; }

hasSameData()

bool IParameter< double >::hasSameData ( const IParameter< double > &  other )

inherited

Returns true if two parameters are pointing to the same raw data.

Definition at line 48 of file IParameter.h.

{
    return &getData() == &other.getData();
}

isNull()

virtual bool IParameter< double >::isNull ( ) const

inlinevirtualinherited

Returns true if wrapped parameter was not initialized with proper real value.

Definition at line 39 of file IParameter.h.

{ return m_data ? false : true; }

limits()

RealLimits RealParameter::limits

(

)

const

Definition at line 74 of file RealParameter.cpp.

{
    return m_limits;
}

References m_limits.

Referenced by RealParameter(), ParameterPool::report_set_value_error(), and setLimits().

setData()

void IParameter< double >::setData ( double &  data )

inlineinherited

Definition at line 42 of file IParameter.h.

    {
        m_data = &data;
        m_onChange();
    }

setLimited()

RealParameter & RealParameter::setLimited	(	double	lower,
		double	upper
	)

Definition at line 79 of file RealParameter.cpp.

{
    setLimits(RealLimits::limited(lower, upper));
    return *this;
}

References RealLimits::limited(), and setLimits().

Referenced by Beam::Beam().

Here is the call graph for this function:

setLimits()

RealParameter & RealParameter::setLimits

(

const RealLimits &

limits

)

Definition at line 68 of file RealParameter.cpp.

{
    m_limits = limits;
    return *this;
}

References limits(), and m_limits.

Referenced by DepthProbeSimulation::initialize(), SpecularSimulation::initialize(), setLimited(), setNonnegative(), and setPositive().

Here is the call graph for this function:

setNonnegative()

RealParameter & RealParameter::setNonnegative

(

)

Definition at line 91 of file RealParameter.cpp.

{
    setLimits(RealLimits::nonnegative());
    return *this;
}

References RealLimits::nonnegative(), and setLimits().

Referenced by Beam::Beam(), DetectionProperties::DetectionProperties(), IInterferenceFunction::IInterferenceFunction(), InterferenceFunction1DLattice::InterferenceFunction1DLattice(), InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(), InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(), InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(), InterferenceFunctionTwin::InterferenceFunctionTwin(), LayerRoughness::LayerRoughness(), MultiLayer::MultiLayer(), ResolutionFunction2DGaussian::ResolutionFunction2DGaussian(), and Layer::registerThickness().

Here is the call graph for this function:

setPositive()

RealParameter & RealParameter::setPositive

(

)

Definition at line 85 of file RealParameter.cpp.

{
    setLimits(RealLimits::positive());
    return *this;
}

References RealLimits::positive(), and setLimits().

Referenced by BasicLattice2D::BasicLattice2D(), HexagonalLattice2D::HexagonalLattice2D(), and SquareLattice2D::SquareLattice2D().

Here is the call graph for this function:

setUnit()

RealParameter & RealParameter::setUnit

(

const std::string &

name

)

Definition at line 97 of file RealParameter.cpp.

{
    if (!(name == "" || name == "nm" || name == "rad" || name == "nm^2"))
        throw std::runtime_error("RealParameter::setUnit() -> Error. Unexpected unit name " + name);
 
    m_unit.setUnit(name);
    return *this;
}

References m_unit, RealSpace::Particles::name(), and Unit::setUnit().

Referenced by BasicLattice2D::BasicLattice2D(), Beam::Beam(), HexagonalLattice2D::HexagonalLattice2D(), IInterferenceFunction::IInterferenceFunction(), InterferenceFunction1DLattice::InterferenceFunction1DLattice(), InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(), InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(), InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(), InterferenceFunctionTwin::InterferenceFunctionTwin(), Lattice2D::Lattice2D(), LayerRoughness::LayerRoughness(), MultiLayer::MultiLayer(), SquareLattice2D::SquareLattice2D(), Layer::registerThickness(), IParametricComponent::registerVector(), Lattice2D::setRotationEnabled(), and DistributionLogNormal::setUnits().

Here is the call graph for this function:

setValue()

void RealParameter::setValue

(

double

value

)

Sets value of wrapped parameter and emit signal.

Definition at line 39 of file RealParameter.cpp.

{
    if (value == *m_data)
        return; // nothing to do
 
    if (isNull())
        throw std::runtime_error("RealParameter::setValue() -> Error. Non-initialized parameter '"
                                 + fullName() + "'");
 
    if (!m_limits.isInRange(value)) {
        std::ostringstream message;
        message << "Cannot set parameter " << fullName() << " to value " << value
                << ": out of bounds [" << m_limits << "]\n";
        throw std::runtime_error(message.str());
    }
 
    if (m_attr.isFixed())
        throw std::runtime_error("Parameter " + fullName() + " is fixed");
 
    *m_data = value;
    if (m_onChange)
        m_onChange();
}

References IParameter< double >::fullName(), Attributes::isFixed(), RealLimits::isInRange(), IParameter< double >::isNull(), m_attr, IParameter< double >::m_data, m_limits, IParameter< double >::m_onChange, and value().

Here is the call graph for this function:

unit()

std::string RealParameter::unit

(

)

const

Definition at line 106 of file RealParameter.cpp.

{
    return m_unit.getName();
}

References Unit::getName(), and m_unit.

Referenced by clone(), ParameterUtils::poolParameterUnits(), and pyfmt2::valueTimesUnit().

Here is the call graph for this function:

value()

double RealParameter::value

(

)

const

Returns value of wrapped parameter.

Definition at line 63 of file RealParameter.cpp.

{
    return *m_data;
}

References IParameter< double >::m_data.

Referenced by RealParameter(), ParticleDistribution::generateParticles(), setValue(), and pyfmt2::valueTimesUnit().

Member Data Documentation

m_attr

Attributes RealParameter::m_attr

protected

Definition at line 59 of file RealParameter.h.

Referenced by setValue().

m_data

double * IParameter< double >::m_data

protectedinherited

Definition at line 53 of file IParameter.h.

m_limits

RealLimits RealParameter::m_limits

protected

Definition at line 58 of file RealParameter.h.

Referenced by RealParameter(), clone(), limits(), setLimits(), and setValue().

m_name

const std::string IParameter< double >::m_name

protectedinherited

Definition at line 52 of file IParameter.h.

m_onChange

const std::function<void()> IParameter< double >::m_onChange

protectedinherited

Definition at line 55 of file IParameter.h.

m_parent_name

const std::string IParameter< double >::m_parent_name

protectedinherited

Definition at line 54 of file IParameter.h.

m_unit

Unit RealParameter::m_unit

protected

Definition at line 60 of file RealParameter.h.

Referenced by setUnit(), and unit().

---

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

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