ImportDataInfo Class Reference

Carries information about loaded data. More...

Public Member Functions
	ImportDataInfo ()
	ImportDataInfo (ImportDataInfo &&other)
	ImportDataInfo (OutputData< double > &&data, Axes::Units units)
	ImportDataInfo (std::unique_ptr< OutputData< double >> data, Axes::Units units)
	ImportDataInfo (std::unique_ptr< OutputData< double >> data, const QString &units)
	~ImportDataInfo ()
QString	axisLabel (size_t axis_index) const
size_t	dataRank () const
	Returns number of dimensions. More...
std::unique_ptr< OutputData< double > >	intensityData () &&
std::unique_ptr< OutputData< double > >	intensityData () const &
	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
std::unique_ptr< OutputData< double > >	m_data
Axes::Units	m_units

Detailed Description

Carries information about loaded data.

Definition at line 26 of file ImportDataInfo.h.

Constructor & Destructor Documentation

ImportDataInfo() [1/5]

ImportDataInfo::ImportDataInfo ( )

default

ImportDataInfo() [2/5]

ImportDataInfo::ImportDataInfo

(

ImportDataInfo &&

other

)

Definition at line 38 of file ImportDataInfo.cpp.

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

ImportDataInfo() [3/5]

ImportDataInfo::ImportDataInfo	(	std::unique_ptr< OutputData< double >>	data,
		Axes::Units	units
	)

Definition at line 43 of file ImportDataInfo.cpp.

    : m_data(units == Axes::Units::NBINS && data
                 ? ImportDataUtils::CreateSimplifiedOutputData(*data)
                 : std::move(data))
    , m_units(units)
{
    checkValidity();
}

References checkValidity().

Here is the call graph for this function:

ImportDataInfo() [4/5]

ImportDataInfo::ImportDataInfo	(	OutputData< double > &&	data,
		Axes::Units	units
	)

Definition at line 58 of file ImportDataInfo.cpp.

    : ImportDataInfo(std::unique_ptr<OutputData<double>>(new OutputData<double>(std::move(data))),
                     units)
{
}

ImportDataInfo() [5/5]

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

Definition at line 52 of file ImportDataInfo.cpp.

    : m_data(std::move(data)), m_units(JobItemUtils::axesUnitsFromName(units_label))
{
    checkValidity();
}

References checkValidity().

Here is the call graph for this function:

~ImportDataInfo()

ImportDataInfo::~ImportDataInfo ( )

default

Member Function Documentation

axisLabel()

QString ImportDataInfo::axisLabel

(

size_t

axis_index

)

const

Definition at line 95 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]";
    else if (rank == 1) {
        if (axis_index > 0)
            return "Signal [a.u.]";
 
        auto label_map = AxisNames::InitSpecAxis();
        return QString::fromStdString(label_map[m_units]);
    }
    throw GUIHelpers::Error("Error in ImportDataInfo::axisLabel: unsupported data type");
}

References AxisNames::InitSpecAxis(), m_data, and m_units.

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

Here is the call graph for this function:

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 GUIHelpers::Error("Error in ImportDataInfo constructor: unsupported data type");
    for (auto& value : iter->second)
        if (m_units == value)
            return;
 
    throw GUIHelpers::Error("Error in ImportDataInfo constructor: inacceptable units passed.");
}

References m_data, and m_units.

Referenced by ImportDataInfo().

dataRank()

size_t ImportDataInfo::dataRank

(

)

const

Returns number of dimensions.

Definition at line 83 of file ImportDataInfo.cpp.

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

References m_data.

Referenced by RealDataItem::setImportData().

intensityData() [1/2]

std::unique_ptr< OutputData< double > > ImportDataInfo::intensityData

(

)

&&

Definition at line 78 of file ImportDataInfo.cpp.

{
    return std::move(m_data);
}

intensityData() [2/2]

std::unique_ptr< OutputData< double > > ImportDataInfo::intensityData

(

)

const &

Definition at line 71 of file ImportDataInfo.cpp.

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

References m_data.

Referenced by RealDataItem::setImportData().

operator bool()

ImportDataInfo::operator bool

(

)

const

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

Definition at line 66 of file ImportDataInfo.cpp.

{
    return static_cast<bool>(m_data);
}

unitsLabel()

QString ImportDataInfo::unitsLabel

(

)

const

Definition at line 90 of file ImportDataInfo.cpp.

{
    return JobItemUtils::nameFromAxesUnits(m_units);
}

References m_units, and JobItemUtils::nameFromAxesUnits().

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

Here is the call graph for this function:

Member Data Documentation

m_data

std::unique_ptr<OutputData<double> > ImportDataInfo::m_data

private

Definition at line 51 of file ImportDataInfo.h.

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

m_units

Axes::Units ImportDataInfo::m_units

private

Definition at line 52 of file ImportDataInfo.h.

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

---

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

• /home/www/ba/GUI/coregui/utils/ImportDataInfo.h
• /home/www/ba/GUI/coregui/utils/ImportDataInfo.cpp