ImportDataInfo Class Reference

Description

Carries information about loaded data.

Definition at line 26 of file ImportDataInfo.h.

Collaboration diagram for ImportDataInfo:

Public Member Functions
	ImportDataInfo (Datafield &&data, Coords units)
	ImportDataInfo (ImportDataInfo &&other)
	ImportDataInfo (std::unique_ptr< Datafield > data, const QString &units)
	ImportDataInfo (std::unique_ptr< Datafield > data, Coords units)
	~ImportDataInfo ()
QString	axisLabel (size_t axis_index) const
std::unique_ptr< Datafield >	clonedData () const &
size_t	dataRank () const
	Returns number of dimensions. More...
std::unique_ptr< Datafield >	intensityData () &&
	operator bool () const
	True if the contained data is not nullptr (no info about empty data) More...
QString	unitsLabel () const

Private Member Functions
void	checkValidity ()

Private Attributes
const Coords	m_coords
std::unique_ptr< Datafield >	m_data

Constructor & Destructor Documentation

ImportDataInfo() [1/4]

ImportDataInfo::ImportDataInfo	(	std::unique_ptr< Datafield >	data,
		Coords	units
	)

Definition at line 47 of file ImportDataInfo.cpp.

    : m_data(units == Coords::NBINS && data ? GUI::Util::IO::binifyAxes(*data) : std::move(data))
    , m_coords(units)
{
    checkValidity();
}

References checkValidity().

Here is the call graph for this function:

ImportDataInfo() [2/4]

ImportDataInfo::ImportDataInfo	(	Datafield &&	data,
		Coords	units
	)

Definition at line 61 of file ImportDataInfo.cpp.

    : ImportDataInfo(std::make_unique<Datafield>(std::move(data)), units)
{
}

ImportDataInfo() [3/4]

ImportDataInfo::ImportDataInfo	(	std::unique_ptr< Datafield >	data,
		const QString &	units
	)

Definition at line 54 of file ImportDataInfo.cpp.

    : m_data(std::move(data))
    , m_coords(GUI::Util::CoordName::coordFromName(units_label))
{
    checkValidity();
}

References checkValidity().

Here is the call graph for this function:

ImportDataInfo() [4/4]

ImportDataInfo::ImportDataInfo

(

ImportDataInfo &&

other

)

Definition at line 41 of file ImportDataInfo.cpp.

    : m_data(std::move(other.m_data))
    , m_coords(other.m_coords)
{
}

References other.

~ImportDataInfo()

ImportDataInfo::~ImportDataInfo ( )

default

Member Function Documentation

axisLabel()

QString ImportDataInfo::axisLabel

(

size_t

axis_index

)

const

Definition at line 97 of file ImportDataInfo.cpp.

{
    if (!m_data)
        return "";
 
    const size_t rank = m_data->rank();
    if (rank == 2)
        return axis_index == 0 ? "X [nbins]" : "Y [nbins]";
    if (rank == 1) {
        if (axis_index > 0)
            return "Signal [a.u.]";
        return QString::fromStdString(DataUtils::AxisNames::specAxis.at(m_coords));
    }
    throw Error("Error in ImportDataInfo::axisLabel: unsupported data type");
}

References Error, m_coords, and m_data.

Referenced by IntensityDataItem::reset(), and SpecularDataItem::reset().

checkValidity()

void ImportDataInfo::checkValidity ( )

private

Definition at line 113 of file ImportDataInfo.cpp.

{
    if (!m_data)
        return;
    auto iter = available_units.find(m_data->rank());
    if (iter == available_units.end())
        throw Error("Error in ImportDataInfo constructor: unsupported data type");
    for (auto& value : iter->second)
        if (m_coords == value)
            return;
 
    throw Error("Error in ImportDataInfo constructor: inacceptable units passed.");
}

References Error, m_coords, and m_data.

Referenced by ImportDataInfo().

clonedData()

std::unique_ptr< Datafield > ImportDataInfo::clonedData

(

)

const &

Definition at line 73 of file ImportDataInfo.cpp.

{
    if (!m_data)
        return nullptr;
    return std::unique_ptr<Datafield>(m_data->clone());
}

References m_data.

Referenced by RealDataItem::setImportData().

dataRank()

size_t ImportDataInfo::dataRank

(

)

const

Returns number of dimensions.

Definition at line 85 of file ImportDataInfo.cpp.

{
    if (!m_data)
        return 0;
    return m_data->rank();
}

References m_data.

Referenced by RealDataItem::setImportData().

intensityData()

std::unique_ptr< Datafield > ImportDataInfo::intensityData

(

)

&&

Definition at line 80 of file ImportDataInfo.cpp.

{
    return std::move(m_data);
}

operator bool()

ImportDataInfo::operator bool

(

)

const

True if the contained data is not nullptr (no info about empty data)

Definition at line 68 of file ImportDataInfo.cpp.

{
    return static_cast<bool>(m_data);
}

unitsLabel()

QString ImportDataInfo::unitsLabel

(

)

const

Definition at line 92 of file ImportDataInfo.cpp.

{
    return GUI::Util::CoordName::nameFromCoord(m_coords);
}

References m_coords, and GUI::Util::CoordName::nameFromCoord().

Referenced by IntensityDataItem::reset(), SpecularDataItem::reset(), and RealDataItem::setImportData().

Here is the call graph for this function:

Member Data Documentation

m_coords

const Coords ImportDataInfo::m_coords

private

Definition at line 51 of file ImportDataInfo.h.

Referenced by axisLabel(), checkValidity(), and unitsLabel().

m_data

std::unique_ptr<Datafield> ImportDataInfo::m_data

private

Definition at line 50 of file ImportDataInfo.h.

Referenced by axisLabel(), checkValidity(), clonedData(), and dataRank().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Support/IO/ImportDataInfo.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Support/IO/ImportDataInfo.cpp