IUnitConverter Class Reference

Interface to provide axis translations to different units for simulation output. More...

Inheritance diagram for IUnitConverter:

Collaboration diagram for IUnitConverter:

Public Member Functions
virtual	~IUnitConverter ()
virtual std::vector< Axes::Units >	availableUnits () const =0
std::string	axisName (size_t i_axis, Axes::Units units_type=Axes::Units::DEFAULT) const
virtual size_t	axisSize (size_t i_axis) const =0
virtual double	calculateMax (size_t i_axis, Axes::Units units_type) const =0
virtual double	calculateMin (size_t i_axis, Axes::Units units_type) const =0
virtual IUnitConverter *	clone () const =0
virtual std::unique_ptr< IAxis >	createConvertedAxis (size_t i_axis, Axes::Units units) const =0
virtual std::unique_ptr< OutputData< double > >	createConvertedData (const OutputData< double > &data, Axes::Units units) const
	Creates OutputData array in converter units. More...
virtual Axes::Units	defaultUnits () const =0
virtual size_t	dimension () const =0
Axes::Units	substituteDefaultUnits (Axes::Units units) const
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...

Protected Member Functions
void	checkIndex (size_t i_axis) const
void	throwUnitsError (std::string method, std::vector< Axes::Units > available) const

Private Member Functions
virtual std::vector< std::map< Axes::Units, std::string > >	createNameMaps () const =0

Detailed Description

Interface to provide axis translations to different units for simulation output.

Definition at line 46 of file IUnitConverter.h.

Constructor & Destructor Documentation

~IUnitConverter()

IUnitConverter::~IUnitConverter ( )

virtualdefault

Member Function Documentation

availableUnits()

virtual std::vector<Axes::Units> IUnitConverter::availableUnits ( ) const

pure virtual

Implemented in DepthProbeConverter, RectangularConverter, SphericalConverter, UnitConverterSimple, UnitConverterQSpec, and UnitConverterConvSpec.

Referenced by JobItemUtils::availableUnits(), and axisName().

axisName()

std::string IUnitConverter::axisName	(	size_t	i_axis,
		Axes::Units	units_type = Axes::Units::DEFAULT
	)		const

Definition at line 20 of file IUnitConverter.cpp.

{
    const auto& name_maps = createNameMaps();
    if (name_maps.size() <= i_axis)
        throw std::runtime_error("Error in IUnitConverter::axisName: the size of name map vector "
                                 "is smaller or equal to the axis index"
                                 + std::to_string(static_cast<int>(i_axis)));
    const auto& name_map = name_maps[i_axis];
    units_type = substituteDefaultUnits(units_type);
    const auto& it = name_map.find(units_type);
    if (it == name_map.cend())
        throwUnitsError("IUnitConverter::axisName", availableUnits());
    return it->second;
}

References availableUnits(), createNameMaps(), substituteDefaultUnits(), and throwUnitsError().

Referenced by DepthProbeConverter::DepthProbeConverter(), OffSpecularConverter::OffSpecularConverter(), UnitConverterConvSpec::UnitConverterConvSpec(), UnitConverterSimple::addDetectorAxis(), OffSpecularConverter::addDetectorYAxis(), UnitConverter1D::createConvertedAxis(), and UnitConverterSimple::createConvertedAxis().

Here is the call graph for this function:

axisSize()

virtual size_t IUnitConverter::axisSize ( size_t  i_axis ) const

pure virtual

Implemented in UnitConverterSimple, UnitConverterQSpec, and UnitConverterConvSpec.

calculateMax()

virtual double IUnitConverter::calculateMax ( size_t  i_axis, Axes::Units  units_type  ) const

pure virtual

Implemented in UnitConverterSimple, and UnitConverter1D.

calculateMin()

virtual double IUnitConverter::calculateMin ( size_t  i_axis, Axes::Units  units_type  ) const

pure virtual

Implemented in UnitConverterSimple, and UnitConverter1D.

checkIndex()

void IUnitConverter::checkIndex ( size_t  i_axis ) const

protected

Definition at line 46 of file IUnitConverter.cpp.

{
    if (i_axis < dimension())
        return;
    throw std::runtime_error("Error in IUnitConverter::checkIndex: passed axis index too big: "
                             + std::to_string(static_cast<int>(i_axis)));
}

References dimension().

Referenced by UnitConverterConvSpec::axisSize(), UnitConverterQSpec::axisSize(), UnitConverterSimple::axisSize(), UnitConverter1D::calculateMax(), UnitConverterSimple::calculateMax(), UnitConverter1D::calculateMin(), UnitConverterSimple::calculateMin(), and UnitConverter1D::createConvertedAxis().

Here is the call graph for this function:

clone()

virtual IUnitConverter* IUnitConverter::clone ( ) const

pure virtual

Implements ICloneable.

Implemented in UnitConverter1D, DepthProbeConverter, OffSpecularConverter, RectangularConverter, SphericalConverter, UnitConverterQSpec, and UnitConverterConvSpec.

createConvertedAxis()

virtual std::unique_ptr<IAxis> IUnitConverter::createConvertedAxis ( size_t  i_axis, Axes::Units  units  ) const

pure virtual

Implemented in UnitConverterSimple, and UnitConverter1D.

Referenced by createConvertedData(), and UnitConverterUtils::createOutputData().

createConvertedData()

std::unique_ptr< OutputData< double > > IUnitConverter::createConvertedData ( const OutputData< double > &  data, Axes::Units  units  ) const

virtual

Creates OutputData array in converter units.

Reimplemented in UnitConverter1D.

Definition at line 36 of file IUnitConverter.cpp.

{
    const size_t dim = data.rank();
    std::unique_ptr<OutputData<double>> result(new OutputData<double>);
    for (size_t i = 0; i < dim; ++i)
        result->addAxis(*createConvertedAxis(i, units));
    result->setRawDataVector(data.getRawDataVector());
    return result;
}

References createConvertedAxis(), OutputData< T >::getRawDataVector(), and OutputData< T >::rank().

Here is the call graph for this function:

createNameMaps()

virtual std::vector<std::map<Axes::Units, std::string> > IUnitConverter::createNameMaps ( ) const

privatepure virtual

Implemented in DepthProbeConverter, OffSpecularConverter, RectangularConverter, SphericalConverter, UnitConverterQSpec, and UnitConverterConvSpec.

Referenced by axisName().

defaultUnits()

virtual Axes::Units IUnitConverter::defaultUnits ( ) const

pure virtual

Implemented in DepthProbeConverter, OffSpecularConverter, RectangularConverter, SphericalConverter, UnitConverterQSpec, and UnitConverterConvSpec.

Referenced by UnitConverterSimple::addDetectorAxis(), JobItemUtils::availableUnits(), SimDataPair::initResultArrays(), and substituteDefaultUnits().

dimension()

virtual size_t IUnitConverter::dimension ( ) const

pure virtual

Implemented in UnitConverterSimple, and UnitConverter1D.

Referenced by checkIndex(), and UnitConverterUtils::createOutputData().

substituteDefaultUnits()

Axes::Units IUnitConverter::substituteDefaultUnits

(

Axes::Units

units

)

const

Definition at line 65 of file IUnitConverter.cpp.

{
    return units == Axes::Units::DEFAULT ? defaultUnits() : units;
}

References defaultUnits().

Referenced by axisName(), UnitConverter1D::calculateMax(), UnitConverterSimple::calculateMax(), UnitConverter1D::calculateMin(), UnitConverterSimple::calculateMin(), and UnitConverter1D::createConvertedAxis().

Here is the call graph for this function:

throwUnitsError()

void IUnitConverter::throwUnitsError ( std::string  method, std::vector< Axes::Units >  available  ) const

protected

Definition at line 54 of file IUnitConverter.cpp.

{
    std::stringstream ss;
    ss << "Unit type error in " << method
       << ": unknown or unsupported unit type. Available units "
          "are:\n";
    for (auto unit : available)
        ss << axisUnitLabel.at(unit) << "\n";
    throw std::runtime_error(ss.str());
}

References axisUnitLabel.

Referenced by axisName(), SphericalConverter::calculateValue(), RectangularConverter::calculateValue(), OffSpecularConverter::calculateValue(), DepthProbeConverter::checkUnits(), UnitConverterConvSpec::getTraslatorFrom(), UnitConverterConvSpec::getTraslatorTo(), and UnitConverterQSpec::getTraslatorTo().

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

Used for Python overriding of clone (see swig/tweaks.py)

Definition at line 34 of file ICloneable.h.

---

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

• /home/www/ba/Device/Unit/IUnitConverter.h
• /home/www/ba/Device/Unit/IUnitConverter.cpp